DITA Topic Types Overview
Key Characteristics of Each Topic Type:
1. Task – Describes how to perform a specific activity (steps, commands).
2. Concept – Explains what something is or why it’s important.
3. Reference – Provides structured factual data (tables, specifications).
Task Topics
1. Creating a User Account
<?xml version=”1.0″ encoding=”UTF-8″?>
<!DOCTYPE task PUBLIC “-//OASIS//DTD DITA Task//EN” “task.dtd”>
<task id=”create-user-account”>
<title>How to Create a User Account</title>
<shortdesc>Learn how to create a user account in the system.</shortdesc>
<taskbody>
<context>
<p>You need administrator access to create a new user account.</p>
</context>
<steps>
<step><cmd>Log in to the admin portal using your credentials.</cmd></step>
<step><cmd>Navigate to the <b>User Management</b> section.</cmd></step>
<step><cmd>Click the <b>Add User</b> button.</cmd>
<info><p>Ensure the username is unique and follows the company naming conventions.</p></info>
</step>
<step><cmd>Fill in the required fields, such as username, email, and role.</cmd></step>
<step><cmd>Click <b>Save</b> to create the account.</cmd></step>
</steps>
</taskbody>
</task>
2. Installing Software
<?xml version=”1.0″ encoding=”UTF-8″?>
<!DOCTYPE task PUBLIC “-//OASIS//DTD DITA Task//EN” “task.dtd”>
<task id=”dita-task-example”>
<title>How to Install Software</title>
<shortdesc>Follow these steps to install the software on your computer.</shortdesc>
<taskbody>
<steps>
<step><cmd>Download the installer from the official website.</cmd></step>
<step><cmd>Double-click the downloaded file to open the installer.</cmd></step>
<step><cmd>Follow the on-screen instructions to complete the installation.</cmd></step>
</steps>
</taskbody>
</task>
Concept Topics
1. Benefits of Cloud Computing
<?xml version=”1.0″ encoding=”UTF-8″?>
<!DOCTYPE concept PUBLIC “-//OASIS//DTD DITA Concept//EN” “concept.dtd”>
<concept id=”cloud-computing-benefits”>
<title>Benefits of Cloud Computing</title>
<shortdesc>Explore how cloud computing enhances efficiency and scalability.</shortdesc>
<conbody>
<p>Cloud computing provides on-demand access to computing resources, enabling businesses to scale operations without significant upfront investments.</p>
<section>
<title>Key Benefits</title>
<ul>
<li>Scalability: Easily adjust resources based on demand.</li>
<li>Cost Efficiency: Pay only for what you use.</li>
<li>Collaboration: Access files and applications from anywhere.</li>
<li>Data Security: Benefit from robust data protection measures.</li>
</ul>
</section>
<section>
<title>Use Cases</title>
<p>Common use cases for cloud computing include web hosting, data storage, and software as a service (SaaS).</p>
</section>
</conbody>
</concept>
2. What is Structured Content?
<?xml version=”1.0″ encoding=”UTF-8″?>
<!DOCTYPE concept PUBLIC “-//OASIS//DTD DITA Concept//EN” “concept.dtd”>
<concept id=”dita-concept-example”>
<title>What is Structured Content?</title>
<shortdesc>Structured content is organized and tagged for consistent reuse and publishing.</shortdesc>
<conbody>
<p>Structured content refers to information that is consistently organized using a predefined schema, such as DITA. It allows for better content management and supports multiple output formats.</p>
</conbody>
</concept>
3. Introduction to DITA
<?xml version=”1.0″ encoding=”UTF-8″?>
<!DOCTYPE topic PUBLIC “-//OASIS//DTD DITA Topic//EN” “topic.dtd”>
<topic id=”dita-example”>
<title>Introduction to DITA</title>
<shortdesc>Learn about DITA, a standard for structured content.</shortdesc>
<body>
<section id=”what-is-dita”>
<title>What is DITA?</title>
<p>DITA (Darwin Information Typing Architecture) is an XML-based standard for creating, organizing, and managing structured content.</p>
</section>
<section id=”benefits-of-dita”>
<title>Benefits of DITA</title>
<p>DITA offers the following advantages:</p>
<ul>
<li>Content reuse across multiple documents.</li>
<li>Efficient collaboration among writers.</li>
<li>Easy publishing to various formats such as HTML, PDF, and eBooks.</li>
</ul>
</section>
</body>
</topic>
Reference Topics
1. REST API Endpoints
<?xml version=”1.0″ encoding=”UTF-8″?>
<!DOCTYPE reference PUBLIC “-//OASIS//DTD DITA Reference//EN” “reference.dtd”>
<reference id=”api-endpoints”>
<title>REST API Endpoints</title>
<shortdesc>Details about the available API endpoints for the application.</shortdesc>
<refbody>
<section>
<title>Endpoints</title>
<table>
<tgroup cols=”3″>
<thead>
<row>
<entry>Endpoint</entry>
<entry>Method</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row><entry>/users</entry><entry>GET</entry><entry>Retrieve a list of users.</entry></row>
<row><entry>/users/{id}</entry><entry>GET</entry><entry>Retrieve details for a specific user.</entry></row>
<row><entry>/users</entry><entry>POST</entry><entry>Create a new user.</entry></row>
<row><entry>/users/{id}</entry><entry>DELETE</entry><entry>Delete a user by ID.</entry></row>
</tbody>
</tgroup>
</table>
</section>
</refbody>
</reference>
2. File Format Specifications
<?xml version=”1.0″ encoding=”UTF-8″?>
<!DOCTYPE reference PUBLIC “-//OASIS//DTD DITA Reference//EN” “reference.dtd”>
<reference id=”dita-reference-example”>
<title>File Format Specifications</title>
<shortdesc>Details about the supported file formats.</shortdesc>
<refbody>
<section>
<title>Supported File Formats</title>
<table>
<tgroup cols=”2″>
<thead>
<row>
<entry>Format</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row><entry>PDF</entry><entry>Portable Document Format, used for documents.</entry></row>
<row><entry>HTML</entry><entry>HyperText Markup Language, used for web pages.</entry></row>
<row><entry>XML</entry><entry>Extensible Markup Language, used for structured data.</entry></row>
</tbody>
</tgroup>
</table>
</section>
</refbody>
</reference>
Explanation of DITA Elements
| Element | Description |
| <topic> | The root element for a DITA topic. |
| <title> | Defines the title of the topic or section. |
| <shortdesc> | Provides a concise summary of the topic. |
| <section> | Defines sections within the topic. |
| <p> | Contains a paragraph of text. |
| <ul> and <li> | Used for unordered lists and list items. |
| <cmd> | Represents a command in a task. |
| <table> | Creates a table layout for reference data. |