• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar

Learning DITA

Free DITA training

Free DITA training

  • Log in
  • Register
  • Newsletter
  • Profile
  • Privacy
  • Home
  • About
  • Courses
  • News
  • Resources
  • Support the site
  • Contact
  • Recordings

Adding basic elements to a concept topic

Posted on 08.30.15

Some of the most commonly used elements in a concept topic include:

<p>

paragraph

<ul>

unordered list

<ol>

ordered list

<note>

admonition

These elements were covered in the Introduction to DITA course. This lesson gives a brief review of these elements and shows how to add them to a concept topic.

Practice
  1. Continue using the file lesson1/l_new_concept_start.dita.
  2. Inside the <conbody> element, add a <p> element and populate it as shown in the following example:
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
    <concept id="my_first_concept">
       <title>Wild duck species</title>
     <conbody>
    <p>North American wild ducks belong to one of the following categories:</p>
       </conbody>
    </concept>
    The <p> element is for body text. It can be used inside the <conbody> element as well as inside many of the elements that <conbody> contains.

    Note:

    Use the <p> element for any body text that does not need a more specific element tag. As you will see in examples throughout this course, we recommend using the <p> element to tag text inside list items, notes, and table entries. <p> elements are needed for list items that are several paragraphs long, and wrapping single items in the <p> element keeps them all consistent.

    The <p> element you just created introduces the next element: an unordered list.
  3. After the <p> element, add a <ul> element and populate it as shown in the following example:
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
    <concept id="my_first_concept">
       <title>Wild duck species</title>
      <conbody>
    ...
    <ul>
    <li><p>Dabbling ducks</p></li>
    <li><p>Diving ducks</p></li>
    <li><p>Sea ducks</p></li>
    <li><p>Whistling ducks</p></li>
    <li><p>Swans and geese</p></li>
    </ul>

       </conbody>
    </concept>
    The <ul> element is for unordered or bulleted lists.
    The <ul> element can only contain the <li> element, and it must contain at least one.
    Each <li> element contains the text for a bulleted entry in the list. In this example, the <li> elements follow the best practice of wrapping a <p> element around the text.
  4. After the <ul> element, add an <ol> element with an introductory <p> element as shown in the following example:
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
    <concept id="my_first_concept">
       <title>Wild duck species</title>
       <conbody>
    ...
     <p>The longest species of dabbling ducks in North America are:</p>
    <ol>
    <li><p>Northern pintail</p></li>
    <li><p>Mallard</p></li>
    <li><p>American black duck</p></li>
    </ol>

       </conbody>
    </concept>
    The <ol> element is for ordered or numbered lists.
    Like the <ul> element, the <ol> element can only contains <li> elements, and it must contain at least one.
    In this example, each of the <li> elements follows the best practice of wrapping a <p> element around the text.

    Note:

    Use the <ol> element only to show that the list items should appear in a certain order, not to create step-by-step instructions. For step-by-step instructions, use the task topic instead.

  5. After the <ol> element, add a <note> element and populate it as shown in the following example:
    Video: Creating a note in DITA
    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
    <concept id="my_first_concept">
       <title>Wild duck species</title>
      <conbody>
    ...
    <note><p>Although the northern pintail is the longest dabbling duck, the mallard 
    is generally considered the largest because of its heavier body weight.</p></note>

       </conbody>
    </concept>
    The <note> element is used to add admonitions, such as notes, warnings, or cautions, to the concept topic. The <note> element you just created follows the best practice of wrapping a <p> element around the text.
  6. Check your file lesson1/l_new_concept_start.dita against the sample file lesson1/l_new_concept.dita.
Practice
  1. Open the file lesson1/l_new_concept_exercise_start.dita and use it to convert the following untagged content into DITA:

    Source: Content Strategy 101

  2. Check your file lesson1/l_new_concept_exercise_start.dita against the sample file lesson1/l_new_concept_exercise.dita.
Contributors
  • Gretyl Kinsey, Scriptorium

sidebar

Blog Sidebar

  • Scriptorium logo
    Maximize the value of your content. Read more.
  • Scriptorium logo
    Already in DITA and need support? Contact us.
RSSTwitter

Want to add content? Join the ditatraining GitHub repository.

  • Home
  • Sponsor
  • News
  • Contact
  • Privacy
  • Cookie Policy

Maintained by Scriptorium Publishing

Logo and site presentation © 2015-2023 Scriptorium Publishing. Content based on the open-source DITA training project.

Manage Cookie Consent
To provide the best experiences, we use technologies like cookies to store and/or access device information. Consenting to these technologies will allow us to process data such as browsing behavior or unique IDs on this site. Not consenting or withdrawing consent, may adversely affect certain features and functions.
Functional Always active
The technical storage or access is strictly necessary for the legitimate purpose of enabling the use of a specific service explicitly requested by the subscriber or user, or for the sole purpose of carrying out the transmission of a communication over an electronic communications network.
Preferences
The technical storage or access is necessary for the legitimate purpose of storing preferences that are not requested by the subscriber or user.
Statistics
The technical storage or access that is used exclusively for statistical purposes. The technical storage or access that is used exclusively for anonymous statistical purposes. Without a subpoena, voluntary compliance on the part of your Internet Service Provider, or additional records from a third party, information stored or retrieved for this purpose alone cannot usually be used to identify you.
Marketing
The technical storage or access is required to create user profiles to send advertising, or to track the user on a website or across several websites for similar marketing purposes.
Manage options Manage services Manage vendors Read more about these purposes
View preferences
{title} {title} {title}
Manage Cookie Consent
To provide the best experiences, we use technologies like cookies to store and/or access device information. Consenting to these technologies will allow us to process data such as browsing behavior or unique IDs on this site. Not consenting or withdrawing consent may adversely affect certain features and functions.
Functional Always active
The technical storage or access is strictly necessary for the legitimate purpose of enabling the use of a specific service explicitly requested by the subscriber or user, or for the sole purpose of carrying out the transmission of a communication over an electronic communications network.
Preferences
The technical storage or access is necessary for the legitimate purpose of storing preferences that are not requested by the subscriber or user.
Statistics
The technical storage or access that is used exclusively for statistical purposes. The technical storage or access that is used exclusively for anonymous statistical purposes. Without a subpoena, voluntary compliance on the part of your Internet Service Provider, or additional records from a third party, information stored or retrieved for this purpose alone cannot usually be used to identify you.
Marketing
The technical storage or access is required to create user profiles to send advertising, or to track the user on a website or across several websites for similar marketing purposes.
Manage options Manage services Manage vendors Read more about these purposes
View preferences
{title} {title} {title}