-
Notifications
You must be signed in to change notification settings - Fork 39
/
lc_topictype.dita
42 lines (42 loc) · 2.08 KB
/
lc_topictype.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
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE learningContent PUBLIC "-//OASIS//DTD DITA Learning Content//EN" "learningContent.dtd">
<learningContent id="content_vwq_jlh_rs">
<title>The generic topic type</title>
<shortdesc></shortdesc>
<prolog>
<author href="http://www.scriptorium.com" scope="external" format="html">Simon Bate,
Scriptorium</author>
<critdates>
<created date="2015-07-13"/>
</critdates>
</prolog>
<learningContentbody>
<lcInstruction>
<p>All DITA topic types are based on a single generic topic type. The generic topic type
is used as the basis to create the specific topic types. Many of the elements and
organizations in the generic topic are also used by the specific topic types. </p>
<p>All DITA topics have this general structure: </p>
<pre><topic id="sample">
<shortdesc>A short description</shortdesc>
<title>Topic title goes here</title>
<body>
<i>(Most of the elements go here.)</i>
</body>
</topic> </pre>
<p>
<ul id="ul_wwr_1nh_rs">
<li>The <shortdesc> (short description) element provides a 2-3 sentence
summary of the topic content.</li>
<li>The <title> is the only required element in a topic.</li>
<li>The <body> contains the bulk of the information in the topic. In the
specific topic types the body element has a related name, such as
<conbody> for concepts and <taskbody> for tasks.</li>
</ul>
</p>
<note>Although you can use the generic topic type for authoring content, it’s much better
to use one of the specific topic types, such as concept, task, and reference. </note>
<p>There are other elements in the generic topic type, but these are the common
ones.</p>
</lcInstruction>
</learningContentbody>
</learningContent>