Re: [Docutils-users] How to add index information

[Alan W. <ala...@li...>]

Hi Günter

Thanks, I do have to admit to being very new to all if this!  Let me restate what I am trying to do which might make it clearer.


  1.  I know Sphinx does not provide the text indexing I want, and the maintainers have no interest in doing that.
  2.  I want to download the reStructuredText for the GitHub repository (done)
  3.  I want to ‘tag’ various words in the text so that those tags can be used by my MadCap Flare documentation system to generate its index (I have code to convert the tagged reST files to the XHTML that Flare requires)
  4.  The tagged rest files end up back in the GitHib repository so that the tags are persistent as the online developers make changes to the online documentation.
  5.  As and example if I have “this is ProductX information” as text and want to use ‘ProductX’ as an index term, then I added the html comments as follows – “this is <!—start -->ProductX<!—end --> information”
  6.  My Flare import routines consume the start/end constructs and create what’s needed.
  7.  When the rest files are put back into the GitHub repository the intention was that they would be ‘just html comments that are ignored’

So that all worked – except for 7 – the tagging appears following the Sphinx/ReadTheDocs process.

I don’t understand your comments re ‘raw’ html, so I will start to read further.

I had read about custom roles so that is of real interest, however I got a little lost – I do want to live within the existing framework.   Thanks again.

Alan