~charles.davis/ubuntu-docs/documentor-training

« back to all changes in this revision

Viewing changes to ex1.xml

  • Committer: Charles Davis
  • Date: 2008-09-08 04:33:46 UTC
  • Revision ID: oldsoldier@gmail.com-20080908043346-jk0ku1lvp8nlgchd
updated ex1 defonitions list

Show diffs side-by-side

added added

removed removed

Lines of Context:
52
52
                <varlistentry>
53
53
                        <term>Entity</term>
54
54
                        <listitem>
55
 
                          <para>An entity is a "shortcut" for a constant. Entities are usually defined and stored in a list file. If you use an entity definition file it must be included using an inclusion statement in the header of the doucment. Character entities are defined as part of the docbook standard and do not need to be listed in the entity file(s). An example of a character entity is the "less than" symbol. Typing the symbol directly will break the DocBook code, since the symbol denotes the beginning of a tag. Using <keycap>&amp;lt;</keycap> prevents this issue. </para>
 
55
                          <para>An entity is a "shortcut" for a constant. Entities are usually defined and stored in a "list" or "definitions" file. If you use an entity definition file it must be included using an inclusion statement in the header of the doucment. Character entities are defined as part of the docbook standard and do not need to be listed in the entity file(s). An example of a character entity is the "less than" symbol. Typing the symbol directly will break the DocBook code, since the symbol denotes the beginning of a tag. Using <keycap>&amp;lt;</keycap> prevents this issue. </para>
 
56
                        </listitem>
 
57
                </varlistentry>
 
58
                <varlistentry>
 
59
                        <term>Section</term>
 
60
                        <listitem>
 
61
                          <para> Sections are used for organizational purposes and are used by yelp to automatically generate a table of contents within a book, chapter, or article.</para>
 
62
                        </listitem>
 
63
                </varlistentry>
 
64
                <varlistentry>
 
65
                        <term>Nested tags</term>
 
66
                        <listitem>
 
67
                          <para> Tags residing inside of other tags are nested. Technically all of the tags inside of a document are nested between the opening and closing tag, but in common usage the term applies to tags nested within other tags within a paragrah or section element.</para>
56
68
                        </listitem>
57
69
                </varlistentry>
58
70
        </variablelist>