question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

1.3: Support heading for tasktroubleshooting element

See original GitHub issue

Proposal 13096

EDIT: clarification added by @robander, May 4 2016: DITA 1.3 introduced <tasktroubleshooting> as a specialization of <section> within task topics.

We currently have the ability to add headings to task sections, using the args.gen.task.lbl parameter. This is supported for PDF and X/HTML (not sure about other formats). This feature request is a request to add headings for the new task section as well.

Issue Analytics

  • State:open
  • Created 9 years ago
  • Reactions:1
  • Comments:14 (13 by maintainers)

github_iconTop GitHub Comments

2reactions
shaneataylorcommented, Feb 2, 2017

@shudson310 I agree this would be very helpful, but wonder if troubleshooting section labels shouldn’t be controlled by a separate parameter, maybe a new args.gen.tbs.lbl?

Alternatively, maybe a new token-based args.gen.labels parameter would provide more flexibility, so users could specify (e.g.)

args.gen.labels = steps result condition remedy tasktroubleshooting

Also (and this might be my own quibble with the spec), when (almost always) the problem condition can be stated succinctly, I put it in <shortdesc> rather than <condition> to assist users who are scanning / searching troubleshooting topics to resolve a problem. I wonder what others think about:

  • applying the Condition label to the short description if no <condition> is specified?
  • processing <condition> as a <shortdesc> if no <shortdesc> exists?
1reaction
shudson310commented, Feb 2, 2017

I expect that when args.gen.task.lbl is set to “yes”, that rendered troubleshooting topics would get labels for:

  • Condition
  • Cause
  • Remedy

Also a label “Troubleshooting” for steptroubleshooting and tasktroubleshooting.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Task elements - Oxygen XML Editor
The <tasktroubleshooting> element provides information designed to help users remedy the situation when a task does not complete as expected.
Read more >
Getting Out of Trouble: DITA 1.3 Troubleshooting
The steptroubleshooting element is used to describe troubleshooting within a step, and tasktroubleshooting is used for a problem that does not ...
Read more >
DITA 1.3 Feature Article: Using DITA 1.3 Troubleshooting
This topic describes DITA 1.3 support for the troubleshooting information type. What are the troubleshooting features? A new <troubleshooting> ...
Read more >
Source-Talkback 1.3: Troubleshooting
This article is part of the Source-Talkback 1.3 User Guide Known Issues ... https://support.source-elements.com/pages/software-user-guides-and-manuals ...
Read more >
<h1>–<h6>: The HTML Section Heading elements
The to HTML elements represent six levels of section headings. is the highest section level and is the lowest.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found