Site Navigation:
 
 
3.3. XML Tags
Prev  Chapter 3. Fedora Documentation Guidelines  Next

3.3. XML Tags

It is very important that you remember the caveats in this section. These are learned suggestions or rules that make your XML experience better.

Do Not Use Trademark Entities

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:

DocBook XML source Rendered content
<trademark>trademark symbol after me</trademark> trademark symbol after me™
<trademark class="registered">registered trademark symbol after me</trademark> registered trademark symbol after me®
<trademark class="copyright">copyright symbol after me</trademark> copyright symbol after me©
Content inside para tags

In general, 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 elements):

  • screen

  • itemizedlist

  • orderedlist

  • variablelist

  • table

Content inside para elements within listitem tags

Content inside para elements within listitem elements must start immediately after the beginning <para> tag to avoid extra white space in the PDF version.

Content inside screen tags

The content inside screen tags (<screen> and </screen>) must be flush left in the XML file; otherwise, the extraneous whitespace will appear in the HTML version.

Prev  Up  Next
3.2. ID Naming Conventions  Home  3.4. Admonitions