Bug #40397 for Pod-POM-Web: Request: sort perlpods

Sun Oct 26 21:32:28 2008 perl [...] galumph.com - Ticket created

Subject:	Request: sort perlpods
Date:	Sun, 26 Oct 2008 20:31:34 -0500
To:	bug-pod-pom-web [...] rt.cpan.org
From:	Elliot Shank <perl [...] galumph.com>

Right now, Pod::POM::Web uses the order for documents that comes right from the perl summary. While I have no problem remembering that I want to look at perlre when I want regular expressions, perlrun when I want command-line options, I don't remember what order they show up under on the summary page. So I spend time searching for the page that I want. The attached patch sorts the perlpods (within the existing sections). Thanks for putting something together that I use every day.

--- ~/src/Pod-POM-Web-1.09/lib/Pod/POM/Web.pm 2007-12-19 17:44:20.000000000 -0600 +++ Pod/POM/Web.pm 2008-10-26 20:18:58.000000000 -0500 @@ -588,7 +588,7 @@ $title =~ s/^Internals.*/Internals/; my $leaves = ""; - foreach my $ref (@refs) { + foreach my $ref (sort @refs) { my $entry = delete $perldocs->{$ref} or next; $leaves .= leaf(label => $ref, href => $entry->{node}); }

Sun Nov 02 20:48:03 2008 DAMI [...] cpan.org - Correspondence added

Le Dim. Oct. 26 21:32:28 2008, clonezone a écrit : Show quoted text

> Right now, Pod::POM::Web uses the order for documents that comes right > from the perl summary. While I have no problem remembering that I > want to look at perlre when I want regular expressions, perlrun > when I want command-line options, I don't remember what order they > show up under on the summary page. So I spend time searching for > the page that I want. The attached patch sorts the perlpods > (within the existing sections). > > Thanks for putting something together that I use every day.

Hi, For browsing, I think it's best to keep the order as proposed from the Perl doc, because most frequently used pages come first; for newcomers this is important. To get directly at a particular page, I suggest you use the search box : put the menu on "Search in MODULES", and then you can type "perlre" or "perlop" and get directly at the page you asked. Or use the tree navigator and type Ctrl-F to find the entry you want.

Sun Nov 02 20:48:05 2008 The RT System itself - Status changed from 'new' to 'open'

Sun Nov 02 20:48:05 2008 DAMI [...] cpan.org - Status changed from 'open' to 'rejected'

Sun Nov 02 21:05:51 2008 perl [...] galumph.com - Correspondence added

Subject:	Re: [rt.cpan.org #40397] Request: sort perlpods
Date:	Sun, 02 Nov 2008 20:05:37 -0600
To:	bug-Pod-POM-Web [...] rt.cpan.org
From:	Elliot Shank <perl [...] galumph.com>

Laurent Dami via RT wrote: Show quoted text

> For browsing, I think it's best to keep the order as proposed from the > Perl doc, because most frequently used pages come first; for newcomers > this is important.

That would be true if the descriptions were to be carried over from the perl man page, but they're not. If an experienced perl person has a hard time finding a particular page in the list, how do you expect a beginner to?

Sun Nov 02 21:05:52 2008 The RT System itself - Status changed from 'rejected' to 'open'

Sun Nov 02 21:25:16 2008 laurent.dami [...] free.fr - Correspondence added

Subject:	Re: [rt.cpan.org #40397] Request: sort perlpods
Date:	Mon, 03 Nov 2008 03:25:00 +0100
To:	bug-Pod-POM-Web [...] rt.cpan.org
From:	laurent dami <laurent.dami [...] free.fr>

Elliot Shank via RT a écrit : Show quoted text

> Queue: Pod-POM-Web > Ticket <URL: http://rt.cpan.org/Ticket/Display.html?id=40397 > > > Laurent Dami via RT wrote: >

>> For browsing, I think it's best to keep the order as proposed from the >> Perl doc, because most frequently used pages come first; for newcomers >> this is important. >>

> > That would be true if the descriptions were to be carried over from the perl man page, but they're not. If an experienced perl person has a hard time finding a particular page in the list, how do you expect a beginner to? > >

OK, good point. So I propose to a) add tooltips in the entries b) open "perl" instead of "perlintro" as default initial page c) add hyperlinks in the "perl" manpage

Sun Nov 02 21:41:44 2008 perl [...] galumph.com - Correspondence added

Subject:	Re: [rt.cpan.org #40397] Request: sort perlpods
Date:	Sun, 02 Nov 2008 20:41:33 -0600
To:	bug-Pod-POM-Web [...] rt.cpan.org
From:	Elliot Shank <perl [...] galumph.com>

laurent.dami@free.fr via RT wrote: Show quoted text

> OK, good point. So I propose to > a) add tooltips in the entries > b) open "perl" instead of "perlintro" as default initial page > c) add hyperlinks in the "perl" manpage

That's great! (but I still want the sort for when my hand is on the mouse already)

Mon Nov 10 03:15:10 2008 DAMI [...] cpan.org - Fixed in 1.10 added

Mon Nov 10 03:15:11 2008 DAMI [...] cpan.org - Correspondence added

perlpods sorted in v1.10

Mon Nov 10 03:15:13 2008 DAMI [...] cpan.org - Status changed from 'open' to 'resolved'