This is the mail archive of the
docbook@lists.oasis-open.org
mailing list for the DocBook project.
Re: [docbook] Automatically create index of commands
Bob McIlvride <robert@cogent.ca> writes:
> It might not be the easiest route, but I think the way to do it is
> to use the <reference> and <refentry> tags in DocBook. Each command
> would become a <refentry>, and you could then group common commands
> within specific <reference>s, each with its own title. For example,
> we do this for functions in our "Gamma Manual", as seen here:
> http://developers.cogentrts.com/cogent/cogentdocs/bookgam.html#id2853566
> (scroll down about 1/2 way)
Interesting looking language:-)
> The way to get a short description is to put a <refnamediv> in each
> <refentry>, with a <refpurpose> to hold the description.
> The output for all this does not appear in the index, as you have
> requested, but rather in the table of contents. However, you can
> also auto-generate an index where everything is organized strictly
> alphabetically, which appears at the back of the book. Thus you get
> the best of both worlds. To my understanding, most technical
> manuals are organized in this way.
Hrm... I had really hoped to get an index on the same page as the
commands. I don't have enough, yet, to break them all out into
separate pages. Is the ref stuff still appropriate in that case?
In any case I'm pretty sure I also want the index either on the same
page or a second page, but not in the table of contents. I guess it's
time to start hitting the XSL file.
In any case, thankyou for your time and the suggestions!
--
David N. Welton
Consulting: http://www.dedasys.com/
Personal: http://www.dedasys.com/davidw/
Free Software: http://www.dedasys.com/freesoftware/
Apache Tcl: http://tcl.apache.org/
To unsubscribe from this list, send a post to docbook-unsubscribe@lists.oasis-open.org.