Line-breaks in topic titles causing builds to fail

[super-structure]

Trailing line breaks within topic <title> elements of cause builds to fail when the search result previews are generated (at taskname gen-preview-json). This appears to be when converting the title contents from text node to attribute value in merge-data.xsl.

Simply wrapping the existing xpath in a normalize-space() function resolves the issue; at least for leading or trailing line breaks.

[infotexture]

@super-structure Thanks for reporting this and proposing the fix.

I can't seem to reproduce the issue. I tested with a long topic title that contained multiple line breaks and everything still worked fine:

Can you provide more details on the circumstances that cause the problem?

[super-structure]

@infotexture Sure! And I should have specified line feeds instead of line breaks. I narrowed down the issue to the following topic title element:

   <title> Security Release Notes
	 </title>

I just noticed that there is a line feed, tab, and trailing space in that title. I had suspected it was the line feed, though it could be any combination of those I suppose.

[jason-fox]

LGTM.

[jason-fox]

I couldn't reproduce the error at first, but that is because I was editing the DITA Bootstrap sample like @infotexture which includes an .editorconfig like this:

indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

Now when I deliberately remove that and deliberate change the title I can reproduce the error, and normalize-space() seems to fix it since by definition normalize-space() :

• Removes all leading spaces.
• Removes all trailing spaces.
• Replaces any group of consecutive whitespace characters with a single space.

Which will remove any \t or \r\n nonsense from the Title in the JSON.

[infotexture]

@jason-fox Thanks for reviewing and merging.

It's easy to forget that .editorconfig prevents stuff like this from creeping in, and a good reminder that linting tools are incredibly useful. But not everyone uses them, so certainly make sense to ship this fix. 👍