Red Hat Bugzilla – Bug 814393
Skynet inserts errant whitespace in emphasis, acronym, systemitem, package, and keycap tags.
Last modified: 2014-05-26 21:30:07 EDT
Description of problem:
When re-visiting some edits to topic 7868 I found that this (as originally entered):
For every type of switch it is important to set up the switch bonding with the <firstterm>Link Aggregation Control Protocol</firstterm> (<acronym>LACP</acronym>) protocol and <emphasis>not</emphasis> the Cisco <firstterm>Port Aggregation Protocol</firstterm> (<acronym>PAgP</acronym>) protocol.
Had become this (as modified by the system when the topic is saved):
For every type of switch it is important to set up the switch bonding with the <firstterm>Link Aggregation Control Protocol</firstterm> (
</acronym>) protocol and
</emphasis> the Cisco <firstterm>Port Aggregation Protocol</firstterm> (
I anticipate that when rendered this will mean that there is (unexpectedly) additional whitespace around the acronyms and the emphasised 'not'.
These tags to be handled in the same way as the <firstterm> in the example, no additional whitespace injected. Possibly impacts other tags too but these are just the ones I have come across.
I've found that systemitem, package and keycap tags have the same issue - probably others. I'm raising the priority on this because:
a) It's noticeable in the English output, and even if we edit the topic to remove the whitespace in skynet when the topic is saved it is re-inserted.
b) It impacts translation matching, and adds some additional work for translators (because they can actually remove the errant whitespace in translated versions).
Looks like editing out the whitespace around the <acronym> tags actually does save, not so for the others though.
Sorry Steve, I completely missed this bug. I'll update the system variables that control the inline elements at COB in BNE today, unfortunately we don't have a way to update them at this point in time so that means manually going back and editing the content. I'll discuss that component with Matt once he gets back.
Just as reference we have this bug open for the white space Bug #812716
and these are the current inline variables as of 27th of June (before editing):
So package and emphasis are the only two that I can see to be missing. If you know of any others that are missing please let us know.
Added more inline elements that I found from: http://www.docbook.org/tdg5/en/html/ch02.html
One more that I found when looking through different topics:
We could simply run through a bulk re-save of topics, which will change the formatting of the topics. However this does have implications on the translations as any changes to the original topic could potentially force a retranslation.
However, I don't think there are any topics in Zanata for anyone other than EAP6 and maybe EDG, so this may not be such a large issue.
The other issue with a bulk re-save is that the white space would still exist it would just make it easy to see where the white space is.
Some Text <systemitem>Some more Text</systemitem>
Some more TextSPACE
Some Text <systemitem> Some more Text </systemitem>
Seems like the <uri> tag is also impacted.
Confirmed and added to the list of inline elements.
*** Bug 808989 has been marked as a duplicate of this bug. ***
<computeroutput> as well. As per the docbook guide this is an inline:
Added computeroutput to the list of inline elements.
This hasn't been touched in a while, which implies that we haven't found more. Am I correct that this issue is actually fixed for all known impacted elements?
Closing this since we haven't found anymore known elements.