Thread: [Docutils-users] index

Hi,

I was wondering wether an inline markup for indexing words in a reST document
(that would be converted to a latex document, for example) would be
acceptable?

The result one could expect in the latex document would be::

  \index{word}

Thanks in advance,
-- 
Sébastien

On Wed, 22 Oct 2003, [iso-8859-1] S=E9bastien Mengin wrote:

> Hi,
>
> I was wondering wether an inline markup for indexing words in a reST docu=
ment
> (that would be converted to a latex document, for example) would be
> acceptable?
  ^^^^^^^^^^\___ this is the question ? what can you offer, assuming
  the document should stay readable.

  you know that indexes are not always sorted alphabetically
  picking "accelerated c++" index "S" ::

    scope, 5, 44
      operator, 5, 158
    search, 121, 234
    second, 125, 137,320-321

  indexing is a work for a person educated to do it.

  1. how does operator fall under "S".
  2. for sure search will be on other pages too, this is only
     search inside code examples (maybe a transform could respect
     context)
  3. maybe latex recognizes if "second" is on 320 and 321 5 times
     and only prints 320-321.

> The result one could expect in the latex document would be::
>
>   \index{word}

why not use a transform, tell it the list of index-worthable
words, and live with some false positives.

--=20
 BINGO: Support your right to bare arms!  Wear short sleeves!
 --- Engelbert Gruber -------+
  SSG Fintl,Gruber,Lassnig  /
  A6170 Zirl   Innweg 5b   /
  Tel. ++43-5238-93535 ---+

Le jeu 23 oct 03 à 22:03, gr...@us... a écrit:
> > I was wondering wether an inline markup for indexing words in a reST document
> > (that would be converted to a latex document, for example) would be
> > acceptable?
>   ^^^^^^^^^^\___ this is the question ? what can you offer, assuming
>   the document should stay readable.

This is the problem : the more we insert mark up into the document, the
less it stays readable.

Then is it possible to create a list of words (at the begining of the
document?) that would be searched and transformed into \index{word} 
within the rst2latex process ?

>   you know that indexes are not always sorted alphabetically
>   picking "accelerated c++" index "S" ::
> 
>     scope, 5, 44
>       operator, 5, 158
>     search, 121, 234
>     second, 125, 137,320-321
> 
>   indexing is a work for a person educated to do it.
> 
>   1. how does operator fall under "S".
>   2. for sure search will be on other pages too, this is only
>      search inside code examples (maybe a transform could respect
>      context)
>   3. maybe latex recognizes if "second" is on 320 and 321 5 times
>      and only prints 320-321.
> 
> > The result one could expect in the latex document would be::
> >
> >   \index{word}
> 
> why not use a transform, tell it the list of index-worthable
> words, and live with some false positives.

Yes, I would be very interested in such a solution. False positives
would probably be easy to correct.
It could be something like::

  .. index :: bazar, coordinator, group

I will try to look at the code and build a transform.
Will let you know about it.

Thanks !
-- 
Sébastien

Sébastien Mengin wrote:
 > I was wondering wether an inline markup for indexing words in a reST
 > document (that would be converted to a latex document, for example)
 > would be acceptable?

There are some notes about such a construct at
<http://docutils.sf.net/spec/notes.html#body-index>.  It needs
discussion and implementation.

-- 
David Goodger    http://starship.python.net/~goodger
For hire: http://starship.python.net/~goodger/cv
Docutils: http://docutils.sourceforge.net/
(includes reStructuredText: http://docutils.sf.net/rst.html)