Bug 1039800

Summary: Spell checker is picking up erroneous mispelling across xml tags and in conditional text
Product: [Community] PressGang CCMS Reporter: mmurray
Component: DocBook-builderAssignee: Matthew Casperson <mcaspers>
Status: CLOSED CURRENTRELEASE QA Contact:
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 1.3CC: cbredesen, lnewson, mcaspers
Target Milestone: ---   
Target Release: 1.8   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-07-13 21:10:56 UTC 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 mmurray 2013-12-10 02:39:06 UTC 
Description of problem:

Example: http://docbuilder.usersys.redhat.com/22435/

1. Spell checker as picked out words in consecutive xml tags as run-on words and so misspellings. This issues seems to be restricted to custom Author, Revision History and Feedback files.

For example, 'HatDocumentation' is from the Author file, with <firstname>Red Hat</firstname><surname>Documentation Team</surname>.


2. Also, the spelling errors identified in the Feedback file show that the spell checker is identifying and listing spelling errors in text that shouldn't be included in this content spec because it is enclosed in condition tags.

For example, 'wiki' is included in a para with 'jbt' condition and this content spec does not include text with that condition.
Comment 1 Matthew Casperson 2014-01-12 20:12:57 UTC 
To fix this we'll need to identify DocBook tags that add spaces in the final output that don't exist in the raw XML. I can't imagine there are many, but I'll add a check for <firstname> and <surname>.

I'll also add some logic to remove spell checking from XML conditional elements that don't appear in the current book.
Comment 2 Matthew Casperson 2014-07-07 04:00:57 UTC 
Fixed in presszilla_fixes branch.

XML elements that don't match the condition in the spec are removed, and the XML elements firstname, surname and revnumber have spaces manually inserted after them to prevent run on names and numbers from adding false positives to the list of misspelled words.
Comment 3 Lee Newson 2014-07-08 00:19:50 UTC 
Verified that conditional content and the elements mentioned no longer show as spelling errors. I also checked some additional books and couldn't find anymore elements that needed a space added.