Here are some notes about DocBook and general conventions: (Go to http://docbook.org/ for the full Docbook manual) -> All chapter and section elements should have 'id' attributes that are the same as their ENTITY definitions in manual.xml (this makes it much easier to remember them) For in-line commands that the user might run, use . For command names use . For longer or important commands that you want in a new special paragraph, or for a long interactive session, use and , or . For command-line prompts use . For filenames, use . For other code-like things, use or . For variables (environment variables, C++ variables, options in config files, use or . Use around new terminolgy Use around acronyms (this will help us add a glossary of acronyms at some point in the future if we want). Use
for block quotes. Use for big flashy warnings, and for set off, but less urgent notices. Use these tags for GUI components: (but not all stylesheets render them specially) Field name ... ... ... ... ... Ctrl+X Edit Cut For command-line parametors, use