X-Scanned-BY: MIMEDefang 2.68 on 10.5.11.27 MIME-Version: 1.0 In-Reply-To: X-Spam-Status: No, score=-2.5 required=5.0 tests=BAYES_00,RP_MATCHES_RCVD autolearn=ham autolearn_force=no version=3.4.0 References: <5343D797.6070006@redhat.com> Message-ID: <5343EF63.5020608@redhat.com> Content-Type: text/plain; charset=UTF-8; format=flowed Organization: Red Hat X-RT-Original-Encoding: utf-8 Received: from mx.ams1.isc.org (mx.ams1.isc.org [199.6.1.65]) by bugs.isc.org (Postfix) with ESMTP id 1B0E22D20051 for ; Tue, 8 Apr 2014 12:45:41 +0000 (UTC) Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.ams1.isc.org (Postfix) with ESMTP id CF01D2383CF for ; Tue, 8 Apr 2014 12:45:28 +0000 (UTC) (envelope-from pspacek@redhat.com) Received: from int-mx14.intmail.prod.int.phx2.redhat.com (int-mx14.intmail.prod.int.phx2.redhat.com [10.5.11.27]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id s38CjQOs026119 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Tue, 8 Apr 2014 08:45:26 -0400 Received: from pspacek.brq.redhat.com (vpn1-6-167.ams2.redhat.com [10.36.6.167]) by int-mx14.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id s38CjNIm031962 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES128-SHA bits=128 verify=NO) for ; Tue, 8 Apr 2014 08:45:25 -0400 Delivered-To: bind-suggest@bugs.isc.org Subject: Re: [ISC-Bugs #35713] permanent href targets in HTML documentation User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:24.0) Gecko/20100101 Thunderbird/24.4.0 Return-Path: X-Original-To: bind-suggest@bugs.isc.org Date: Tue, 08 Apr 2014 14:45:23 +0200 X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on mx.ams1.isc.org To: bind-suggest@isc.org Content-Transfer-Encoding: 7bit From: Petr Spacek RT-Message-ID: Content-Length: 2473 On 8.4.2014 14:37, Chuck Aurora via RT wrote: > On 04/08/2014 06:04 AM, Petr Spacek via RT wrote: >> Ticket > >> I would like to propose small improvement for your BIND ARM in HTML: >> >> It would be great if sections and commands had some stable names in > name="something"> tag. >> >> Currently the HTML looks like: >> >>
>>

>> Forwarding

>>

>> The forwarding facility can be used to create a large site-wide >> >> Unfortunately, it seems that "id2583370" changes between versions so it >> is not possible to create truly permanent link to it. >> >> It would be really handy to create links like: >> http://ftp.isc.org/isc/bind9/cur/9.9/doc/arm/Bv9ARM.ch06.html#id2583370 > > Permanent links are good, but permanent links with sensible names are > much better. > >> Link targets like >> #sec-forwarding >> #option-forward >> #option-forwarders >> >> would be really great. > > Yes, you're right. This is already under consideration. I myself made > a similar proposal, like the latter one (where all anchor names would > be human readable and make sense.) > > There are macros involved; the same docbook/XML source is used to > create all versions of the ARM, not just the HTML. > >> Thank you for your time. > > Thank you for the suggestion, and yes, time is what it will require. > Right now I'm unable to give you a target date for completion, but > please be assured that this is a long-term project goal. Those > projects have to compete with (and usually lose out to) day-to-day > work like customer support and development / bug fixes. I understand you, sure, time is always a problem. Maybe I can send you some patches if you are willing to accept them. Note that I'm not saying that I will add nice names to all commands/options/sections in the ARM. However I can add names to sections I'm interested in as I go over them. For this, it would be nice to have something like nightly build of docs so I can send you a patch and use the link with nice name the next day or something like that. I'm not going to send you docs patches if I have to wait months to see the nice link on an server because I will have to use the ugly name or copy the text anyway. I'm looking forward for further cooperation on this. Have a nice day! -- Petr Spacek @ Red Hat