improve index in text output (when unpaginated)

[ietf-svn-bot]

owner:jennifer@painless-security.com resolution_fixed type_defect | by arusso@amsl.com

---

In the index of the I-D, each item is listed with its page number. Since text output for RFCs is unpaginated, add another reference point, e.g., section number.

I-D (draft-ietf-extra-imap4rev2-30.txt) contained:

   T
      TEXT (part specifier)  95
      TEXT <string> (search key)  84
      TO <string> (search key)  84
      TRYCREATE (response code)  111

Perhaps (with section numbers):

   T
      TEXT (part specifier)  Section 6.4.5.1
      TEXT <string> (search key)  Section 6.4.4
      TO <string> (search key)  Section 6.4.4
      TRYCREATE (response code)  Section 7.1

---

Issue migrated from trac:610 at 2022-02-08 07:13:40 +0000

[ietf-svn-bot]

@julian.reschke@gmx.de commented

---

Yes, but I would leave out the word "Section".

[ietf-svn-bot]

@jennifer@painless-security.com changed status from new to assigned

[ietf-svn-bot]

@jennifer@painless-security.com changed owner from `` to jennifer@painless-security.com

[ietf-svn-bot]

@jennifer@painless-security.com commented

---

I've been working on this in tandem with issue #418 and am nearing a fix. It would be helpful to get some feedback on formatting. As an example, for this input:

<rfc category="std" docName="sample" ipr="trust200902" version="3">
    <front>
        <title>Indexing Test</title>
        <author initials='A.Y.' surname="Mous" fullname='Anon Y. Mous'>
            <organization/>
        </author>
        <date/>
        <abstract>
            <t>Examples for iref/index.</t>
        </abstract>
    </front>
    <middle>
        <section>
            <name>Top Level Section</name>
            <section>
                <name>Test 1</name>
                <iref item="Simple Item" primary="true"/>
                <iref item="Parent Item"/>
            </section>
            <section>
                <name>Test 2</name>
                <iref item="Simple Item"/>
                <iref item="Parent Item" subitem="Child A"/>
            </section>
            <section>
                <name>Test 3</name>
                <iref item="Simple Item"/>
                <iref item="Parent Item" subitem="Child B"/>
            </section>
            <section>
                <name>Test 4</name>
                <iref item="Simple Item"/>
                <iref item="Parent Item" subitem="Child A"/>
            </section>
        </section>
    </middle>
    <back/>
</rfc>

I am currently generating a text-mode index that looks like:

Index

   P S

      P

         Parent Item  1.1
            Child A  1.2, 1.4
            Child B  1.3

      S

         Simple Item  1.1, 1.2, 1.3, 1.4

The HTML output is essentially identical, with the section numbers linked to the section/paragraph where the index term appears.

Thoughts?

[ietf-svn-bot]

@julian.reschke@gmx.de commented

---

Looks exactly right to me.

[ietf-svn-bot]

@arusso@amsl.com commented

---

Looks fine to me.

[ietf-svn-bot]

@jennifer@painless-security.com changed status from assigned to closed

[ietf-svn-bot]

@jennifer@painless-security.com changed resolution from `` to fixed

[ietf-svn-bot]

@jennifer@painless-security.com commented

---

Fixed in e830239:

Correctly gather irefs by item/subitem. Improve index rendering. Use section numbers for xref text in index. Fixes #418. Fixes #610. Commit ready for merge.

[ietf-svn-bot]

@rjsparks@nostrum.com commented

---

Fixed in 7aac3e6:

Merged in e830239 from jennifer@painless-security.com:\n Correctly gather irefs by item/subitem. Improve index rendering. Use section numbers for xref text in index. Fixes #418. Fixes #610.