gnuplot-beta

auto-generate index for documentation

[Ethan M. <merritt@u.washington.edu>]

I've uploaded a patch to SourceForge (#1192870) that modifies
the generation of gnuplot.tex from .../docs/Makefile.
It uses the makeindex utility to create an index, which then
propagates into the TeX-derived documenation (dvi, PostScript, pdf).

Please report any problems.
For instance, is makeindex universally distributed with TeX?

Also please suggest procedures for identifying what keywords
in the documentation are worth adding to the index.  Right now
it's fully automated, but doesn't catch everything it should.

-- 
Ethan A Merritt
Biomolecular Structure Center
University of Washington 98195-7742

Re: auto-generate index for documentation

[Harald H. <h.h...@tu...>]

On Fri, 29 Apr 2005, Ethan Merritt wrote:

> For instance, is makeindex universally distributed with TeX?

Yes.

> Also please suggest procedures for identifying what keywords
> in the documentation are worth adding to the index.  Right now
> it's fully automated, but doesn't catch everything it should.

Maybe, we could introduce something like "\(word to index\)" then indexes
the thinks between \( and \). In my opinion, the indexed text should not
appear in the text itself because both can differ (due to plural,
genitive, etc.).

Best regards
Harald

-- 
Harald Harders
h.h...@tu...
http://www.harald-harders.de

Re: auto-generate index for documentation

[Petr M. <mi...@ph...>]

> I've uploaded a patch to SourceForge (#1192870) that modifies
> the generation of gnuplot.tex from .../docs/Makefile.
> It uses the makeindex utility to create an index, which then
> propagates into the TeX-derived documenation (dvi, PostScript, pdf).

That's good idea. The TeX docs gets the same index as those "hypertext" help
viewers.

---
PM

Re: auto-generate index for documentation

[Juergen W. <wie...@fr...>]

On Saturday 30 April 2005 07:33, Ethan Merritt wrote:
> I've uploaded a patch to SourceForge (#1192870) that modifies
> the generation of gnuplot.tex from .../docs/Makefile.
> It uses the makeindex utility to create an index, which then
> propagates into the TeX-derived documenation (dvi, PostScript, pdf).
>
> Please report any problems.
> For instance, is makeindex universally distributed with TeX?
>
> Also please suggest procedures for identifying what keywords
> in the documentation are worth adding to the index.  Right now
> it's fully automated, but doesn't catch everything it should.

I really like it.  But I'm not sure if also the cross references
should lead to an index entry.  It lessens the value of an average
index reference.

The possibility to explicitly specify an index entry is a good
thing.  The attached patch includes these entries in gnuplot.info.


Juergen