The DITA Project #1 in a series
Let’s say that you have a series of menu choices (such as Start > Programs > Accessories > Notepad). Each menu choice item should be in its own <uicontrol> tag. The whole series should be in a <menucascade> element.
A common error in preparing content is jamming multiple UI controls in one <uicontrol> tag, manually adding the connecting character (typically “>”).
Typical incorrect markup would be:
<menucascade><uicontrol>Start > Programs > Accessories > Notepad</uicontrol></menucascade>
The correct markup would be:
<menucascade><uicontrol>Start</uicontrol>
<uicontrol>Programs</uicontrol>
<uicontrol>Accessories</uicontrol>
<uicontrol>Notepad</uicontrol></menucascade>
When the content is published, the DITA OT adds connecting characters between the menu items to represent the menu cascade. So, the output would look similar to Start > Programs > Accessories > Notepad.
Announcing… The DITA Markup Project
Inspired by the movie Julie & Julia, here at Method M we have undertaken to emulate Julie Powell, who cooks all 524 recipes from Julia Child’s cookbook during a single year, a challenge she described on her popular blog.
So, we are off. In 52 weeks we will try and post 104 examples of Do’s and Don’ts for DITA Markup. No time to write more, we have to start preparing posts. If you have suggestions that you want us to post, just go ahead and send them to us (info at methodm dot com). We’ll be happy to credit you!
Stay tuned for the first postings soon.
One idea, one topic
DITA Thought for Today: one idea, one topic.
Just saw a procedure with mixed in in the prerequisites. An attempt to sneak in another procedure!
Tip for today: dividing your task topic into sections is usually a tip-off that your topic has more than one procedure.
Remember – one idea, one topic. (Kind of like, “one man, one vote”.)
