User:Bcotton/DocBook notes

Just some notes for myself as I learn DocBook. If you find them helpful, yay. If you find them unhelpful, please fix!

The conventions file has examples for a lot of stuff: /usr/share/publican/Common_Content/common/en-US/Conventions.xml


 * Commands
 * Use around replaceable parts (e.g. file names)
 * screen output
 * Does not need to be (can't be??) inside a element
 * Files (and directories?)
 * Notes
 * Important
 * Warning
 * Notes
 * Important
 * Warning
 * Warning
 * Warning

Entities
Per Rudi, the only entities that are safe to use in Fedora documentation -- ever -- are as follows:


 * &PRODUCT; -- the Bugzilla product, used in the brand Feedback.xml, which must be set to "Fedora Documentation"
 * &BOOKID; -- the Bugzilla component, used in the brand Feedback.xml, which takes the form "foo-guide"
 * &YEAR; -- the current year, used in the legal notice, eg "2010"
 * &HOLDER; -- the copyright holder, used in the legal notice, which must be set to "Red Hat, Inc. and others"
 * &PRODVER; -- the version of Fedora to which this documentation applies, for example "14"
 * &PREVVER; -- the version of Fedora previous to the one to which this documentation applies, for example "13"