Exercise 6: Creating DITA task and concept topics

The DITA standard provides different topic types to structure information. In this exercise, you'll create task and concept topics. The exercise will focus on:

  • working with the elements of a task (including prerequisites, contexts, steps, and substeps).
  • working with concepts
  • working with unordered lists
  • inserting an image

Note: This exercise uses the recipes that you developed for your first project as content. If you have other content that you want to work with instead of your recipes, you can use that content.

However, ensure that your content uses the task elements correctly and that you include at least one concept and three task topics.

Ensure that you read chapters 2 and 3 of the DITA Best Practices book. Note that DITA topics have the DITA extension.

Step 1: Create a DITA task topic for each of your recipes.

To create a new DITA task in oXygen, complete the following steps:

  1. Select File > New.
  2. In the New window, expand Framework templates > DITA > topic.
  3. Select Task [DITA/topic] and click Create.
  4. Ensure that your recipe has a <title> and a <shortdesc> element that introduces the recipe.
  5. Add your ingredient list within a <ul> element in the <prereq> element within the task.
  6. Add your instruction list to the <steps> element within the task.

Each step in your recipe should be in a <step> element, with the instruction within a <cmd> element. If the <step> element includes additional information or results, use the <info> or <stepresult> element. Use <substeps> or other elements as necessary.

Examples of additional information:

<step> 
   <cmd>Grease the skillet with bacon drippings (ideal) or oil. </cmd> 
   <info> 
      <note>Butter isn't recommended, since it can burn when you 
      preheat the skillet.</note> </info>
</step>
<step> 
    <cmd>Bake for 25-30 minutes. </cmd>
    <stepresult> 
         <p>The cornbread should have a golden brown color when done,
          and a knitting needle or knife-point will come out "dry" when 
          inserted in the bread.</p> 
     </stepresult> 
</step>

Step 2: Create a concept topic.

To create a new DITA concept topic in oXygen, complete the following steps:

  1. Select File > New.
  2. In the New window, expand Framework templates > DITA > topic.
  3. Select Concept [DITA/topic] and click Create.
  4. Add a <title> and a <shortdesc> element to the concept.
  5. Within the conbody, write an introduction for your assortment of recipes (or reuse what you had in your project).
  6. Create an <ul> element that lists your recipes.
  7. Insert a graphic into your introduction. Select DITA > Insert > Insert Image and navigate to the image that you want to use. (To view the DITA menu, you must be in the Author view instead of Text.)

Step 3: Validate your topics

Ensure that you validate each topic by selecting Document > Validate > Validate.

Step 4: Create PDF and html versions of the topic

To transform the XML into PDF and html versions, complete the following steps:

  1. Open your topic and select Document > Transformation > Configure Transformation Scenarios.
  2. In the Configure Transformation Scenarios window, select DITA PDF and DITA XHTML and click Apply associated.

oXygen uses the transformations that come with the DITA open toolkit to produce renditions of the topic.

Step 5: Zip your topics and turn them in

In a ZIP file ("yourName-tasks_concepts.zip"), include the three task topics containing your recipes and your introductory concept topic. (You do not need to include your PDF or HTML versions.) Your DITA topics should validate against the DITA DTDS correctly and the elements should be used appropriately. Upload the assignment.