[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: INFO on add-ons
From: |
Miles Bader |
Subject: |
Re: INFO on add-ons |
Date: |
Wed, 4 Sep 2002 09:34:35 -0400 |
User-agent: |
Mutt/1.3.28i |
On Wed, Sep 04, 2002 at 03:20:05PM +0200, Eli Zaretskii wrote:
> > Sure, but since the `automatic' step I was talking was transforming
> > doc-strings/comments -> info nodes, embedding such commands would avoid
> > the problem of automatic index generation.
>
> Yes, but that means we need to go over all the doc strings and add the
> indexing commands. A lot of work.
It hardly matters -- for commands that are not already documented in info, it
would have to be done anyway, and would be no more work that doing the same
for a texinfo doc. For commands tha _are_ documented we've already got a
source of indexing information: the info docs!
[but since I'm talking about this in the context of producing documentation
for currently undocumented code, I presume mostly it would be the former]
In any case, I think you're overemphasizing the importance and difficulty of
indexing just a wee bit; after all, programming reference documentation is
different in many ways than documents in general (it's much more regular, for
one thing), and the _most_ important index entries (the commands and
functions being documented) probably _can_ be generated automatically.
-Miles
--
P.S. All information contained in the above letter is false,
for reasons of military security.
- Re: INFO on add-ons, (continued)
- Re: INFO on add-ons, Alex Schroeder, 2002/09/01
- Re: INFO on add-ons, David A. Cobb, 2002/09/02
- Re: INFO on add-ons, Alex Schroeder, 2002/09/03
- Re: INFO on add-ons, Alex Schroeder, 2002/09/03
- Re: INFO on add-ons, Miles Bader, 2002/09/03
- Re: INFO on add-ons, Eli Zaretskii, 2002/09/04
- Re: INFO on add-ons, Miles Bader, 2002/09/04
- Re: INFO on add-ons, Eli Zaretskii, 2002/09/04
- Re: INFO on add-ons, Miles Bader, 2002/09/04
- Re: INFO on add-ons, Eli Zaretskii, 2002/09/04
- Re: INFO on add-ons,
Miles Bader <=
- Re: INFO on add-ons, Eli Zaretskii, 2002/09/05
- Re: INFO on add-ons, Valdis . Kletnieks, 2002/09/05
- Re: INFO on add-ons, Robert J. Chassell, 2002/09/05
- Re: INFO on add-ons, Alex Schroeder, 2002/09/04
- Re: INFO on add-ons, Richard Stallman, 2002/09/04
- Re: INFO on add-ons, Pavel JanÃk, 2002/09/07
- Re: INFO on add-ons, Eli Zaretskii, 2002/09/04
- Re: INFO on add-ons, Robert J. Chassell, 2002/09/04
- Re: INFO on add-ons, Eli Zaretskii, 2002/09/04
Re: INFO on add-ons, Stephen J. Turnbull, 2002/09/01