Re: [Xml-sg-cmt] index question

Alice Russo <arusso@amsl.com> Tue, 23 March 2021 21:37 UTC

Return-Path: <arusso@amsl.com>
X-Original-To: xml-sg-cmt@ietfa.amsl.com
Delivered-To: xml-sg-cmt@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 6FC893A1746 for <xml-sg-cmt@ietfa.amsl.com>; Tue, 23 Mar 2021 14:37:35 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 4NCDwcCHWxXQ for <xml-sg-cmt@ietfa.amsl.com>; Tue, 23 Mar 2021 14:37:30 -0700 (PDT)
Received: from mail.amsl.com (c8a.amsl.com [4.31.198.40]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 9CD433A1744 for <xml-sg-cmt@ietf.org>; Tue, 23 Mar 2021 14:37:29 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id 00AC4389EF2 for <xml-sg-cmt@ietf.org>; Tue, 23 Mar 2021 14:37:29 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from c8a.amsl.com ([127.0.0.1]) by localhost (c8a.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 6GRmNCpF-5qH for <xml-sg-cmt@ietf.org>; Tue, 23 Mar 2021 14:37:28 -0700 (PDT)
Received: from [IPv6:2601:602:8501:8b10:54b:b423:91a5:b94f] (unknown [IPv6:2601:602:8501:8b10:54b:b423:91a5:b94f]) by c8a.amsl.com (Postfix) with ESMTPSA id D58A5389ED4 for <xml-sg-cmt@ietf.org>; Tue, 23 Mar 2021 14:37:28 -0700 (PDT)
From: Alice Russo <arusso@amsl.com>
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\))
Date: Tue, 23 Mar 2021 14:37:27 -0700
References: <7133140B-73BE-4301-8AD8-7A085994AA15@amsl.com>
To: XML weed whackers <xml-sg-cmt@ietf.org>
In-Reply-To: <7133140B-73BE-4301-8AD8-7A085994AA15@amsl.com>
Message-Id: <F05450CC-E0E2-4A6D-8964-8F442A8FF8E3@amsl.com>
X-Mailer: Apple Mail (2.3273)
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml-sg-cmt/Qt_iuyuv1zC-ueI2GHrQfmd-vbw>
Subject: Re: [Xml-sg-cmt] index question
X-BeenThere: xml-sg-cmt@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Working list for the xml and style guide change management team <xml-sg-cmt.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/xml-sg-cmt>, <mailto:xml-sg-cmt-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/xml-sg-cmt/>
List-Post: <mailto:xml-sg-cmt@ietf.org>
List-Help: <mailto:xml-sg-cmt-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/xml-sg-cmt>, <mailto:xml-sg-cmt-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 23 Mar 2021 21:37:35 -0000

Hi, 
Just an update here regarding item b below (index in the text output) -- relevant ticket: https://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/610

Please speak up if you have any objection to the proposal in comment 3. Essentially, it is to use the section number (in all 3 formats) -- without the word "Section".  And for HTML & PDF that section number is a link to the exact location of the iref (so it could be a paragraph-specific link).

For example:

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

Proposal from Jennifer:
   T
      TEXT (part specifier)  6.4.5.1
      TEXT <string> (search key)  6.4.4
      TO <string> (search key)  6.4.4
      TRYCREATE (response code)  7.1

where "6.4.5.1" would be a paragraph-specific link to 
rfcNNNN.html#section-6.4.5.1-5
(Example: https://www.rfc-editor.org/v3test/test-index-ietf-extra-imap4rev2-30.html#section-6.4.5.1-5)

Thanks,
Alice

> On Mar 12, 2021, at 2:24 PM, Sandy Ginoza <sginoza@amsl.com> wrote:
> 
> Hi team,
> 
> draft-ietf-extra-imap4rev2-30, which is currently in our queue, contains an index.  As noted in ticket 603, xml2rfc crashes when making the PDF file.  Temporarily, we have removed “$” from the <iref>s so we’re able to create the PDF.  
> 
>   https://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/603
> 
> Please note I changed the priority of 603 to critical (it’s not yet a blocker).
> We also see <https://trac.tools.ietf.org/tools/xml2rfc/trac/ticket/418> related to index.
> 
> Looking at the index in the output files, we have a few questions/comments.  See
> https://www.rfc-editor.org/rfc/v3test/test-index-ietf-extra-imap4rev2-30.html#name-index
> 
> a) Does the index look as expected?  The terms appear twice, once as text and once as a link.  
> 
> b) In the text, the index is formatted differently.  Also, I think the index needs to be present so the content in the various outputs is the same, but the index is essentially useless because there are no links and no page numbers.  
> 
> c) The index does not appear in the toc; I’ll file a ticket for this. 
> 
> 
> Partially formatted v3 files are here: 
> 
> https://www.rfc-editor.org/rfc/v3test/test-index-ietf-extra-imap4rev2-30.html
> https://www.rfc-editor.org/rfc/v3test/test-index-ietf-extra-imap4rev2-30.pdf
> https://www.rfc-editor.org/rfc/v3test/test-index-ietf-extra-imap4rev2-30.txt
> https://www.rfc-editor.org/rfc/v3test/test-index-ietf-extra-imap4rev2-30.xml
> 
> 
> Thanks,
> Sandy
> 
> 
> -- 
> Xml-sg-cmt mailing list
> Xml-sg-cmt@ietf.org
> https://www.ietf.org/mailman/listinfo/xml-sg-cmt