Re: [Rswg] [interim-rfc-series-project-manager/draft-irse-xml2rfc-changes] Hierarchical numbered lists, references to list items (Issue #1)

[Toerless Eckert <[e-mail]>]

[let me add RSWG for broader community review]

Thanks a lot, Jean, inline

On Tue, Sep 27, 2022 at 08:32:25AM -0700, Jean Mahoney wrote:
> Regarding a), nested ordered lists are documented on the authors.ietf.org site. Please see the description of the type attribute (type='%p%d') on the Attributes tab of https://authors.ietf.org/en/rfcxml-vocabulary#ol

Hah! yes, i had not found the % notation for the type attribute, and maybe i didn't well enough
communicate the desire with RFC editor:

  <ol spacing="normal" type="%p%c"> ...

  1.  BIER-TE inherits ...

      1.a  The fundamental purpose o ...
      ^^^

The 1.a is what i wanted. The only thing that i could see being improved here is that it should
not need to be indented, e.g.:

  1.  BIER-TE inherits ...

  1.a  The fundamental purpose o ...


But i don't see how that would be possible today.

[ Just because lines become ugly short with so much indentation. And indentation is originally
to differentiate the two tiers of the list, which is not necessarily anymore with the "1.a" formatting... ]

> For b),  https://www.ietf.org/archive/id/draft-ietf-bier-te-arch-13.html has the description "Section 3.2, Paragraph 3, Item 2.2.1" for the item being cross-referenced, but 'Item 2.2.1' isn't correct. It should say "Section 3.2, Paragraph ..." Actually, I'm not sure what it should say because the xref is pointing to the first item of an ordered list that is nested within a definition list. Perhaps "Section 3.2, Definition 1, Item 1".

Let me rephrase the root problem: There is no equivalent to the type="%..." notion for
the <xref > element. Instead, there is what i would call a lot of built-in magic to
create the non-configurable derivedContent attribute. In result, it is impossible to
create an IMHO good reference text such as "See Section 3.2 Bullet 1.2 on page 20"

And of course, whether or not that rather long reference text is appropriate or not
IMHO highly depends on what you are rendering for: If you are rendering with hotlinks
it is likely not ideal (but still fine), but if you are rendering for paper printout,
then IMHO you really want to have this much information to quickly locate the referenced
location in a stack of printed paper. And i quite rankly always like rendering that work
for any output (aka: above example reference text that also is a hotlink).

So, maybe if we are talking about language extensions, then maybe this could be
considered to be rendering hints or the like. 

Cheers
    toerless
> 
> 
> -- 
> Reply to this email directly or view it on GitHub:
> https://github.com/interim-rfc-series-project-manager/draft-irse-xml2rfc-changes/issues/1#issuecomment-1259679973
> You are receiving this because you authored the thread.
> 
> Message ID: <interim-rfc-series-project-manager/draft-irse-xml2rfc-changes/issues/1/[e-mail]>

-- 
---
[e-mail]