How to show a step that branches different sets of sub-steps.

143 views
Skip to first unread message

David Goss

unread,
May 1, 2014, 1:43:56 PM5/1/14
to dita-o...@googlegroups.com
What is the correct way to markup this scenario:

I have a step that is going to split into two different substeps. It is something like this

<step>
<cmd>Select a user</cmd>
<choices>
<choice>Select an existing user</choice>
<choice>Create a new user</choice>
</choices>
</step>

There would be two sets of sub-steps for each choice. The below is not valid, but gives an idea of what I want to do.

<!-- Not valid -->
<step>
<cmd>Select a user</cmd>
<choices>
<choice>Select an existing user</choice>
<substeps>
<substep>
<cmd>Do this</cmd>
</substep>
<substep>
<cmd>Then this</cmd>
</substep>
</substeps>
<choice>Create a new user</choice>
<substeps>
<substep>
<cmd>Do this</cmd>
</substep>
<substep>
<cmd>Then this</cmd>
</substep>
</substeps>
</choices>
</step>

I know I can put two sets of substeps into a step, however I don't see a way I can associate the substep with a choice, or at least label them with a title or something. I could put an <info> between the substeps and put a lead in sentence, however that seems like an un-DITA thing to do (because I'm only doing it to achieve the desired presentation).

Usually when I encounter this, situation (a step branching in two different directions, depending on the situation), I try to re-write to avoid it. It happens frequently though, and I have a scenario that I can't properly re-write, so I'm hoping there is a good way to express this in DITA.

I'm open to solutions that involve modifications to our custom plugin, though I'd like to avoid that.

Robert D Anderson

unread,
May 1, 2014, 5:46:37 PM5/1/14
to David Goss, dita-o...@googlegroups.com

I've previously seen this handled with nested tasks. For example:

<task>
  <title>current task title</title>
  <taskbody> context, prereqs, etc</taskbody>
  <task>
    <title>Selecting an existing user</title>
    <taskbody> add steps here </taskbody>
  </task>
  <task>
    <title>Creating a new user</title>
    <taskbody> add steps here </taskbody>
  </task>

Alternatively, you could use a map that has a parent task, with the two sub-tasks as distinct files.

In the past I've also had processing set up so that if a task does not have steps, but it has task children, you get links to those children where the steps would usually appear. I can't remember if this is the current default processing for tasks, but if not it's a fairly straightforward change.

Robert D Anderson
IBM Authoring Tools Development
Chief Architect, DITA Open Toolkit (http://dita-ot.sourceforge.net/)


Inactive hide details for David Goss ---05/01/2014 12:43:59---What is the correct way to markup this scenario: I have a step thDavid Goss ---05/01/2014 12:43:59---What is the correct way to markup this scenario: I have a step that is going to split into two diffe

--
You received this message because you are subscribed to the Google Groups "DITA-OT Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to
dita-ot-user...@googlegroups.com.
For more options, visit
https://groups.google.com/d/optout.

Reply all
Reply to author
Forward
Message has been deleted
0 new messages