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

   1
   2 # The Ardour Manual
   3
   4 This is the project that generates the static ardour manual website available at [manual.ardour.org](http://manual.ardour.org). The site is built using python 3.
   5
   6 ### Get the code
   7
   8     git clone <repo-url> ardour-manual
   9     cd ardour-manual
  10
  11 ## Structure of the content
  12
  13 There are 2 different types of content:
  14
  15 - a master document which describes the overall structure of the manual
  16 - normal content, which is described in the master document
  17
  18 ### The Master Document
  19
  20 This is a text file (master-doc.txt) which describes the structure of the manual. It does this
  21 through headers which tell the build script where the content lives, what its
  22 relationship to the overall structure is, as well as a few other things.
  23
  24 All headers have a similar structure, and have to have at least the following
  25 minimal structure:
  26
  27     ---
  28     title: Some Wordy and Expressive Title
  29     part: part
  30     ---
  31
  32 Keywords that go into the header are of the form:
  33
  34         keyword: value
  35
  36 Here are the keywords you can put in, and a brief description of what they do:
  37
  38
  39 | Keyword | Meaning  |
  40 | ------- | -------- |
  41 | title   | Sets the title for the content that follows |
  42 | 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 |
  43 | 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.  |
  44 | 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 |
  45 | 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/` |
  46 | 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 |
  47 | style   | Sets an alternate CSS stylesheet; the name should match the one referred to (sans the `.css` suffix) in the `source/css` directory |
  48 | uri     | Sets an absolute URI where this page will go in the hierachy of the created website. It does *not* change the document structure |
  49
  50 ### Normal content
  51
  52 Manual content goes into the `include/` directory (or in the Master Document itself); and consists of normal HTML, sans the usual headers that is normally seen in regular HTML web pages. Any other content, such as css files, images, files and fixed pages goes into the `source/` directory.
  53
  54 Adding `source/images/horse.png` makes it available at the url `/images/horse.png` after publishing it; things work similarly for `source/files/` and `source/css/`.
  55
  56 ## More Advanced Stuff
  57
  58 You probably don't want or need to do any of this, but here are some
  59 notes just in case you decide to anyway.
  60
  61 ### Run it locally
  62
  63 You may want the manual available on a machine that doesn't have constant
  64 internet access. You will need `git`, and `python` installed.
  65
  66 1. Download code and build manual
  67
  68   ```
  69   git clone <repo-url> ardour-manual
  70   cd ardour-manual
  71   ./build.py
  72   ```
  73
  74 2. open `ardour-manual/website/index.html` in your favorite web browser
  75
  76   If this page doesn't open and function correctly, follow these optional steps to serve up the page with nginx.
  77   N.B.: Step 2 will *never* work; you *must* install nginx if you want to see it!
  78
  79 3. Install [nginx](http://wiki.nginx.org/Install)
  80 4. Configure nginx server block in `/etc/nginx/sites-available/default`
  81
  82   ```
  83   server {
  84       listen 80;
  85       server_name localhost;
  86
  87       root ...path_to_.../ardour-manual/website;
  88       index index.html;
  89   }
  90   ```
  91
  92 5. Restart nginx server
  93
  94         service nginx restart
  95
  96 6. The manual will now be available at http://localhost
  97
  98 ### Helper scripts: `implode` and `explode`
  99
 100 The `implode` and `explode` scripts exist in order to accomodate different working styles. `implode` takes all the files referenced by the `include` keywords in the headers in the Master Document and automagically puts them into the Master Document in their proper places. Note that any header that has an `exclude` keyword will remain in the `include/` directory. `explode` does the inverse of `implode`; it takes all the content in the Master Document and blows it into individual files in the `include/` directory. Filenames are automagically derived from the value of the `title` keyword.
 101
 102