ietf-tools / xml2rfc

Generate RFCs and IETF drafts from document source in XML according to the IETF xml2rfc v2 and v3 vocabularies
https://ietf-tools.github.io/xml2rfc/
BSD 3-Clause "New" or "Revised" License
69 stars 38 forks source link

xml2rfc mistakenly thinks it's ok to add a line-break in the middle of "S/MIME" #984

Open dkg opened 1 year ago

dkg commented 1 year ago

Describe the issue

Over on draft-ietf-lamps-header-protection-14 the text version reads:

   Privacy and security issues regarding email Header Protection in S/
   MIME and PGP/MIME have been identified for some time.  Most current

This is from the source XML:

<t>Privacy and security issues regarding email Header Protection in S/MIME and PGP/MIME have been identified for some time.
Most current 

I'd like to ensure that there's no linebreak in either "S/MIME" or "PGP/MIME" (the WG chair suggests the same concern). Any suggestions on how to improve the situation?

Code of Conduct

kesara commented 1 year ago

You can use a Unicode hack like the word joiner &#8288;. Changing how xml2rfc breaks lines is another option but it might have undesired effects on previous documents.

cabo commented 1 year ago

Clearly, this is something where authoring tools could help. E.g., declare S/MIME as a non-breakable term (automatically generating the word joiners Kesara mentioned). (Note that there are other slash-joined terms where you very much do want line breaking to occur.)

cabo commented 1 year ago

Clearly, this is something where authoring tools could help.

Please see https://github.com/cabo/kramdown-rfc/commit/adf04a2 for an experimental solution that is now in 1.6.31 — feedback requested.

cabo commented 1 year ago

More about <nobr> support in kramdown-rfc: https://mailarchive.ietf.org/arch/msg/rfc-markdown/umCatJwgKIhYF3yRRGdRhKVSy4U