← Back to branch summary

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

« back to all changes in this revision

Viewing changes to ex3.xml

  • Committer: Charles Davis
  • Date: 2008-09-13 17:51:47 UTC
  • Revision ID: oldsoldier@gmail.com-20080913175147-ec4pjjmji49j51gi
inprogess commit for ex3

Show diffs side-by-side

added added

removed removed

Lines of Context:
ex3.xml
67
67
<sect1 id="ent-definitions">
68
68
  <title>What entities are defined?</title>
69
69
<para>Before you can begin using entities you have to know what entities are available for use in your documents. Most of the character entities available in HTML are available in DocBook. <ulink url="http://www.sagehill.net/docbookxsl/SpecialChars.html">DocBook XSL: The Complete Guide</ulink> is a good place to look for a character entity if you are unsure of its availability.</para>
70
 
<para>The standard entities available for use in the Ubuntu Documentation Project have been defined in the definition list that is part of the ubuntu-doc Bazaar branch. They are listed in <filename>ubuntu-doc/libs/global.ent</filename> . This structure has been maintained for this tutorial. You can find a trimmed down version of the ubuntu-doc entity definitions list here: <filename>documentor-training/libs/global.ent</filename> . The entity list for Gnome menu items is named <filename>gnome-menus-C.ent</filename> and is stored in the same directory as the global entities file.</para> 
 
70
<para>The standard entities available for use in the Ubuntu Documentation Project have been defined in the definition list that is part of the ubuntu-doc Bazaar branch. They are listed in <filename>ubuntu-doc/libs/global.ent</filename> . This structure has been maintained for this tutorial. For this exercise a copy of ubuntu-doc entity definitions list is located here: <filename>documentor-training/libs/global.ent</filename> . The entity list for Gnome menu items is named <filename>gnome-menus-C.ent</filename> and is stored in the same directory as the global entities file.</para> 
 
71
</sect1>
 
72
<sect1 id="ent-using">
 
73
  <title>Using entities in a document</title>
 
74
<para>For this portion of the exercise you will add entities in the file <filename>documentor-training/Ex3/addentities.xml</filename>, open the file in your text editor and continue.</para>
 
75
<sect2 id="ent-using-char">
 
76
  <title>Using character entities</title>
 
77
        <procedure>     
 
78
                <step>
 
79
                        <para>Find the sect 1 entry with the id <emphasis>ex3-char</emphasis></para>
 
80
                </step>
 
81
                <step>
 
82
                        <para>Insert the proper entity beside the description</para>
 
83
                </step>
 
84
                <step>
 
85
                        <para>Save the changes and validate your work. Correct any errors before continuing to the next section.</para>
 
86
                </step>
 
87
        </procedure>
 
88
</sect2>
 
89
<sect2 id="ent-using-url">
 
90
  <title>Using URL entities</title>
 
91
        <procedure>
 
92
                <step>
 
93
                        <para>Open the file <filename>documentor-training/libs/global.ent</filename></para>
 
94
                </step>
 
95
                <step>
 
96
                        <para>Use <filename>global.ent</filename> as a reference while completing this portion of the exercise, do not make changes to <filename>global.ent</filename></para>
 
97
                </step>
 
98
                <step>
 
99
                        <para>Find the sect 1 entry with the id <emphasis>ex3-url</emphasis></para>
 
100
                </step>
 
101
                <step>
 
102
                        <para>Insert the URL entities beside the description</para>
 
103
                </step>
 
104
                <step>
 
105
                        <para>Save the changes and validate your work. Correct any errors before continuing to the next section.</para>
 
106
                </step>         
 
107
        </procedure>
 
108
</sect2>
 
109
<sect2 id="ent-using-gnome">
 
110
  <title>Using Gnome menu entities</title>
 
111
        <procedure>
 
112
                <step>
 
113
                        <para>Open the file <filename>documentor-training/libs/gnome-menus-C.ent</filename></para>
 
114
                </step>
 
115
                <step>
 
116
                        <para>Use <filename>gnome-menus-C.ent</filename> as a reference while completing this portion of the exercise, do not make changes to <filename>gnome-menus-C.ent</filename></para>
 
117
                </step>
 
118
                <step>
 
119
                        <para>Find the sect 1 entry with the id <emphasis>ex3-gnome</emphasis></para>
 
120
                </step>
 
121
                <step>
 
122
                        <para>Insert the Gnome menu entities beside the description</para>
 
123
                </step>
 
124
                <step>
 
125
                        <para>Save the changes and validate your work. Correct any errors before continuing to the next section.</para>
 
126
                </step>         
 
127
        </procedure>
 
128
</sect2>
 
129
</sect1>
 
130
<sect1 id="ent-adding">
 
131
  <title>Adding entities to the definition files</title>
 
132
<para>The definition files for ubuntu-doc are pretty good. However, over time things change. Applixtions are added, menus change, and Urls shift. If this happens you may find it necessary to make a change in either <filename>gnome-menus-C.ent</filename> or <filename>global.ent</filename>.</para>
 
133
<para>If it becomes necessary to change <filename>gnome-menus-C.ent</filename> or <filename>global.ent</filename> please check with your mentor before making the changes.</para>
71
134
</sect1>
72
135
 
73
136