I have had to make some additional minor adjustments to the content model for the troubleshooting topic based upon feedback from JoAnn Hackos and Dawn Stevens at Comtech. The content models were still too tight to accommodate reasonable use cases. Fortunately, the problems could be fixed with minor adjustments.
I am mildly embarrassed about making yet another round of adjustments to the model. But, starting out with a model that is too tight is a better technique than starting out with one that is too loose. I feel that these latest adjustments significantly improve the utility of the model without sacrificing too much in terms of authoring guidance.
New versions of the review material and the DITA OT plugin are available on Kavi at these locations:
Here is a summary of the changes:
- troubleshooting.dtd: invocation of task.mod was moved from the domains integration section of the DTD to the elements integration section of the DTD. It was necessary to have the task.mod definitions incorporated into the DTD before troubleshooting.mod, which refers to the various steps elements.
- troubleshooting.mod:
- Content model for troubleSolution was loosened as follows:
OLD: cause?, remedy (optional cause element followed by a single required remedy element)
NEW: cause*, remedy* (zero or more cause elements followed by zero or more remedy elements) - The steps-informal element was added to the steps choice in remedy as follows:
OLD: (steps | steps-unordered)
NEW: (steps | steps-unordered | steps-informal)
- dita_troubleshooting_topic.dita: Element descriptions for troubleSolution, cause, and remedy were revised to reflect the new content models.
- troubleSolution.dita: The description was revised to reflect the element's new content model.
Best Regards,
-- Bob Thomas
+1 720 201 8260
Skype: bob.thomas.colorado
Instant messaging: Gmail chat (bob.thomas@tagsmiths.com) or Skype
Time zone: Mountain (GMT-7)