Bug 1014451

Summary: RFE: better formatting for XML validity errors
Product: [Community] PressGang CCMS Reporter: Ruediger Landmann <rlandman>
Component: DocBook-builderAssignee: pressgang-ccms-dev
Status: NEW --- QA Contact:
Severity: low Docs Contact:
Priority: low    
Version: 1.1   
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Ruediger Landmann 2013-10-02 05:04:47 UTC 
Description of problem:
When a topic fails XML validation, DocBuilder outputs the LibXML error message but the formatting makes it very hard to read. 

Version-Release number of selected component (if applicable):
1.1

How reproducible:
100%

Steps to Reproduce:
1. Introduce some invalid DocBook in a large section
2. Look at the result in DocBuilder


Actual results:
1. The error message runs a long way off the screen and requires considerable horizontal scrolling. Coupled with the dense nature of these error messages, it makes the output very difficult to read and parse.
2. DocBuilder replaces the "expected" part of the error message with the XML itself. For a long and complex section, actually spotting the XML error is very difficult. 

I was going to screenshot all this, but gave up when the horizontal scrolling was 4 screens across and the vertical scrolling was >7 screens.

Expected results:
1. DocBuilder should wrap the validation error
2. DocBuilder should output the "expected" portion of the error to help the user find the error. 

Additional info:
Comment 1 Lee Newson 2013-11-22 04:20:39 UTC 
Just adding an additional note.

The expected/got part has been looked at briefly before but wasn't resolved, see: BZ#782980
Comment 2 Lee Newson 2014-03-19 03:37:31 UTC 
I come across this today so I've fixed part 1 of the expected results in 1.5-SNAPSHOT build 201403191329. The error message is now busted up so that it should be slightly more readable and will also wrap, to stay within the confines of the book.

For part 2, that will require more digging.