find "Abstract" and make it a link target "#abstract" (fixes #24)

[reschke]

No description provided.

[larseggert]

The syntax needs to be fixed to avoid deprecation warning. See how similar regexes now look on main.

Also, might want to handle these sections as well, for parity with what the HTML format has:

• About This Document
• Note to the RFC Editor
• Status of This Memo
• Copyright Notice
• Table of Contents

[reschke]

Is the deprecation related to not using the Raw String Notation? In which case it's fixed now.

Regarding the other sections; I'll check. They may have no explicit anchor assigned by xml2rfc (except for the implied "n-...", which I believe we should not rely on). So this might require changes in xml2rfc as well.

[larseggert]

Datatracker says:

/home/dev/.local/lib/python3.9/site-packages/rfc2html.py:282: DeprecationWarning: invalid escape sequence \g  text = re.sub(r"(?m)^(\s*)(Abstract)$", """\g<1><a id="abstract" href="#abstract" class="selflink">\g<2></a>""", text, count=1)
/home/dev/.local/lib/python3.9/site-packages/rfc2html.py:283: DeprecationWarning: invalid escape sequence \g
  text = re.sub(r"(?m)^(\s*)(Table of Contents)$", """\g<1><a id="table-of-contents" href="#table-of-contents" class="selflink">\g<2></a>""", text, count=1)

[larseggert]

You also need to wrap this in h2 if you want it to be picked up by the table of contents generator.

[reschke]

FWIW, the whole code uses the deprecated notation. The changes are consistent with the existing code,

Wouldn't it make sense to separate these kinds of changes into separate tickets, and to apply the changes to the complete codebase?

[reschke]

You also need to wrap this in h2 if you want it to be picked up by the table of contents generator.

That may make sense, but then this should be done uniformly through the whole codebase, no?

[reschke]

The syntax needs to be fixed to avoid deprecation warning. See how similar regexes now look on main.

Also, might want to handle these sections as well, for parity with what the HTML format has:

* About This Document

* Note to the RFC Editor

* Status of This Memo

* Copyright Notice

* Table of Contents

Agreed. Let's see what xml2rfc currently generates:

apparently hard-wired and could be relied on

• "Abstract" - "#abstract"

under author's control

• "Note to the RFC Editor": this is a standard <note> where the author controls the anchor; there are no heuristics to find out what the author used - also irrelevant for RFCs

getting auto-generated anchors based on text contents

• "About This Document": "#name-about-this-document" (auto-generation for identifiers that have not been specified otherwise) - also irrelevant for RFCs
• "Status of This Memo" - "#name-status-of-this-memo" (auto-generation for identifiers that have not been specified otherwise)
• "Copyright Notice" - "#name-status-of-this-memo" (auto-generation for identifiers that have not been specified otherwise)
• "Table of Contents" - "#name-table-of-contents" (auto-generation for identifiers that have not been specified otherwise)
• "Index" - "#name-index" (auto-generation for identifiers that have not been specified otherwise)
• "Author's Addresses" - "#name-authors-addresses" (auto-generation for identifiers that have not been specified otherwise)

Proposal

Stick with the change for "abstract" for now. Raise issues for xml2rfc to generate stable anchors for the other sections, and once they are agreed upon, generate them here as well.

[larseggert]

FWIW, the whole code uses the deprecated notation. The changes are consistent with the existing code,

Are you sure you are up to date with main?

[reschke]

FWIW, the whole code uses the deprecated notation. The changes are consistent with the existing code,

Are you sure you are up to date with main?

Likely not. Will check.

[larseggert]

LGTM but the RPC should check whether this works for them as well.

[rjsparks]

@reschke - just rediscovered this request - it fell through the cracks, apologies. will vet with the RPC.