]> Shamusworld >> Repos - ardour-manual/blobdiff - README.md
Initial cleanup of manual content.
[ardour-manual] / README.md
index 6430ef8637433252c8eebc8218e1f50e96961840..6140834cb941af4372aff475632da7f6f499d11f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,4 @@
+
 # The Ardour Manual
 
 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.
@@ -44,6 +45,7 @@ Here are the keywords you can put in, and a brief description of what they do:
 | 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/` |
 | 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 |
 | style   | Sets an alternate CSS stylesheet; the name should match the one referred to (sans the `.css` suffix) in the `source/css` directory |
+| uri     | Sets an absolute URI where this page will go in the hierachy of the created website. It does *not* change the document structure |
 
 ### Normal content
 
@@ -95,6 +97,5 @@ internet access. You will need `git`, and `python` installed.
 
 ### Helper scripts: `implode` and `explode`
 
-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.
-
+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.