Re: [Xml-sg-cmt] index question

Peter Saint-Andre <stpeter@mozilla.com> Fri, 12 March 2021 22:36 UTC

Return-Path: <stpeter@mozilla.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 3230C3A1732 for <xml-sg-cmt@ietfa.amsl.com>; Fri, 12 Mar 2021 14:36:53 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.1
X-Spam-Level:
X-Spam-Status: No, score=-2.1 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=mozilla.com
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 TNoSgHNurujE for <xml-sg-cmt@ietfa.amsl.com>; Fri, 12 Mar 2021 14:36:51 -0800 (PST)
Received: from mail-io1-xd2d.google.com (mail-io1-xd2d.google.com [IPv6:2607:f8b0:4864:20::d2d]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id A60863A1731 for <xml-sg-cmt@ietf.org>; Fri, 12 Mar 2021 14:36:51 -0800 (PST)
Received: by mail-io1-xd2d.google.com with SMTP id y20so9093224iot.4 for <xml-sg-cmt@ietf.org>; Fri, 12 Mar 2021 14:36:51 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mozilla.com; s=google; h=subject:to:references:from:message-id:date:user-agent:mime-version :in-reply-to:content-language:content-transfer-encoding; bh=4sH8/zHAk6qg/BX7+RdBmHYLkQsk4O4dgeqxcywIW7I=; b=O2u3Fo5HFh29yflt1HRCbg/1ICnVrAWUwF5ghBEaCC4ffoS0cb3YiJ0HQEtaIdbWtO MnjmLdOCh7PoqCHB5MZ8hGUf/Tidy54+4IFgwLxYeRlYKu3GA0g0YG2zbCjzQCJYru3n lFCmfHVQxgHEkJ5HNZ5+LOaLT6EacJYsIOw6g=
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:to:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=4sH8/zHAk6qg/BX7+RdBmHYLkQsk4O4dgeqxcywIW7I=; b=UOAEbAMNpPkZSgHTzFwyYkBU8kr+NXoedBAsPNIudIFOuiYjrw+AwS6DsBk1isNR/Y ikwjT+f0Fk49alBz6Y9GTfaReSAOC+YYYMQy8IkuSM5I67Mpz1mzH11yrWGKPzkdEOz6 QiFhk6dVYJoOp+WlSapYwZvwEgdSTRl1RCr597v4HoD/ixnk1hhKPPJRJniwCsizdVBY /sVMBOj3zsbu2GflADbPZO9iaXfg79ojbrZH0es/b15obDtrr37ux7X+v1jSAr+EZIsr JsD4t9Utkz19FrK8Z8zcG5LSGFAqloocLuiok16NVKQkVrKyO+abKL1vEZ7eHISPlKOS P7+A==
X-Gm-Message-State: AOAM533Px+kc8DpSD25oYwrKopOnWt/jhstT8/S0zR/TAwOcIn6y+BsL CAivxKcvwibGakZAX5KU7YziDA==
X-Google-Smtp-Source: ABdhPJzCL30XH5EBoeZThYvRkhNPJ7eUBhGT6YcxjXnseU4tJnkyVNyOcwrCvstuv8+q3pY6txYMcw==
X-Received: by 2002:a5e:8e41:: with SMTP id r1mr1049188ioo.5.1615588610203; Fri, 12 Mar 2021 14:36:50 -0800 (PST)
Received: from dragon.local ([76.25.3.152]) by smtp.gmail.com with ESMTPSA id i2sm2031755ilv.57.2021.03.12.14.36.49 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 12 Mar 2021 14:36:49 -0800 (PST)
To: Sandy Ginoza <sginoza@amsl.com>, XML weed whackers <xml-sg-cmt@ietf.org>
References: <7133140B-73BE-4301-8AD8-7A085994AA15@amsl.com>
From: Peter Saint-Andre <stpeter@mozilla.com>
Message-ID: <feb5cbac-1244-925f-eeca-9b4cd0a68f63@mozilla.com>
Date: Fri, 12 Mar 2021 15:36:48 -0700
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.16; rv:78.0) Gecko/20100101 Thunderbird/78.8.0
MIME-Version: 1.0
In-Reply-To: <7133140B-73BE-4301-8AD8-7A085994AA15@amsl.com>
Content-Type: text/plain; charset="utf-8"
Content-Language: en-US
Content-Transfer-Encoding: 8bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/xml-sg-cmt/M5KPar79jyEKwLEuBgoI2wjHwIc>
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: Fri, 12 Mar 2021 22:36:53 -0000

Hi Sandy!

On 3/12/21 3:24 PM, Sandy Ginoza 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.  

Yes, that seems off - we'd want one instance but linked.

> 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.  

Naturally we can't include links in the TXT files, but page numbers are
essential. :-)

> c) The index does not appear in the toc; I’ll file a ticket for this. 

Thanks.

Peter