Double quotes and <code> #647
Comments
|
@julian.reschke@gmx.de commented You mean , not |
|
@cabo@tzi.org commented The text rendering should enable the specification of a text fallback, like the discussion about demonstrated. An interesting side observation when translating RFC 6125bis into markdown was that someone (the RPC?) had apparently translated all U+002D (hyphen) in snippets that looked like code into U+2011 (non-breaking hyphen). This is another example where we need to look at the rendering of codespans. |
|
@cabo@tzi.org commented #634 for the issue. |
|
@cabo@tzi.org changed _comment0 which not transferred by tractive |
|
@cabo@tzi.org changed _comment1 which not transferred by tractive |
|
@kesara@staff.ietf.org changed status from |
|
@kesara@staff.ietf.org set resolution to |
|
@kesara@staff.ietf.org commented Fixed in 56a8754: Remove quotes from the text rendering of . Fixes #600 and #647. Commit ready for merge. |
|
@rjsparks@nostrum.com commented Fixed in d6838d5: Merged in 56a8754 from krathnayake@ietf.org:\n Remove quotes from the text rendering of . Fixes #600 and #647. |
resolution_fixedtype_defect| by martin.thomson@gmail.comThe current text rendering for
<code>in xml2rfc adds double-quotes around the element. This is encouraging people to avoid the use of this decoration.Please change the text rendering so that quotes are not used. Or, adjust the definition of
<code>so that this can be controlled.Rationale
In HTML,
<code>is usually rendered with a fixed-width font, but no additional quoting. This is good, because it makes the code identifiable, but does not involve additional characters, which might make the quoted contents ambiguous.Take the following example from RFC 7540:
In HTML, this renders without quotes, which can mean that it is hard to clearly distinguish the content of the text from other content of the document. I would like to quote this string explicitly as follows:
But that would render with double double-quotes in text form, which would not be good. The difference in rendering between text and HTML is the main problem.
One thing that I have observed is that the code here reflects a desire to have some text-level signal whenever an XML element is employed. We can see that with
<aside>also (https://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/438) where I agree with Julian that the "|" rendering is unnecessarily being used to distinguish between asides and empty lists with no bullets.This is another example of this incorrect principle being applied. The text rendering can't express all the things that HTML can. It shouldn't even try and it is creating inconsistencies that make authoring documents more difficult.
Issue migrated from trac:647 at 2022-02-08 07:15:49 +0000
The text was updated successfully, but these errors were encountered: