I made a few tweaks to the documentation generator.

* A navigation bar is now available. This is auto generated if there id a file 
named "order.txt" in the directory that contains the pages. This file is simply 
a white space separated list of the stems for the pages, in the order in which 
they should be connected. If the actual content is nested in a directory (e.g., 
monitoring-traffics/index.en.mdtext) then the stem should be the directory 
name. The logic tries to be clever about figuring this out, and will check an 
order.txt in the nested directory and the containing directory and use the one 
where it finds the stem. You can see examples of all cases in the 
docs/trunk/admin directory.

The navigation bar can be overridden per file as well. You can set a header 
variable "Navigation" which should be a white space separated list of links in 
Markdown format. These then become the elements of the Navigation bar (anything 
in order.txt is ignored for such a file). See docs/trunk/admin/index.en.mdtext 
for an example.

* External variables are now available. When page is processed, the view logic 
will look for a file named "vars.txt" in each directory from the base directory 
for the document (trunk - it looks for the 'STATUS' file as a marker of 
topness) down to the directory containing the page. Each file is read and the 
variables added. These are done from trunk to local so that "closer" files 
override more distant ones. This means common information can be shared in such 
files rather than being duplicated in multiple content files. E.g., 
"Administrator's Guide" now comes from a vars.txt rather than all of the admin 
source files. Any variable defined in the source file overrides the external 
value (if any) for that variable.

* We're using a style sheet now. You can find it at content/styles/ts.css in 
the doc source tree.

The internal links aren't quite right yet, so you can look at these

http://trafficserver.staging.apache.org/docs/trunk/admin/configuration-files/files.en.html

http://trafficserver.staging.apache.org/docs/trunk/admin/

Reply via email to