-
Notifications
You must be signed in to change notification settings - Fork 39
/
lc_elements.dita
293 lines (291 loc) · 14.3 KB
/
lc_elements.dita
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
<?xml version="1.0" encoding="utf-8"?>
<!-- This file is part of the DITA Training project hosted on
github.com. See the accompanying LICENSE file for
applicable licenses.-->
<!DOCTYPE learningContent PUBLIC "-//OASIS//DTD DITA Learning Content//EN" "learningContent.dtd">
<learningContent id="content_hrm_xjh_1t">
<title>Adding other elements</title>
<prolog>
<author href="http://www.scriptorium.com" scope="external" format="html">Gretyl Kinsey,
Scriptorium</author>
<critdates>
<created date="2015-08-24"/>
</critdates>
</prolog>
<learningContentbody>
<lcInstruction>
<p>DITA uses many other important elements. Here are three more:</p>
<simpletable frame="all" relcolwidth="1.0* 1.0*" id="simpletable_i13_ml4_2t">
<strow>
<stentry>
<p><fn></p>
</stentry>
<stentry>
<p>The element that inserts a footnote.</p>
</stentry>
</strow>
<strow>
<stentry>
<p><menucascade></p>
</stentry>
<stentry>
<p>The element that indicates the order of a menu path, such as File > Save
As. The <menucascade> element must contain one or more <uicontrol>
elements. Each <uicontrol> element contains the text for a menu
item.</p>
</stentry>
</strow>
<strow>
<stentry>
<p><dl></p>
</stentry>
<stentry>
<p>The element that contains a definition list. A definition list is a list
of terms and their corresponding definitions, presented in a format
similar to a two-column table by default. The definition list contains
one or more entries, tagged with the <dlentry> element, and each
entry contains a term (tagged with the <dt> element) and one or more
definitions (tagged with the <dd> element).</p>
</stentry>
</strow>
</simpletable>
</lcInstruction>
</learningContentbody>
<task id="task_i3g_jkh_1t">
<title/>
<taskbody>
<steps id="steps_f5k_kkh_1t">
<step>
<cmd>Continue using the file lesson3/l_concept_elements_start.dita to add each of these
elements to your example file.</cmd>
</step>
<step>
<cmd>After the last <p> element, add a new <p> element with the <fn>
element inside it as shown in the following example.</cmd>
<stepxmp>
<pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_elements">
<title>Feeding ducklings</title>
<conbody>
...
<ph outputclass="newchanged"><p>Ducklings need higher levels of protein in their diets than adult ducks.<fn>A protein level of 18-20% is recommended for newborn ducklings.</fn></p></ph>
</conbody>
</concept></pre>
</stepxmp>
<info>The <fn> element indicates where the footnote reference number will
appear inside the paragraph. By default, the text inside the <fn> element
is displayed at the bottom of the page (for PDF) or end of the topic (for
HTML) when you generate output from the file.</info>
</step>
<step>
<cmd>After the last <p> element, add a new <p> element with a
<menucascade> element inside it, as shown in the following example:</cmd>
<info>Video: <xref href="https://www.youtube.com/watch?v=xGyf4q_Bipw"
format="html" scope="external">Creating a menucascade in
DITA</xref></info>
<stepxmp>
<pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_elements">
<title>Feeding ducklings</title>
<conbody>
...
<ph outputclass="newchanged"><p>To create a spreadsheet to keep track of when you need to replenish your
ducklings' food and water, go to
<menucascade>
</menucascade>.
</p></ph>
</conbody>
</concept></pre>
</stepxmp>
<info>In the example you added, the <menucascade> element will be used to
show the menu options involved in creating a spreadsheet.</info>
</step>
<step>
<cmd>Inside the <menucascade> element, add a <uicontrol> element and
add content to it as shown in the following example:</cmd>
<stepxmp>
<pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_elements">
<title>Feeding ducklings</title>
<conbody>
...
<menucascade>
<ph outputclass="newchanged"><uicontrol>File</uicontrol></ph>
</menucascade>
...
</conbody>
</concept></pre>
</stepxmp>
<info>In the example you added, the <uicontrol> element contains the name of
the first menu option involved in creating a spreadsheet: “File.”</info>
</step>
<step>
<cmd>After the <uicontrol> element, add two more <uicontrol> elements and
add content to them as shown in the following example.</cmd>
<stepxmp>
<pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_elements">
<title>Feeding ducklings</title>
<conbody>
...
<menucascade>
<uicontrol>File</uicontrol>
<ph outputclass="newchanged"><uicontrol>New</uicontrol>
<uicontrol>Spreadsheet</uicontrol></ph>
</menucascade>
...
</conbody>
</concept></pre>
</stepxmp>
<info>By default, an arrow symbol is inserted between <uicontrol> elements in
the output to indicate the hierarchy of the menu options. </info>
<info>With the <menucascade> and <uicontrol> elements in the example you
added, the user now knows to click on “File,” then “New,” then
“Spreadsheet.”</info>
<info>You can use the <uicontrol> element without the <menucascade>
element. For example, you can tag a word with the <uicontrol> element to
indicate a button the user should click. Because the <uicontrol> element
indicates that the text it surrounds will have special styling, avoid using
the <b> element or other inline styling elements inside the
<uicontrol> element.</info>
</step>
<step>
<cmd>After the <menucascade> element, add a new introductory <p> element
followed by a <dl> element as shown in the following example:</cmd>
<info>Video: <xref href="https://www.youtube.com/watch?v=3R9eN2TSepQ"
format="html" scope="external">Creating a definition list in
DITA</xref></info>
<stepxmp>
<pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_elements">
<title>Feeding ducklings</title>
<conbody>
...
</menucascade>
<ph outputclass="newchanged"><p>Domestic ducks fall into categories based on weight. These weight classes may
help you choose a species based on how much you will need to feed your ducks.</p>
<dl>
</dl></ph>
</conbody>
</concept></pre>
</stepxmp>
<info>The <dl> element sets up the framework for a definition list.</info>
</step>
<step>
<cmd>Inside the <dl> element, add a <dlentry> element as shown in the
following example:</cmd>
<stepxmp>
<pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_elements">
<title>Feeding ducklings</title>
<conbody>
...
<dl>
<ph outputclass="newchanged"> <dlentry>
</dlentry></ph>
...
</conbody>
</concept></pre>
</stepxmp>
<info>Each <dlentry> element contains a term and its definition. The
<dlentry> element can contain one or more <dd> elements.</info>
</step>
<step>
<cmd>Inside the <dlentry> element, add the <dt> and <dd> elements and
add content to them as shown in the following example:</cmd>
<stepxmp>
<pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_elements">
<title>Feeding ducklings</title>
<conbody>
...
<dlentry>
<ph outputclass="newchanged"><dt>Bantam</dt>
<dd>The lightest-weight ducks and best fliers, such as the Mallard duck.</dd></ph>
...
</conbody>
</concept></pre>
</stepxmp>
<info>The <dt> element contains the term, and the <dd> element contains
its definition.</info>
</step>
<step>
<cmd>After the <dlentry> element, add three more <dlentry> elements and
add content to them with <dt> and <dd> elements as shown in the following
example:</cmd>
<stepxmp>
<pre><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="concept_elements">
<title>Feeding ducklings</title>
<conbody>
...
</dlentry>
<ph outputclass="newchanged"><dlentry>
<dt>Light</dt>
<dd>The second lightest-weight ducks and best egg-layers, such as the Khaki
Campbell duck.</dd>
</dlentry>
<dlentry>
<dt>Medium</dt>
<dd>The mid-weight and generally calmest ducks, such as the Swedish duck.</dd>
</dlentry>
<dlentry>
<dt>Heavy</dt>
<dd>The heaviest and generally friendliest ducks, such as the Pekin duck.</dd>
</dlentry></ph>
...
</conbody>
</concept></pre>
</stepxmp>
</step>
<step>
<cmd>Check your file lesson3/l_concept_elements_start.dita against the sample file
lesson3/l_concept_elements.dita.</cmd>
</step>
</steps>
</taskbody>
</task>
<task id="task_as2_vjx_dt">
<title>Exercise</title>
<taskbody>
<steps id="steps_g32_wjx_dt">
<step>
<cmd>Open the file lesson3/l_concept_elements_exercise_start.dita and use it to
convert the following content from <xref
href="http://contentstrategy101.com/" format="html" scope="external"
>Content Strategy 101</xref> into DITA:</cmd>
<info>
<pre outputclass="passthru"><![CDATA[
<hr />
<h3>Increasing product visibility</h3>
<p>Technical content can help organizations increase the visibility of their products in the marketplace. Officially, technical content is intended for <strong>product customers</strong>—people who buy a product and then look at the documentation.</p>
<p>But one opinion poll indicates that about one-third of buyers<sup>1</sup> look at the documentation before buying a product, and the quality of the documentation will affect their purchasing decision.</p>
<p>To reel in new prospects, your content must perform in three different ways: be searchable, findable, and discoverable.</p>
<strong>Searchable</strong>
Information must be available via an internet search.
<strong>Findable</strong>
Information must perform well for relevant keywords.
<strong>Discoverable</strong>
Information must increase the likelihood that people will link to your information.
<p>To read more, go to <strong>Contents</strong> > <strong>Business goals</strong> > <strong>Marketing and product visibility</strong> > <strong>Increasing product visibility</strong>.</p>
<p><sup>1</sup> <em>"Consumer Feelings about Product Documentation,” an opinion poll conducted online by Sharon Burton</em></p>
<hr />
]]></pre>
</info>
</step>
<step>
<cmd>Check your file lesson3/l_concept_elements_start.dita against the sample file
lesson3/l_concept_elements_exercise.dita.</cmd>
</step>
</steps>
</taskbody>
</task>
</learningContent>