xml2rfc icon indicating copy to clipboard operation
xml2rfc copied to clipboard

Cross-references to paragraphs within a section of a document

Open klensin opened this issue 2 years ago • 0 comments

Cross-references within a document to paragraphs of the current document are generated, by default, as "Section N.N.N, Paragraph M" (this can be twitched in various ways). However (at least in plain text), if the paragraph is within the current section, e.g., the reference from the fifth paragraph to the second one of the section, that presentation is not only redundant but confusing. "Paragraph 2" would be somewhat better, "Paragraph 2 above" would be even better.

If the processor cannot figure out "same section" from context, or if that is not considered appropriate, shifting the burden to the author by some format attribute that suppresses the section number in the generated text would be reasonable. Similarly while I believe it would be better to have the processor figure out "above" or "below" in addition to whether the text is in the same section or not (both would make the XML source much more robust as text is moved around) a format attribute that simply eliminates generation of the "Section" string and number would be sufficient -- the author could always put "above" or "below" after the element.

klensin avatar Oct 24 '22 16:10 klensin