docbook: index generation
Subject:
Re: index generation
From:
Peter Jay Salzman ####@####.####
Date:
2 Apr 2003 17:45:52 -0000
Message-Id: <20030402174549.GA30905@dirac.org>
hi greg et al,
ok, first an apology. i didn't know about the mailing list search, but
i do now. :) anyway, i'm getting an error. here's a snippet of the
makefile:
STYLE='/usr/share/sgml/docbook/stylesheet/dsssl/modular/html/ldp.dsl'
TARGET=lkmpg
all:
collateindex.pl -N -o index.sgml
jade -t sgml -V html-index -d ${STYLE} ${TARGET}.sgml
at this point (the invocation of jade), i get an error:
jade:index.sgml:1:6:E: document type does not allow element "INDEX" here
jade:lkmpg.sgml:96:85:E: end tag for "APPENDIX" which is not finished
index.html contains (in its entirety):
<index>
<!-- This file was produced by collateindex.pl. -->
<!-- Remove this comment if you edit this file by hand! -->
</index>
lkmpg.sgml (the relevent portion) contains:
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!ENTITY TheIndex SYSTEM "index.sgml">
]>
<book>
blah blah blah
<appendix><title>Changes: 2.0 To 2.2 </title>&Changes20-22;</appendix>
<appendix><title>Where To Go From Here</title>&WhereFromHere;</appendix>
<appendix><title>Index </title>&TheIndex;</appendix>
</book>
i *suspect* the problem is related to the fact that this is a <book> and
not an <article>. i've tried looking at the other guides, and AFAICS,
none of them have an index.
is there anything special that <book>'s need to do for index creation?
pete
begin Greg Ferguson ####@####.####
> On Tue, 1 Apr 2003 16:29:37 -0800 Peter Jay Salzman ####@####.#### wrote:
>
> > hello,
> >
> > i'm the maintainer of the linux kernel module programming guide (lkmpg),
> > and noticed awhile back that no index is being generous, despite the
> > fact that the lkmpg is sprinkled liberally with <indexterm> tags.
> >
> > can someone tell me what i need to do to generate an index of terms?
> >
> > thanks!
> > pete
> >
>
> (from earlier ####@####.#### post...)
>
> To create indexes:
>
> 1. Add <indexterm> references into your SGML file (I'm not going
> into detail, that's covered in the LDP Author Guide)
>
> 2. Add an entity reference in your main SGML file:
>
> <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
> <!ENTITY myindex SYSTEM "index.sgml">
> ..
> ]>
>
> 3. Include/reference the entity at the end of the file/document (or
> wherever you wish to have the index occur):
>
> &myindex;
>
> </article>
>
> 3. Now run the the tools to generate the index:
>
> collateindex.pl -N -o index.sgml
> jade -t sgml -V html-index -d <style> My-HOWTO.sgml
> collateindex.pl -g -t Index -i doc-index -o index.sgml HTML.index
>
> You will now have a index.sgml file which can be used in conjunction
> with the "normal" run of the tools (which you use to produce your
> HTML files, etc). This should work ok with XML files as well (adjust
> your file extensions in the examples shown above!).
>
> For an example, see IBM7248-HOWTO - http://tldp.org/HOWTO/IBM7248-HOWTO/
> You can also get the source to examine from our CVS (web) tree.
--
Fingerprint: B9F1 6CF3 47C4 7CD8 D33E 70A9 A3B9 1945 67EA 951D
