Re: [bind-users] Re: BIND9-ARM (HTML) feature request: better hyperlinking in/of chapter 6
On Sun, May 10, 2015 at 02:39:04AM +, Evan Hunt wrote: On Sat, May 09, 2015 at 04:56:08PM -0500, Jerry K wrote: Was going thru some old messages, and came across this one about generating the ARM doc as HTML. Just wondering if anything ever became of it? The ARM is generated as HTML now, but the request in that thread was to add better anchor tags for each option, so you could look up Bv9ARM.ch06.html#response-policy or whatever, and be taken to the corresponding section of the ARM. Good idea, nobody's done it yet. Oops, sorry. When I suggested it I was unemployed, and now [thankfully] am not. $Dayjob keeps me busy, but now I have more clue about the docbook, so I'll try to do what I can. -- http://rob0.nodns4.us/ Offlist GMX mail is seen only if /dev/rob0 is in the Subject: ___ Please visit https://lists.isc.org/mailman/listinfo/bind-users to unsubscribe from this list bind-users mailing list bind-users@lists.isc.org https://lists.isc.org/mailman/listinfo/bind-users
Re: [bind-users] Re: BIND9-ARM (HTML) feature request: better hyperlinking in/of chapter 6
On Sat, May 09, 2015 at 04:56:08PM -0500, Jerry K wrote: Was going thru some old messages, and came across this one about generating the ARM doc as HTML. Just wondering if anything ever became of it? The ARM is generated as HTML now, but the request in that thread was to add better anchor tags for each option, so you could look up Bv9ARM.ch06.html#response-policy or whatever, and be taken to the corresponding section of the ARM. Good idea, nobody's done it yet. -- Evan Hunt -- e...@isc.org Internet Systems Consortium, Inc. ___ Please visit https://lists.isc.org/mailman/listinfo/bind-users to unsubscribe from this list bind-users mailing list bind-users@lists.isc.org https://lists.isc.org/mailman/listinfo/bind-users
Re: [bind-users] Re: BIND9-ARM (HTML) feature request: better hyperlinking in/of chapter 6
Was going thru some old messages, and came across this one about generating the ARM doc as HTML. Just wondering if anything ever became of it? Jerry Kemp On 11/20/13 03:43 PM, Evan Hunt wrote: On Wed, Nov 20, 2013 at 03:27:59PM -0600, /dev/rob0 wrote: Looking at the HTML source for the Table of Contents, it seems like someone had this idea before but didn't follow through. There are numerous links to plain-language anchors amidst mostly the id25x anchor names. (These probably had something to do with the DocBook XSL Stylesheets V1.71.1 generator.) Note that the HTML isn't the source, it's generated from doc/arm/Bv9ARM-book.xml and from the various .docbook files throughout the source tree. I might try to work on this myself, but I thought I should toss the idea out for comments and suggestions first. Specifically, I suppose that whatever work that is done should be compatible with the DocBook source and other BIND9-ARM formats. We'd certainly be glad to have help with it. ___ Please visit https://lists.isc.org/mailman/listinfo/bind-users to unsubscribe from this list bind-users mailing list bind-users@lists.isc.org https://lists.isc.org/mailman/listinfo/bind-users
Re: [bind-users] Re: BIND9-ARM (HTML) feature request: better hyperlinking in/of chapter 6
Hi Jerry On Sat, May 09, 2015 at 04:56:08PM -0500, Jerry K wrote: Was going thru some old messages, and came across this one about generating the ARM doc as HTML. Just wondering if anything ever became of it? Is this what you want: http://ftp.isc.org/isc/bind9/cur/9.10/doc/arm/Bv9ARM.html You may also find it bundled with your operating system's BIND package, such as on RHEL, CentOS and Fedora where it can be found at: /usr/share/doc/bind/Bv9ARM.html Mukund pgpjV5HS1fp96.pgp Description: PGP signature ___ Please visit https://lists.isc.org/mailman/listinfo/bind-users to unsubscribe from this list bind-users mailing list bind-users@lists.isc.org https://lists.isc.org/mailman/listinfo/bind-users
Re: BIND9-ARM (HTML) feature request: better hyperlinking in/of chapter 6
So does this mean there could be a Kindle edition of it? Having impulsively snapped up a new Kindle Paperwhite (2nd Gen) for $19 (WiFi only), when I originally had no plans to do so...since I had only jumped in on using the first gen Kindle Paperwhite 3G a few months ago (before that I had a Kindle 2.) I sent the PDF to my Kindle once don't even want to think about it even if I'm in a bind. Though I had at one time thought about trying to read it cover to cover On 2013-11-21 09:14, /dev/rob0 wrote: On Wed, Nov 20, 2013 at 09:43:40PM +, Evan Hunt wrote: On Wed, Nov 20, 2013 at 03:27:59PM -0600, /dev/rob0 wrote: Looking at the HTML source for the Table of Contents, it seems like someone had this idea before but didn't follow through. There are numerous links to plain-language anchors amidst mostly the id25x anchor names. (These probably had something to do with the DocBook XSL Stylesheets V1.71.1 generator.) Note that the HTML isn't the source, it's generated from doc/arm/Bv9ARM-book.xml and from the various .docbook files throughout the source tree. Right, I figured. It seems that I might add id tag modifiers to various sectX and command and optional tags, and that would at least create the anchors. The daunting part is that I'm not sure what this will do: command id=some-named.conf-settingsome-named.conf-setting /command ... See xref linkend=some-named.conf-setting/ ... because at this point, it looks like the only anchors are in section headers. Perhaps more code will have to be added to properly deal with these links? Or is there some other xref modifier which would do it? (I suppose I can try it and see what happens.) I might try to work on this myself, but I thought I should toss the idea out for comments and suggestions first. Specifically, I suppose that whatever work that is done should be compatible with the DocBook source and other BIND9-ARM formats. We'd certainly be glad to have help with it. hehe, oops, I guess I'm committed now :) -- Who: Lawrence K. Chen, P.Eng. - W0LKC - Sr. Unix Systems Administrator For: Enterprise Server Technologies (EST) -- SafeZone Ally ___ Please visit https://lists.isc.org/mailman/listinfo/bind-users to unsubscribe from this list bind-users mailing list bind-users@lists.isc.org https://lists.isc.org/mailman/listinfo/bind-users
Re: BIND9-ARM (HTML) feature request: better hyperlinking in/of chapter 6
On Wed, 20 Nov 2013, /dev/rob0 wrote: Chapter 6 is the comprehensive configuration reference. What I'd like to see is more (and plain-language, consistent) hyperlinking. The basic idea is that any named.conf setting could be found at an anchor: Bv9ARM.ch06.html#that-setting Yes that would be great. We do something similar with the unique log messages for BIND10 and Kea; for example: http://bind10.isc.org/docs/bind10-messages.html#AUTH_XFRIN_CHANNEL_CREATED http://bind10.isc.org/docs/bind10-messages.html#XFROUT_IXFR_NO_ZONE The corresponding docbook code was like: varlistentry id=AUTH_XFRIN_CHANNEL_CREATED ... varlistentry id=XFROUT_IXFR_NO_ZONE This sounds grand and relatively simple, but in practice it will require some thought and work. For example, we have Grammar and Definition and Usage subsections for each Statement section. Which one would we link to? Ideally, both, but we'd have to think about a good anchor naming scheme. I'd say that the name in each Grammar should hyperlink to each Definition and Usage name and vice versa. I had thought about this several times. I published a print book based on the ARM and considered having the grammar for a specific item statement included next to the corresponding documentation -- so you don't have to look in multiple places. Also, what do we do in the case where the same setting is usable in more than one context? Looking at Zone Options, with numerous See the description of ..., this would actually help, because it would take you directly to the setting rather than to the subsection heading. Yes. I did a lot of work on this also, but never made it into the released ARM. By the way, I have found that the maintained dblatex (http://dblatex.sourceforge.net/) framework is easier and more reliable to use than the existing db2latex stylesheets. Hopefully someday I can finish the conversion of our Makefiles to use it instead (or as an alternative). Thank you much for your suggestions and potential work. If you have any questions or need assistance with the PDF/HTML builds, please let me know. (I can also share with you my detailed plans also.) ___ Please visit https://lists.isc.org/mailman/listinfo/bind-users to unsubscribe from this list bind-users mailing list bind-users@lists.isc.org https://lists.isc.org/mailman/listinfo/bind-users
Re: BIND9-ARM (HTML) feature request: better hyperlinking in/of chapter 6
On Wed, Nov 20, 2013 at 09:43:40PM +, Evan Hunt wrote: On Wed, Nov 20, 2013 at 03:27:59PM -0600, /dev/rob0 wrote: Looking at the HTML source for the Table of Contents, it seems like someone had this idea before but didn't follow through. There are numerous links to plain-language anchors amidst mostly the id25x anchor names. (These probably had something to do with the DocBook XSL Stylesheets V1.71.1 generator.) Note that the HTML isn't the source, it's generated from doc/arm/Bv9ARM-book.xml and from the various .docbook files throughout the source tree. Right, I figured. It seems that I might add id tag modifiers to various sectX and command and optional tags, and that would at least create the anchors. The daunting part is that I'm not sure what this will do: command id=some-named.conf-settingsome-named.conf-setting /command ... See xref linkend=some-named.conf-setting/ ... because at this point, it looks like the only anchors are in section headers. Perhaps more code will have to be added to properly deal with these links? Or is there some other xref modifier which would do it? (I suppose I can try it and see what happens.) I might try to work on this myself, but I thought I should toss the idea out for comments and suggestions first. Specifically, I suppose that whatever work that is done should be compatible with the DocBook source and other BIND9-ARM formats. We'd certainly be glad to have help with it. hehe, oops, I guess I'm committed now :) -- http://rob0.nodns4.us/ -- system administration and consulting Offlist GMX mail is seen only if /dev/rob0 is in the Subject: ___ Please visit https://lists.isc.org/mailman/listinfo/bind-users to unsubscribe from this list bind-users mailing list bind-users@lists.isc.org https://lists.isc.org/mailman/listinfo/bind-users
BIND9-ARM (HTML) feature request: better hyperlinking in/of chapter 6
BIND9 is very well documented with the BIND9-ARM. I keep a browser bookmark to it, and I refer to it quite often. I can always find what I am seeking. But, as with most things, improvement is possible. :) Chapter 6 is the comprehensive configuration reference. What I'd like to see is more (and plain-language, consistent) hyperlinking. The basic idea is that any named.conf setting could be found at an anchor: Bv9ARM.ch06.html#that-setting And anywhere that it appears in the ARM, there would be a hyperlink to Bv9ARM.ch06.html#that-setting. Similarly, configuration file elements could be linked as Bv9ARM.ch06.html#that-element. It also would be nice to change the many existing id25x anchor names into plain language names, such that given the URL with anchor, you'd know what to expect. The idea comes from Postfix MTA's superb postconf(5) manual: http://www.postfix.org/postconf.5.html This sounds grand and relatively simple, but in practice it will require some thought and work. For example, we have Grammar and Definition and Usage subsections for each Statement section. Which one would we link to? Ideally, both, but we'd have to think about a good anchor naming scheme. I'd say that the name in each Grammar should hyperlink to each Definition and Usage name and vice versa. Also, what do we do in the case where the same setting is usable in more than one context? Looking at Zone Options, with numerous See the description of ..., this would actually help, because it would take you directly to the setting rather than to the subsection heading. Looking at the HTML source for the Table of Contents, it seems like someone had this idea before but didn't follow through. There are numerous links to plain-language anchors amidst mostly the id25x anchor names. (These probably had something to do with the DocBook XSL Stylesheets V1.71.1 generator.) I might try to work on this myself, but I thought I should toss the idea out for comments and suggestions first. Specifically, I suppose that whatever work that is done should be compatible with the DocBook source and other BIND9-ARM formats. -- http://rob0.nodns4.us/ -- system administration and consulting Offlist GMX mail is seen only if /dev/rob0 is in the Subject: ___ Please visit https://lists.isc.org/mailman/listinfo/bind-users to unsubscribe from this list bind-users mailing list bind-users@lists.isc.org https://lists.isc.org/mailman/listinfo/bind-users
Re: BIND9-ARM (HTML) feature request: better hyperlinking in/of chapter 6
On Wed, Nov 20, 2013 at 03:27:59PM -0600, /dev/rob0 wrote: Looking at the HTML source for the Table of Contents, it seems like someone had this idea before but didn't follow through. There are numerous links to plain-language anchors amidst mostly the id25x anchor names. (These probably had something to do with the DocBook XSL Stylesheets V1.71.1 generator.) Note that the HTML isn't the source, it's generated from doc/arm/Bv9ARM-book.xml and from the various .docbook files throughout the source tree. I might try to work on this myself, but I thought I should toss the idea out for comments and suggestions first. Specifically, I suppose that whatever work that is done should be compatible with the DocBook source and other BIND9-ARM formats. We'd certainly be glad to have help with it. -- Evan Hunt -- e...@isc.org Internet Systems Consortium, Inc. ___ Please visit https://lists.isc.org/mailman/listinfo/bind-users to unsubscribe from this list bind-users mailing list bind-users@lists.isc.org https://lists.isc.org/mailman/listinfo/bind-users
