Error messages should help identifying the topic/map
See original GitHub issueThe log message [DOTX019W]
currently looks like this:
[move-meta] [DOTX019W][WARN]: The type attribute on a topicref was set to ‘xxxxx’, but the topicref references a ‘yyyyy’ topic. This may cause your links to sort incorrectly in the output. Note that the type attribute cascades in maps, so the value ‘xxxxx’ may come from an ancestor topicref.
Unfortunately the message does not help to identify the <topicref>
.
- I read the CONTRIBUTING file.
Expected Behavior
The message should help the user to determine the affected <topicref>
.
Actual Behavior
Affected <topicref>
is not reported.
Possible Solution
The message should print the linking attributes @href
and/or @keyref
.
Environment
- DITA-OT version: 2.5
- Operating system and version: all
- How did you run DITA-OT? Ant
- Transformation type (HTML5, PDF, custom, etc.): all
More error messages
[topicpull] [DOTX028E][ERROR]
Link or cross reference must contain a valid href or keyref attribute;
no link target is specified.
[DOTJ061E][ERROR]
Topic reference target is a DITA map but format attribute has not been set.
Set format attribute value to "ditamap".
[clean-map] [DOTX072I][INFO]
Ignoring navtitle within topicgroup.
Issue Analytics
- State:
- Created 6 years ago
- Reactions:2
- Comments:7 (7 by maintainers)
Top Results From Across the Web
Error Messages | Maps JavaScript API - Google Developers
For help on finding error messages, see the section on checking errors in your browser. The following flow will help you troubleshoot the...
Read more >Error Message Guidelines - Nielsen Norman Group
Established wisdom holds that good error messages are polite, precise, and constructive. The Web brings a few new guidelines: Make error messages clearly ......
Read more >7 Steps To Have Impressive Error Messages | by Amisiy | Muzli
Error messages give people the information they need to move on while identifying any frustration and alleviating anxiety. Certainly, when faced ...
Read more >Sterling B2B Integrator Map Editor Error Messages - IBM
The Sterling B2B Integrator Map Editor error messages are displayed when you commit an erroneous action in the Sterling B2B Integrator Map Editor....
Read more >How to Write Helpful Error Messages to Improve Your App's ...
This saves us time and cuts down on red herrings. A clear and specific error message may also help an end-user understand what...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
In addition to adding the source of the issue, the message itself should be shortened.
Should be moved to documentation.
Error message contains file and element location in DITA-OT 3.1:
DOTX019W
DOTX028E
DOTJ061E
DOTX072I