Curtis "Ovid" Poe > Pod-Parser-Groffmom-0.042 > Pod::Parser::Groffmom

Download:
Pod-Parser-Groffmom-0.042.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.042   Source  

NAME ^

Pod::Parser::Groffmom - Convert POD to a format groff_mom can handle.

VERSION ^

Version 0.042

SYNOPSIS ^

    use Pod::Parser::Groffmom;
    my $foo  = Pod::Parser::Groffmom->new();
    my $file = 't/test_pod.pod';
    open my $fh, '<', $file 
      or die "Cannot open ($file) for reading: $!";
    $parser->parse_from_filehandle($fh);
    print $parser->mom;

If you have printed the "mom" output to file named 'my.mom', you can then do this:

  groff -mom my.mom > my.ps

And you will have a postscript file suitable for opening in gv, Apple's Preview.app or anything else which can read postscript files.

If you prefer, read perldoc pod2mom for an easier interface.

DESCRIPTION ^

This subclass of Pod::Parser will take a POD file and produce "mom" output. See http://linuxgazette.net/107/schaffter.html for a gentle introduction.

If you have groff on your system, it should have docs for "momdoc". Otherwise, you can read them at http://www.opensource.apple.com/source/groff/groff-28/groff/contrib/mom/momdoc/toc.html?f=text.

The "mom" documentation is not needed to use this module, but it would be needed if you wish to hack on it.

CONSTRUCTOR ^

The following arguments may be supplied to the constructor and override any values found in the POD document.

ALPHA CODE ^

This is alpha code. There's not much control over it yet and there are plenty of POD corner cases it doesn't handle.

MOM COMMANDS ^

Most POD files will convert directly to "mom" output. However, when you view the result, you might want more control over it. The following is how MOM directives are handled. They may begin with either '=head1' or =head2'. It doesn't matter (this might change later).

Some commands which should alter mom behavior but not show up in the POD begin with =for.

SPECIAL CHARACTERS ^

Special characters are often encountered in POD:

 Salvador FandiE<ntilde>o

To see the list of named characters we support, check Pod::Parser::Groffmom::Entities. If the character you need is not on that list, you may still enter its numeric value. The above name could also be written as:

 Salvador FandiE<241>o

And should be rendered as "Salvador Fandiño".

LIMITATIONS ^

Probably plenty.

AUTHOR ^

Curtis "Ovid" Poe, <ovid at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-pod-parser-groffmom at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-Parser-Groffmom. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Pod::Parser::Groffmom

You can also look for information at:

REPOSITORY ^

The latest version of this module can be found at http://github.com/Ovid/Pod-Parser-GroffMom.

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2009 Curtis "Ovid" Poe, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: