Shamusworld >> Repos - ardour-manual/blob - README.md

   1
   2 # The Ardour Manual
   3
   4 This is the project that generates the static ardour manual website available at
   5 [manual.ardour.org](http://manual.ardour.org). The site is built using python 3.
   6
   7 ### Get the code
   8
   9     git clone <repo-url> ardour-manual
  10     cd ardour-manual
  11
  12 ## Structure of the content
  13
  14 There are 2 different types of content:
  15
  16 - a master document which describes the overall structure of the manual
  17 - normal content, which is described in the master document
  18
  19 ### The Master Document
  20
  21 This is a text file (master-doc.txt) which describes the structure of the
  22 manual. It does this through headers which tell the build script where the
  23 content lives, what its relationship to the overall structure is, as well as a
  24 few other things.
  25
  26 All headers have a similar structure, and have to have at least the following
  27 minimal structure:
  28
  29     ---
  30     title: Some Wordy and Expressive Title
  31     part: part
  32     ---
  33
  34 Keywords that go into the header are of the form:
  35
  36           keyword: value
  37
  38 Here are the keywords you can put in, and a brief description of what they do:
  39
  40
  41 | Keyword | Meaning  |
  42 | ------- | -------- |
  43 | title   | Sets the title for the content that follows |
  44 | menu_title | Sets the title for the content that follows which will appear in the menu link sidebar. If this is not specified, it defaults to the value of the `title` keyword |
  45 | part    | Sets the hierarchy for the content that follows. It must be one of the following (listed in order of lowering hierarchy): part, chapter, subchapter, section, subsection  |
  46 | link    | Sets the unbreakable link to the content that follows. Links in the *content* should be prefixed with a double at-sign (@@) to tell the build system that the link is an internal one |
  47 | include | Tells the build system that the content lives in an external file; these normally live in the `include/` directory. Note that the filename should **not** be prefixed with `include/` |
  48 | exclude | Tells the `implode` and `explode` scripts that file referred to by the `include` keyword should be ignored. Note that the value of this keyword is ignored |
  49 | pdf-exclude | Does not include the content in the generated PDF, but links to its online contents. The value is also ignored. |
  50 | style   | Sets an alternate CSS stylesheet; the name should match the one referred to (sans the `.css` suffix) in the `source/css` directory |
  51 | uri     | Sets an absolute URI where this page will go in the hierachy of the created website. It does *not* change the document structure |
  52
  53 ### Normal content
  54
  55 Manual content goes into the `include/` directory (or in the Master Document
  56 itself); and consists of normal HTML, sans the usual headers that is normally
  57 seen in regular HTML web pages. Any other content, such as css files, images,
  58 files and fixed pages goes into the `source/` directory.
  59
  60 Adding `source/images/horse.png` makes it available at the url
  61 `/images/horse.png` after publishing it; things work similarly for
  62 `source/files/` and `source/css/`.
  63
  64 ### CSS
  65
  66 The manual uses [Bootstrap](http://getbootstrap.com/) for its global layout, and
  67 a few custom CSS files that contains classes used for keys, menus,
  68 tables, etc... so it is recommanded to have a look at it first, or at least see
  69 how other pages are made to keep the manual consistent in its appearance:
  70
  71 - `source/css/common.css` contains shared classes between all media and is included everywhere
  72 - `source/css/screen.css` adds classes used for screen display (html)
  73 - `source/css/pdf.css` adds classes used for print (pdf)
  74 - `source/css/luadocs.css` adds classes used in the Lua script documentation
  75
  76 ## More Advanced Stuff
  77
  78 You probably don't want or need to do any of this, but here are some
  79 notes just in case you decide to anyway.
  80
  81 ### Run it locally
  82
  83 You may want the manual available on a machine that doesn't have constant
  84 internet access. You will need `git`, `python3` and `cherrypy` python module installed.
  85
  86 1. Download code and build manual
  87
  88   ```
  89   git clone <repo-url> ardour-manual
  90   cd ardour-manual
  91   ./build.py
  92   ```
  93
  94 2. Run the following:
  95   ```
  96   ./servit.py
  97   ```
  98
  99 3. The manual will now be available at http://127.0.0.1:8080
 100
 101   (Ctrl-c to quit the server).
 102
 103 ### Helper scripts: `implode` and `explode`
 104
 105 The `implode` and `explode` scripts exist in order to accomodate different
 106 working styles. `implode` takes all the files referenced by the `include`
 107 keywords in the headers in the Master Document and automagically puts them into
 108 the Master Document in their proper places. Note that any header that has an
 109 `exclude` keyword will remain in the `include/` directory. `explode` does the
 110 inverse of `implode`; it takes all the content in the Master Document and blows
 111 it into individual files in the `include/` directory.
 112
 113 ### Build options
 114
 115 The `build.py` script that builds the manual accepts the following options:
 116 - '-v', or '--verbose', to display the high-level structure of the manual
 117 - '-q', or '--quiet', to suppress all output (overrides -v)
 118 - '-d', or '--devmode', to add content to pages to help developers debug them
 119 (link, file name, URL)
 120 - '-n', or '--nopdf', to prevent the build script from generate a PDF from the content