Sorry for the late reply, I do sometimes wander away from the list...

If I understand correctly, your module creates a list of keywords for
a keyword index, like those at the end of books. This suggests calling
the module Pod::Keywords, which sounds more fitting to me, as
Pod::Index suggests creation of indexes for full text searching...


On Sun, 7 Sep 2003, Yehuda Berlinger wrote:

YB> As long as I'm writing, I might as well ask the group:
YB>
YB> I have created an ... extension to perlindex/tkpod. Instead of doing a full
YB> text search, it searches for the table of contents on pods and returns them
YB> as phrases, e.g. "Assigning to variables", "Slices of Hashes", etc...
YB>
YB> It then builds some indexes, and presents a menu, just like perlindex, but
YB> of these phrases (like a table fo contents, or like a real index) and their
YB> locations, taking you to the exact line number in the appropriate pod.
YB>
YB> The phrases are sorted by shortest (in terms of number of words), and then
YB> alphabetically.
YB>
YB> The phrases are currently extracted by searching for =head* or =pod, but
YB> the facility is already built in to look for the long existing, but
YB> currently dormant, X<...> pod escape specification. This means that all pod
YB> documentation, assuming that this gets off the ground, should add X<...>
YB> whenever it wants to add itself to the table of contents.
YB>
YB> It works for perlindex and tkpod, and soon will for perldoc.
YB>
YB> First of all, any uphill battles here? Has anyone done anything like this?
YB>
YB> Second, the natural name for this is Pod::Index, which is taken by one
YB> Kenneth Albanowski, whose email box is stuffed and whose url doesn't work.
YB> I would be happy to coordinate efforts with him. Should I use a different
YB> name? Does anyone know how to reach him? Can I take over the name?
YB>
YB> The full (very) alpha version will be available for upload/download soon,
YB> unless there is any objection.
YB>
YB> This is my first public contribution, so forgive me for any protocol erros
YB> in this email, and set me straight.
YB>
YB> Yehuda Berlinger
YB>

Reply via email to