OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

dita-techcomm message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Re: [dita-techcomm] Meeting regarding troubleshooting

Hi JoAnn,

There would  be a processing expectation that output stylesheets would insert generated text for titles upon output. This would be the same same sort of expectation that currently exists for elements in task such as prereq or context. The advantages to having the titles inserted by stylesheet are:
  • Consistency
  • Semantic enforcement. That is, an author couldn't drop a semantically mismatched title into an element like cause to use it for some other purpose.
  • Simplified authoring
Best Regards,

On Wed, Aug 14, 2013 at 4:52 PM, JoAnn Hackos <joann.hackos@comtech-serv.com> wrote:
Hi Bob 
Thinks for your dedication to this work. Generally I think the tightened model is well considered. However, I don't understand the rationale of eliminating the titles. Does that mean that processing has to add titles if the organization wants them to divide the parts?
 Please explain how this would work and why titles are undesirable.


Sent from my iPad
JoAnn Hackos
Comtech Services Inc
710 Kipling Street Suite 400
Lakewood CO 80215

On Aug 14, 2013, at 5:55 PM, "Bob Thomas" <bob.thomas@tagsmiths.com> wrote:


I had a productive meeting with Michael Priestley, Kris Eberlein, and Robert Anderson regarding the troubleshooting topic.

The chief outcome is that Michael and Robert agreed to abandon the requirement the new troubleshooting topic has to be structurally compatible the IBM troubleshooting specialization. Consequently, we are now able to offer our users a much tighter model for troubleshooting.

What follows are the results of a quick collaboration on the call to tighten things up in thetroubleshooting topic.
  • troublebody begins with an optional condition element followed by one or more troubleSolution elements. The cause and remedy elements can no longer be direct children of troublebody. They must be wrapped inside of troubleSolution. This adds clarity to the model.
  • troubleSolution begins with an optional cause element followed by a required remedy element
  • cause and condition now begin with an optional title followed by a block mix (p, ol, table, ...). Direct text under cause and condition are no longer allowed, and title can only occur at the beginning of the element.
  • remedy begins with an optional title, followed by an optional responsibleParty, then a required choice between steps and steps-unordered
Michael and Kris were also pushing to have title removed from condition, cause, and remedy. I think that we ought to do this. How about you?

I realize that it is presumptuous to make all of these changes. Normally, I would have to come to you first, but time is running out. Please let me know as soon as possible if you object to any of these changes or if you have questions about them. We definitely need to talk about the new model on Monday's call. 

I have implemented the revised model as a DITA OT plugin, and it is attached.

Best Regards,
Bob Thomas
Skype: bob.thomas.colorado
Instant messaging: Gmail chat (bob.thomas@tagsmiths.com) or Skype
Time zone: Mountain (GMT-7)


To unsubscribe from this mail list, you must leave the OASIS TC that
generates this mail.  Follow this link to all your TCs in OASIS at:

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)

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]