applicationchaptercitetitlecommandcomputeroutputemphasisexamplefilenamefirsttermfootnotefigurekeycapoptionparapartpromptreplaceablescreentabletrademarkuserinputulinkwordaswordxrefPlease read this chapter carefully. This chapter describes the tags used by the Docs Project. Some of the rules described are specific to the project.
If these tags are used appropriately, document searches will provide meaningful results. These tags help search engines identify the information relevant to the search request. Another benefit is that all Fedora Project documents will have a similar look and feel (however, they will have some differences depending upon the output format).
All tags in XML must have an opening and closing tag Additionally, proper XML conventions say that there must be a unique identifier for sections, chapters, figures, tables, and so on, so that they may be correctly identified, and cross referenced if needed.
Although XML is capable of handling many document types, the format discussed here is the article format.
This chapter only discusses tags used for documentation for the Fedora Project, not all available DocBook XML tags. For the complete list, refer to:
http://www.docbook.org/tdg/en/html/docbook.html
It is very important that you remember the caveats in this section. Even though they are more strict than valid DocBook XML, these rules exist so that both the HTML and PDF outputs look proper.
Do not use the trademark entities ™, ©, or ® because the do not produce HTML output that works for all charsets. The HTML output produces by these entities are declared in the DTD and cannot be changed via the stylesheet.
Instead, use the trademark tag and its
associates classes as follows:
<trademark>trademark symbol after me</trademark>
<trademark class="registered">registered trademark symbol after me</trademark>
<trademark class="copyright">copyright symbol after me</trademark>
para tagsDo not use para tags around anything other
than a simple paragraph. Doing so will create additional white space
within the text itself in the PDF version.
Specifically, do not use para tags around
the following (or, to put this another way, do not embed the
following within para tags):
<screen>
<itemizedlist>
<orderedlist>
<variablelist>
<table>
para tags within
listitem tagsContent inside para tags within
listitem tags must start
immediately after the beginning <para> tag to avoid extra
white space in the PDF version.
screen tagsThe screen tags (<screen> and
</screen>) must be flush left in the
XML file, and all the content inside the
screen tags must be flush left as well unless
the white space in intentional; otherwise, the extraneous
whitespace will appear in the HTML version.