TAU documentation for user interaction and API documentation.
Here are the basic guidelines for using docbook:
See the bottom of this README for instructions on installing the documentation.
use make html-chunked to create linked web-pages. use make pdf to create a pdf.
sometimes you need to first 'make clean' before creating documents to make sure that the most recent changes are incorporated.
The following characters have special meaning to docbook: '<','>','&'. To print '<', type '<' , for '>' type '>' and for '&' type '&'.
If you wish to search and replace these characters in an entire document first search and replace '&' for '&' so the the '&' in '<' or '> is not changed.
Important tags and that should be used throughout the Document:
checkout http://www.docbook.org/tdg/en/html/docbook.html for a more complete list of available tags.
Denotes the beginning and end of chapters.
Denotes the major section within a chapter.
Denotes the beginning and end of every subsection within the document. Use this tag often, as it will help the user find information quickly.
<title> Every chapter, section and subsection should have one title immediately following the , or tag.Begins a list.
Begins a ordered list.
Denotes an element of either a itemizedlist or a orderedlist.
Should be used regardless of the size of paragraph, in some cases for a single word.
Denotes a list arguments for a function.
Used to have the text inclosed in this tag be printed without any formating. Use for variable names, method names or numbers.
Used to print text as it would be displayed on a computer. Use for code examples, or computer output. Any line inside a tag must not exceed 65 charaters in length (including whitespace). If you need to do text wrapping please follow these guidelines:
- Shell commands that wrap should wrap in a way that preserve the
ability to cut and paste, let the last character on the line be a slash,
with the following line indented. For example:
% mpirun -np 4
Some very long winded
command
- Program output should be formatted by hand to be visibly appealing and to not confuse the reader. For example, if we're showing output from a help command:
- Makefiles should be modified to be syntactically correct, which means slashes for line continuations, except on comments, where the next line should begin with a pound. For example:
Here's a cheat sheet for the TAUdocs
export CVSROOT=ix.cs.uoregon.edu:/research/paraducks2/cvs-src/master cvs co taudocs
To Make PDFs: cd referenceguide make pdf cp referenceguide.pdf cd userguide make pdf cp userguide.pdf
To make html (for all of the guides) cd newguide make html newguide-chunked cp newguide-chunked/
The pdfs are here (on ix): cd /cs/www/hosts/www/Research/tau
The html here (on ix): /cs/www/hosts/www/Research/tau/docs/newguide