Beefy Boxes and Bandwidth Generously Provided by pair Networks
Come for the quick hacks, stay for the epiphanies.
 
PerlMonks  

CPAN upload previewer

by SilasTheMonk (Chaplain)
on Sep 09, 2009 at 13:09 UTC ( [id://794337]=perlquestion: print w/replies, xml ) Need Help??

SilasTheMonk has asked for the wisdom of the Perl Monks concerning the following question:

I am surprised that CPAN/PAUSE doesn't seem to have a preview facility to check that the pod looks okay on the internet. I realize now that I can run the files through pod2html and view them in a file. But I'm then still lacking the CSS and so you still don't quite know how it will look in CPAN.

Replies are listed 'Best First'.
Re: CPAN upload previewer
by toolic (Bishop) on Sep 09, 2009 at 13:23 UTC
      Thanks. I have bookmarked that.

      Edit: Tried it. Quite satisfactory really.

      Argh! Section linking works somehow different than pod2html: Some unwanted quotes are added and items have no NAME anchors like headings to link them.

        The lack of =item <a name/>s has bothered me for a long time. I see quite a few authors moving toward using head2 for all their methods/functions to get around it. :(

Re: CPAN upload previewer
by leocharre (Priest) on Sep 09, 2009 at 14:50 UTC
      I did look at podchecker but I could not see what help it would provide with the somewhat subjective formatting issues I came across. If you want to know what I am talking about compare the two versions of CGI::Application::Plugin::PageLookup (Database section).
Re: CPAN upload previewer
by moritz (Cardinal) on Sep 09, 2009 at 15:32 UTC
    Developer releases (those with an underscore in the version number) are a preview facility, to a certain degree.
    Perl 6 - links to (nearly) everything that is Perl 6.
Re: CPAN upload previewer
by JavaFan (Canon) on Sep 09, 2009 at 15:43 UTC
    I am surprised that CPAN/PAUSE doesn't seem to have a preview facility to check that the pod looks okay on the internet.
    I'm surprised you are surprised.

    If you ever uploaded something to PAUSE, you would have noticed that distributions aren't processed instantly. Instead, there's a batchjob running in the background processing recent uploads. Being able to "preview" pods means processing distributions needs to be done real time. Which would require more resources server side, as suddenly one has to scale against peak loads, instead of being able to average the processing time.

    Considering the limited advantage (IMO, close to nill) of doing the processing real time, I'm not surprised noone has donated the hardware (and time to change the software) to enable this.

    But you can always talk to Andreas about donating hardware and time.

      I am aware that it is a batch process and I was not suggesting that be changed. I think the reason it needs to be a batch process is so that integrity checking on version numbers and permissions can be done. A preview service could be much simpler perhaps taking indidual .pm files or a large textbox and ignoring integrity checks. I can understand the issue with extra resources. I could provide such a service myself if I get a clear idea of what the code would be. On my last reading of this thread the jury seemed to be out on that.
Re: CPAN upload previewer
by Burak (Chaplain) on Sep 09, 2009 at 22:32 UTC
    When I need to know if it looks good or not, I just extract the distro after packaging and then double click on Build.PL & then double click on Build.bat (aah! too many steps:) to have the html generated (your guess is correct, I'm on windows) and the check if it looks ok or not. CPAN Search seems to have a different parser as it seems to parse links in a different manner at least.

    Btw, I sometimes miss multiple upload fields in the PAUSE form apart from other usability issues...
Re: CPAN upload previewer
by vitoco (Hermit) on Sep 09, 2009 at 17:15 UTC

    I've just noticed that CPAN's docs don't include target anchors on =item commands as on =headN commands, just like using Pod::Simple::HTML, and cannot be linked. Was this intended or is a bug?

    Reference: "A section is started by the named heading or item." (perlpod)

    As pod2html does include the target on items, I used them to link within a pod, but it seems that I should remove that links as them would point to nowhere when uploaded to CPAN.

Re: CPAN upload previewer
by Your Mother (Archbishop) on Sep 11, 2009 at 23:48 UTC

    A bit late to the game but I just happened to stumble over this a second ago and remembered seeing this thread so... Pod::ProjectDocs - generates CPAN like pod pages.

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: perlquestion [id://794337]
Approved by Corion
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others learning in the Monastery: (5)
As of 2024-04-24 03:15 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found