RSS | Module Info | Add a review of Pod-Simple

Pod-Simple (3.07)

TBH I'm just using this to auto-generate pod using the batch script - a simple perl -MPod::Simple::HTMLBatch -e Pod::Simple::HTMLBatch::go /path/to/your/modules output_dir works fine.

We've used the cpan-tastic css sheet recommended by John and it's lovely. Unfortunately it only splits modules on a single level, so we get 90% of our modules in one big lump. Otherwise, highly recommended!

adam - 2008-10-07 05:36:38
Was this review helpful to you?  Yes No

Pod-Simple (3.07)

Pod::Simple is a very rigourous Pod parser and it provides several different styles of interface such as event/method driven or pull parser.

I used Pod::Simple to create Pod::Simple::Wiki. It was very easy to subclass into something useful with very little coding.

(There is a tutorial on sub-classing in Pod::Simple::Subclassing).

It can be a little tricky to debug and the internals are best avoided but thankfully that isn't something that is required very often.

An excellent framework for pod2whatever converters.


[In reply to BKB's review]

"The HTML created by the module is incredibly ugly".

It *is* a little unadorned but Pod::Simple is mainly intended as a framework for Pod converters rather than as a definitive pod2html converter. The actual appearance of the Html output can be modified by adding a css stylesheet, (example below).

In your review of Pod::HtmlEasy you said:

"The HTML output looks like CPAN's which is a big benefit compared to the ugly one produced by POD::Simple::HTML".

The search.cpan.org output is actually produced using Pod::Simple::HTML. If you link to or copy their css stylesheet you will get Html documents that look the same. See the following for an example filter program:

http://www.perlmonks.org/index.pl?node_id=596075




John.
--

John McNamara - 2008-08-21 02:05:59
Was this review helpful to you?  Yes No

Pod-Simple (3.07)

[This is a review of Pod::Simple::HTML.]

The HTML created by the module is incredibly ugly. For some reason I'm probably not qualified to understand it makes every single heading into a link back to the top of the page, so there are these horrible blue links everywhere, on every title. I'm sure it's possible to turn these ugly and unnecessary links somehow using some obscure, undocumented option, but why would that be the default?

I started using this because the evil pod2html script supplied with Perl actually started deleting chunks of the pod documentation I was writing, without warning (stuff which passed through podchecker cleanly, by the way).

But the output of Pod::Simple::HTML is just too horrible for me to want to continue with it.

No wonder so many people have written pod to HTML convertors when the existing ones seem so broken - notice that CPAN is littered with alternative versions of modules which do the same task, and yet none of them actually do a particularly good job.

Further the documentation is screwed and just awful, and look at the other review which says "The docs could use some work, but it's still in development, so I'd expect them to improve in future releases."

Written five years ago, and "the docs" could still "use some work" in August 2008.

BKB - 2008-08-20 17:52:20
Was this review helpful to you?  Yes No

Pod-Simple (3.02)

You don't want to be trying to parse POD with your own hand-rolled code. This module is easy to use and very flexible. The OO design and assortment of bundled formatters mean you can start by inheriting from a class and your job is 90% done.

Grant McLean - 2005-04-21 18:28:38
Was this review helpful to you?  Yes No

Pod-Simple (0.97)

Best pod parser :)

Burak G�rsoy - 2003-08-19 03:32:14
Was this review helpful to you?  Yes No

Pod-Simple (0.97)

This module set makes it really simple to write own formatters - the name is a true promise.

Jochen Stenzel - 2003-08-14 11:40:52
Was this review helpful to you?  Yes No

Pod-Simple (0.97)

The docs could use some work, but it's still in development, so I'd expect them to improve in future releases. Nonetheless, this is still the best set of POD parsing modules available, and I've found them quite handy for many tasks.

Dave Rolsky - 2003-08-13 07:58:25
Was this review helpful to you?  Yes No

Perl.org sites : bugs | dev | history | jobs | learn | lists | use © Copyright 2002-2010 The Perl Foundation Site Information and Contacts root: (Vh | Vc)