develooper Front page | perl.qa | Postings from August 2000

Indexing p6 documentation

Thread Next
From:
Tim Conrow
Date:
August 1, 2000 18:13
Subject:
Indexing p6 documentation
Message ID:
398775B3.BFE2FE9E@ipac.caltech.edu
Perl5's otherwise excellent documentation lacks a "conceptual index".
This would include those characters, words or expressions to which doc
authors want pointers. Authors would have to provide explicit indexing
hints. E.g.

= begin index_hints

loop,"control structures",for,while,block,{,},last,redo,continue,label

= end index_hints

One set of hints per document might be fine grained enough, or perhaps
they would need to refer to sections or paragraphs. I don't know how
that could be implemented.

I know that grep can be used for this purpose, but explicit indexing
hints allows authors greater control and has the potential of making the
docs more accessible to tyros. A browsable index is a useful thing even
on e-media; it helps one reach those "*That's* the term they use for
that" moments. 

--

-- Tim Conrow         tim@ipac.caltech.edu       626-395-8435

Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About