Troubleshooting topics
Posted: Tue Jul 09, 2024 12:15 pm
Hello everybody,
I'm wondering since a few months what is the real status of the troubelshooting topics...
It looks like an official DITA topic but it seems it is treated a bit differently than the others. For example, in your documentation when you have created this topic:
https://www.oxygenxml.com/doc/versions/ ... ement.html
Did you use the troubleshooting topic? Or a basic concept or topic ?
All these interogations because whatever the output is (WebHelp or PDF in my case), these troubleshoot topics are not as readable as the others. I've joined to this ticket, screenshots of what I get.
In our documentation, troubleshooting have most of the times, several causes and each cause may have several remedies. And with this configuration, the output is fully linear and not really fun to read.
Do you have advices? May I split all my troubleshooting to always have a 1 problem > 1 cause > 1 remedy ?
Is is possible to customize the output of the troubleshooting topics? Creating indentation for example to isolate causes and remedies.
Thank you in advance for your advices!
BR
Mathieu
I'm wondering since a few months what is the real status of the troubelshooting topics...
It looks like an official DITA topic but it seems it is treated a bit differently than the others. For example, in your documentation when you have created this topic:
https://www.oxygenxml.com/doc/versions/ ... ement.html
Did you use the troubleshooting topic? Or a basic concept or topic ?
All these interogations because whatever the output is (WebHelp or PDF in my case), these troubleshoot topics are not as readable as the others. I've joined to this ticket, screenshots of what I get.
In our documentation, troubleshooting have most of the times, several causes and each cause may have several remedies. And with this configuration, the output is fully linear and not really fun to read.
Do you have advices? May I split all my troubleshooting to always have a 1 problem > 1 cause > 1 remedy ?
Is is possible to customize the output of the troubleshooting topics? Creating indentation for example to isolate causes and remedies.
Thank you in advance for your advices!
BR
Mathieu