Diff for DITA Fact Sheet
Wed, 2006-03-22 10:26 by Don Day | Wed, 2006-03-22 10:29 by Don Day | ||
---|---|---|---|
next diff > | |||
Changes to Body | |||
Line 1 | Line 1 | ||
The following FAQ has been used as a handout at recent conferences.<br /><br />
| The following FAQ has been used as a handout at recent conferences.<br /><br />
| ||
- | <h1 class="topictitle1">DITA Fact Sheet</h1>
| + | <h1>DITA Fact Sheet</h1>
|
- | <div><!--topic body-->
| + | <p><strong>What is DITA?</strong></p>
|
- | <div><a name="d0e5"></a>
| + | The Darwin Information Typing Architecture (DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering readable information as discrete, typed topics.
|
- | <p class="sectiontitle"><a name="d0e5"><strong>What is DITA?</strong></a></p>
| + | <p><strong>What is DITA good for? </strong></p>
|
- | <a name="d0e5">The Darwin Information Typing Architecture (DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering readable information as discrete, typed topics. </a></div>
| + | |
- | <div><a name="d0e9"></a>
| + | |
- | <p class="sectiontitle"><a name="d0e9"><strong>What is DITA good for? </strong></a></p>
| + | |
<ul>
| <ul>
| ||
- | <li><a name="d0e9">Managing readable information </a></li>
| + | <li>Managing readable information</li>
|
- | <li><a name="d0e9">Reusing information in many different combinations and deliverables </a></li>
| + | <li>Reusing information in many different combinations and deliverables</li>
|
- | <li><a name="d0e9">Creating online information systems such as User Assistance (help) or web resource </a></li>
| + | <li>Creating online information systems such as User Assistance (help) or web resource</li>
|
- | <li><a name="d0e9">Creating minimalist books for easier authoring and use </a></li>
| + | <li>Creating minimalist books for easier authoring and use</li>
|
</ul>
| </ul>
| ||
- | </div>
| + | <p><strong>These terms keep coming up in DITA conversations; what do they mean?</strong></p>
|
- | <div><a name="d0e21"></a>
| + | <dl><strong>topic-oriented authoring</strong><dd>Creating a unit of information for a single subject. The topics can then be assembled into help systems or books that require a particular selection and organization of subjects.</dd><dt><strong>information typing</strong></dt><dd>Identifying the type of topic, such as task, concept, reference, example, and so on. The type of the topic may determine its structure, such as a task having steps. In DITA, an XML DTD or Schema guides the writer to author information with the correct structure for the topic type.</dd><dt><strong>specialization</strong></dt><dd>Extensibility with inheritance, which allows the creation of new types that inherit processing rules from existing types. For example, API documentation is a particular kind of reference information and requires more specific rules and descriptive markup than a generic reference type. DITA lets you define a new type and reuse the processing of the base type (providing new processing only for different requirements of the new type). As a result, topics from different domains with different markup and markup rules can be built together into one help file, Web site, or book </dd></dl>
|
- | <p class="sectiontitle"><a name="d0e21"><strong>These terms keep coming up in DITA conversations; what do they mean?</strong></a></p>
| + | <p><strong>What does a DITA topic look like?</strong></p>
|
- | <dl><dt><a name="d0e21"><strong>topic-oriented authoring</strong></a></dt><dd><a name="d0e21">Creating a unit of information for a single subject. The topics can then be assembled into help systems or books that require a particular selection and organization of subjects.</a></dd><dt><a name="d0e21"><strong>information typing</strong></a></dt><dd><a name="d0e21">Identifying the type of topic, such as task, concept, reference, example, and so on. The type of the topic may determine its structure, such as a task having steps. In DITA, an XML DTD or Schema guides the writer to author information with the correct structure for the topic type.</a></dd><dt><a name="d0e21"><strong>specialization</strong></a></dt><dd><a name="d0e21">Extensibility with inheritance, which allows the creation of new types that inherit processing rules from existing types. For example, API documentation is a particular kind of reference information and requires more specific rules and descriptive markup than a generic reference type. DITA lets you define a new type and reuse the processing of the base type (providing new processing only for different requirements of the new type). As a result, topics from different domains with different markup and markup rules can be built together into one help file, Web site, or book </a></dd></dl></div>
| + | <pre><concept id="simpleconcept"><br /> <title>The DITA concept topic</title><br /> <shortdesc>This type of topic provides background or orientation.</shortdesc><br /> <conbody><br /> <p>A concept topic has a title, a short description, and a descriptive body.</p><br /> </conbody><br /></concept></pre>
|
- | <div><a name="d0e40"></a>
| + | <p><strong>Can DITA topics represent anything more complex?</strong></p>
|
- | <p class="sectiontitle"><a name="d0e40"><strong>What does a DITA topic look like?</strong></a></p>
| + | DITA information types can define a structure as simple or complex as the subject of the description. DITA provides a core concept, reference, and task types but supports defining new types through specialization. Also, DITA topics can be nested to create larger, composite information structures. For instance, the DITA Language Reference in the DITA distribution is a book-length set of individual, specialized topics arranged into a single, book-like structure.
|
- | <pre><a name="d0e40"><concept id="simpleconcept"><br /> <title>The DITA concept topic</title><br /> <shortdesc>This type of topic provides background or orientation.</shortdesc><br /> <conbody><br /> <p>A concept topic has a title, a short description, and a descriptive body.</p><br /> </conbody><br /></concept></a></pre>
| + | <p><strong>Where is a simple example of topic specialization?</strong></p>
|
- | </div>
| + | In the DITA distribution, look at the concept.dtd and concept.mod files. The mod file specializes the topic body so that a concept body has introductory content followed by any number of subsections or examples.
|
- | <div><a name="d0e45"></a>
| + | |
- | <p class="sectiontitle"><a name="d0e45"><strong>Can DITA topics represent anything more complex?</strong></a></p>
| + | |
- | <a name="d0e45">DITA information types can define a structure as simple or complex as the subject of the description. DITA provides a core concept, reference, and task types but supports defining new types through specialization. Also, DITA topics can be nested to create larger, composite information structures. For instance, the DITA Language Reference in the DITA distribution is a book-length set of individual, specialized topics arranged into a single, book-like structure. </a></div>
| + | |
- | <div><a name="d0e49"></a>
| + | |
- | <p class="sectiontitle"><a name="d0e49"><strong>Where is a simple example of topic specialization?</strong></a></p>
| + | |
- | <a name="d0e49">In the DITA distribution, look at the concept.dtd and concept.mod files. The mod file specializes the topic body so that a concept body has introductory content followed by any number of subsections or examples. </a></div>
| + | |
- | <div><a name="d0e53"></a>
| + | |
<p class="sectiontitle"><a name="d0e53"><strong>Where is a simple example of domain specialization?</strong></a></p>
| <p class="sectiontitle"><a name="d0e53"><strong>Where is a simple example of domain specialization?</strong></a></p>
| ||
- | <a name="d0e53">In the DITA distribution, look at the ui-domain.mod and ui-domain.ent files. The mod file specializes general phrases to distinguish the names of UI components such as menus, windows, and so on. These UI elements are available in the same contexts as the phrase elements on which they are based and can continue to be processed as phrases where appropriate. To create special behavior for a UI element (perhaps underlining the <shortcut> element, for example), you would simply define a rule for the UI element in an overriding XSLT script. </a></div>
| + | <a name="d0e53">In the DITA distribution, look at the ui-domain.mod and ui-domain.ent files. The mod file specializes general phrases to distinguish the names of UI components such as menus, windows, and so on. These UI elements are available in the same contexts as the phrase elements on which they are based and can continue to be processed as phrases where appropriate. To create special behavior for a UI element (perhaps underlining the <shortcut> element, for example), you would simply define a rule for the UI element in an overriding XSLT script. </a>
|
- | <div><a name="d0e57"></a>
| + | |
<p class="sectiontitle"><a name="d0e57"><strong>How do I select and organize topics for a particular deliverable?</strong></a></p>
| <p class="sectiontitle"><a name="d0e57"><strong>How do I select and organize topics for a particular deliverable?</strong></a></p>
| ||
- | <a name="d0e57">You create a map to organize topics into the hierarchy for a help system or website or into a nested sequence for a book. You can also generate navigation hierarchies from the map and generate links that get added to the topics. </a></div>
| + | <a name="d0e57">You create a map to organize topics into the hierarchy for a help system or website or into a nested sequence for a book. You can also generate navigation hierarchies from the map and generate links that get added to the topics. </a>
|
- | <div><a name="d0e61"></a>
| + | |
<p class="sectiontitle"><a name="d0e61"><strong>What does a DITA map look like?</strong></a></p>
| <p class="sectiontitle"><a name="d0e61"><strong>What does a DITA map look like?</strong></a></p>
| ||
<pre><a name="d0e61"><map title="Getting Started With DITA"> <br /> <topicref href="authoring.xml"> <br /> <topicref href="simpleconcept.xml"/> <br /> <topicref href="simpletask.xml"/> <br /> <topicref href="simplereference.xml"/> <br /> <topicref href="simplemap.xml"/> <br /> </topicref> <br /> <topicref href="specialization.xml"> <br /> <topicref href="topictype.xml"/> <br /> <topicref href="domaintype.xml"/> <br /> <topicref href="processing.xml"/> <br /> </topicref> <br /></map></a></pre>
| <pre><a name="d0e61"><map title="Getting Started With DITA"> <br /> <topicref href="authoring.xml"> <br /> <topicref href="simpleconcept.xml"/> <br /> <topicref href="simpletask.xml"/> <br /> <topicref href="simplereference.xml"/> <br /> <topicref href="simplemap.xml"/> <br /> </topicref> <br /> <topicref href="specialization.xml"> <br /> <topicref href="topictype.xml"/> <br /> <topicref href="domaintype.xml"/> <br /> <topicref href="processing.xml"/> <br /> </topicref> <br /></map></a></pre>
| ||
- | </div>
| ||
- | <div><a name="d0e66"></a>
| ||
<p class="sectiontitle"><a name="d0e66"><strong>What deliverables or publishing channels can DITA support?</strong></a></p>
| <p class="sectiontitle"><a name="d0e66"><strong>What deliverables or publishing channels can DITA support?</strong></a></p>
| ||
- | <a name="d0e66">The trend in information delivery is to deliver content as closely as possible to the point of use, typically as integrated help systems, web sites, or how-to instruction pages. By evolving and extending the DITA transformations, DITA's topic-oriented content can be used to exploit new features or delivery channels as they become available. </a></div>
| + | <a name="d0e66">The trend in information delivery is to deliver content as closely as possible to the point of use, typically as integrated help systems, web sites, or how-to instruction pages. By evolving and extending the DITA transformations, DITA's topic-oriented content can be used to exploit new features or delivery channels as they become available. </a>
|
- | <div><a name="d0e70"></a>
| + | |
<p class="sectiontitle"><a name="d0e70"><strong>How can I get my hands on DITA?</strong></a></p>
| <p class="sectiontitle"><a name="d0e70"><strong>How can I get my hands on DITA?</strong></a></p>
| ||
<ul>
| <ul>
| ||
Line 46 | Line 31 | ||
<li>Open Source Tools: <a href="http://dita-ot.sourceforge.net/">http://dita-ot.sourceforge.net/</a></li>
| <li>Open Source Tools: <a href="http://dita-ot.sourceforge.net/">http://dita-ot.sourceforge.net/</a></li>
| ||
</ul>
| </ul>
| ||
- | </div>
| ||
- | <div><a name="d0e80"></a>
| ||
<p class="sectiontitle"><a name="d0e80"><strong>Where can I discuss DITA?</strong></a></p>
| <p class="sectiontitle"><a name="d0e80"><strong>Where can I discuss DITA?</strong></a></p>
| ||
- | </div>
| ||
- | </div>
| ||
<ul>
| <ul>
| ||
<li>Cover pages bibliography - <a href="http://xml.coverpages.org/dita.html">http://xml.coverpages.org/dita.html</a></li>
| <li>Cover pages bibliography - <a href="http://xml.coverpages.org/dita.html">http://xml.coverpages.org/dita.html</a></li>
|
Revision of Wed, 2006-03-22 10:29:
DITA Fact Sheet
The following FAQ has been used as a handout at recent conferences.
<title>The DITA concept topic</title>
<shortdesc>This type of topic provides background or orientation.</shortdesc>
<conbody>
<p>A concept topic has a title, a short description, and a descriptive body.</p>
</conbody>
</concept>
<topicref href="authoring.xml">
<topicref href="simpleconcept.xml"/>
<topicref href="simpletask.xml"/>
<topicref href="simplereference.xml"/>
<topicref href="simplemap.xml"/>
</topicref>
<topicref href="specialization.xml">
<topicref href="topictype.xml"/>
<topicref href="domaintype.xml"/>
<topicref href="processing.xml"/>
</topicref>
</map>
DITA Fact Sheet
What is DITA?
The Darwin Information Typing Architecture (DITA) is an XML-based, end-to-end architecture for authoring, producing, and delivering readable information as discrete, typed topics.What is DITA good for?
- Managing readable information
- Reusing information in many different combinations and deliverables
- Creating online information systems such as User Assistance (help) or web resource
- Creating minimalist books for easier authoring and use
These terms keep coming up in DITA conversations; what do they mean?
- topic-oriented authoring
- Creating a unit of information for a single subject. The topics can then be assembled into help systems or books that require a particular selection and organization of subjects.
- information typing
- Identifying the type of topic, such as task, concept, reference, example, and so on. The type of the topic may determine its structure, such as a task having steps. In DITA, an XML DTD or Schema guides the writer to author information with the correct structure for the topic type.
- specialization
- Extensibility with inheritance, which allows the creation of new types that inherit processing rules from existing types. For example, API documentation is a particular kind of reference information and requires more specific rules and descriptive markup than a generic reference type. DITA lets you define a new type and reuse the processing of the base type (providing new processing only for different requirements of the new type). As a result, topics from different domains with different markup and markup rules can be built together into one help file, Web site, or book
What does a DITA topic look like?
<concept id="simpleconcept"><title>The DITA concept topic</title>
<shortdesc>This type of topic provides background or orientation.</shortdesc>
<conbody>
<p>A concept topic has a title, a short description, and a descriptive body.</p>
</conbody>
</concept>
Can DITA topics represent anything more complex?
DITA information types can define a structure as simple or complex as the subject of the description. DITA provides a core concept, reference, and task types but supports defining new types through specialization. Also, DITA topics can be nested to create larger, composite information structures. For instance, the DITA Language Reference in the DITA distribution is a book-length set of individual, specialized topics arranged into a single, book-like structure.Where is a simple example of topic specialization?
In the DITA distribution, look at the concept.dtd and concept.mod files. The mod file specializes the topic body so that a concept body has introductory content followed by any number of subsections or examples.Where is a simple example of domain specialization?
In the DITA distribution, look at the ui-domain.mod and ui-domain.ent files. The mod file specializes general phrases to distinguish the names of UI components such as menus, windows, and so on. These UI elements are available in the same contexts as the phrase elements on which they are based and can continue to be processed as phrases where appropriate. To create special behavior for a UI element (perhaps underlining the <shortcut> element, for example), you would simply define a rule for the UI element in an overriding XSLT script.How do I select and organize topics for a particular deliverable?
You create a map to organize topics into the hierarchy for a help system or website or into a nested sequence for a book. You can also generate navigation hierarchies from the map and generate links that get added to the topics.What does a DITA map look like?
<map title="Getting Started With DITA"><topicref href="authoring.xml">
<topicref href="simpleconcept.xml"/>
<topicref href="simpletask.xml"/>
<topicref href="simplereference.xml"/>
<topicref href="simplemap.xml"/>
</topicref>
<topicref href="specialization.xml">
<topicref href="topictype.xml"/>
<topicref href="domaintype.xml"/>
<topicref href="processing.xml"/>
</topicref>
</map>
What deliverables or publishing channels can DITA support?
The trend in information delivery is to deliver content as closely as possible to the point of use, typically as integrated help systems, web sites, or how-to instruction pages. By evolving and extending the DITA transformations, DITA's topic-oriented content can be used to exploit new features or delivery channels as they become available.How can I get my hands on DITA?
- DITA as an OASIS standard - http://www.oasis-open.org/committees/dita
- Open Source Tools: http://dita-ot.sourceforge.net/
- Cover pages bibliography - http://xml.coverpages.org/dita.html
- Support for users: http://groups.yahoo.com/group/dita-users/
- DITA Focus Area: http://dita.xml.org