Pod-Simple reviews

cpanratings
 

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

Pod-Simple (3.28) ****

There's no disputing the quality of Pod::Simple's Pod parsing. It's pretty much the reference implementation.

However, the internals are somewhat byzantine. If you want to subclass Pod::Simple::HTML, prepare to trace method calls through five levels of inheritance (your class, ::HTML, ::PullParser, Pod::Simple, ::Blackbox), the last of which contains the following comment:

###############################################
##
## stop reading now stop reading now stop reading now stop
##
## HERE IT BECOMES REALLY SCARY
##
## stop reading now stop reading now stop reading now stop
##
###############################################

It's not a pleasant experience. My advice is to avoid subclassing it if possible; just pre-process the input or output to get what you need. Only subclass if there's no other way to accomplish what you need.

Toby Inkster - 2013-05-29T01:30:21 (permalink)

Was this review helpful to you?  Yes No

Pod-Simple (3.26) ****

Highly recommended!

Dinis Rebolo - 2013-03-14T07:33:37 (permalink)

0 out of 2 found this review helpful. Was this review helpful to you?  Yes No

Pod-Simple (3.16) *****

Echoing adam's review, we use only the command-line interface and it works great. For CPAN look/feel, just overwrite the provided stylesheet with CPAN's after generation:

wget -O /my/pod/dir/_blkbluw.css search.cpan.org/s/style.css

Evan Haas - 2011-05-23T11:39:55 (permalink)

3 out of 3 found this review helpful. Was this review helpful to you?  Yes No

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-07T05:36:38 (permalink)

2 out of 2 found this review helpful. 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:

www.perlmonks.org/index.pl?node_id=59...

John.
--

John McNamara - 2008-08-21T02:05:59 (permalink)

6 out of 6 found this review helpful. 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-21T18:28:38 (permalink)

Was this review helpful to you?  Yes No

Pod-Simple (0.97) *****

Best pod parser :)

Burak Gürsoy - 2003-08-19T03:32:14 (permalink)

0 out of 1 found this review helpful. 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.

jstenzel - 2003-08-14T11:40:52 (permalink)

1 out of 1 found this review helpful. 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-13T07:58:25 (permalink)

1 out of 1 found this review helpful. Was this review helpful to you?  Yes No
1 hidden unhelpful review