Re: RFC: index core pods with X

2005-07-27 Thread Andy Lester
On Tue, Jul 26, 2005 at 06:38:00PM -0700, Michael G Schwern ([EMAIL PROTECTED]) wrote: More importantly, make your source data as exact as possible so the maximum amount of information is available to the user. Case is information. My only concern was false information, such as XOperators

Re: RFC: index core pods with X

2005-07-27 Thread Nicholas Clark
On Wed, Jul 27, 2005 at 10:07:57AM -0500, Andy Lester wrote: On Tue, Jul 26, 2005 at 06:38:00PM -0700, Michael G Schwern ([EMAIL PROTECTED]) wrote: More importantly, make your source data as exact as possible so the maximum amount of information is available to the user. Case is

Re: RFC: index core pods with X

2005-07-27 Thread Michael G Schwern
On Wed, Jul 27, 2005 at 04:14:02PM +0100, Nicholas Clark wrote: So this is a bit of a bikeshed issue. Can be summed up as follows: Use good English. -- Michael G Schwern [EMAIL PROTECTED] http://www.pobox.com/~schwern Ahh email, my old friend. Do you know that revenge is a dish that

Re: RFC: index core pods with X

2005-07-27 Thread Ivan Tubert-Brohman
Nicholas Clark wrote: The proposal seems very well thought through, and I'd be very happy to see you start on this soon. I'd hope that you'd soon attract volunteers to help, but as you rightly say, only time will tell. I've been contacted by a couple of willing volunteers. I just have a silly

Re: RFC: index core pods with X

2005-07-27 Thread Nicholas Clark
On Wed, Jul 27, 2005 at 03:55:45PM -0400, Ivan Tubert-Brohman wrote: Nicholas Clark wrote: The proposal seems very well thought through, and I'd be very happy to see you start on this soon. I'd hope that you'd soon attract volunteers to help, but as you rightly say, only time will tell.

Re: RFC: index core pods with X

2005-07-27 Thread Ivan Tubert-Brohman
Ok, to get the project started, I've done a couple of things. 1) I've uploaded to CPAN the first version of Pod::Index, which provides facilities for generating an index from pod files, and for searching the index and extracting the relevant sections of the pod files. 2) I've written a

Re: RFC: index core pods with X

2005-07-26 Thread Andy Lester
On Tue, Jul 26, 2005 at 02:52:47PM -0400, Ivan Tubert-Brohman ([EMAIL PROTECTED]) wrote: Let's use the X POD formatting code for indexing the Perl core documentation. This will allow easier searching of the documentation, and can be incorporated into tools like perldoc or third-party

Re: RFC: index core pods with X

2005-07-26 Thread Nicholas Clark
I've re-ordered bits of your message to group parts On Tue, Jul 26, 2005 at 02:52:47PM -0400, Ivan Tubert-Brohman wrote: First, a definition. By scope, I mean the part of the document that is deemed relevant to an index entry, and that may be extracted and shown in isolation by a processing

Re: RFC: index core pods with X

2005-07-26 Thread Ivan Tubert-Brohman
Nicholas Clark wrote: First, a definition. By scope, I mean the part of the document that is deemed relevant to an index entry, and that may be extracted and shown in isolation by a processing or display tool. For example, perldoc -f considers the scope of a function to end at the beginning of

Re: RFC: index core pods with X

2005-07-26 Thread Andy Lester
On Tue, Jul 26, 2005 at 04:37:19PM -0400, Ivan Tubert-Brohman ([EMAIL PROTECTED]) wrote: * all entries should be written in lowercase, unless uppercase is necessary due to case sensitivity. For example, for generic keyworks like operator, use Xoperator, not XOperator. What about XLarry?

Re: RFC: index core pods with X

2005-07-26 Thread Ivan Tubert-Brohman
Andy Lester wrote: On Tue, Jul 26, 2005 at 04:37:19PM -0400, Ivan Tubert-Brohman ([EMAIL PROTECTED]) wrote: * all entries should be written in lowercase, unless uppercase is necessary due to case sensitivity. For example, for generic keyworks like operator, use Xoperator, not XOperator.

Re: RFC: index core pods with X

2005-07-26 Thread Michael G Schwern
On Tue, Jul 26, 2005 at 08:54:48PM -0400, Ivan Tubert-Brohman wrote: However, another potential use of this index could be to create an actual printed index using latex, or an index file in POD, which then can be converted to HTML and other formats. In such an index, it would look much