NAME
App::podtohtml - Convert POD to HTML
VERSION
This document describes version 0.008 of App::podtohtml (from Perl
distribution App-podtohtml), released on 2021-02-26.
FUNCTIONS
podtohtml
Usage:
podtohtml(%args) -> [status, msg, payload, meta]
Convert POD to HTML.
Examples:
* Convert POD file to HTML, print result to STDOUT:
podtohtml( infile => "some.pod");
* Convert POD file to HTML, show result in browser:
podtohtml( infile => "some.pod", browser => 1);
* Convert POD file to HTML, show result in browser using the MetaCPAN
template to give an idea how it will look on MetaCPAN:
podtohtml( infile => "some.pod", browser => 1, template => "metacpan-20180911");
* Convert POD file to HTML, show result in browser using the sco
template to give an idea how it will look on (now-dead)
search.cpan.org:
podtohtml( infile => "some.pod", browser => 1, template => "sco-20180123");
* Convert POD file to HTML, show result in browser using the
perldoc.perl.org template to give an idea how it will look on
perldoc.perl.org:
podtohtml(
infile => "some.pod",
browser => 1,
template => "perldoc_perl_org-20180911"
);
* List which templates are available:
podtohtml( list_templates => 1);
This is a thin wrapper for Pod::Html and an alternative CLI to pod2html
to remove some annoyances that I experience with "pod2html", e.g. the
default cache directory being "." (so it leaves ".tmp" files around).
This CLI also offers templates and tab completion.
It does not yet offer as many options as "pod2html".
This function is not exported.
Arguments ('*' denotes required arguments):
* browser => *true*
Instead of outputing HTML to STDOUT/file, view it in browser.
* infile => *perl::pod_or_pm_filename* (default: "-")
Input file (POD).
If not found, will search in for .pod or .pm files in @INC.
* list_templates => *true*
List available templates.
* outfile => *filename*
* template => *str*
Pick a template to use, only relevant with --browser.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200
means OK, 4xx caller error, 5xx function error). Second element (msg) is
a string containing error message, or 'OK' if status is 200. Third
element (payload) is optional, the actual result. Fourth element (meta)
is called result metadata and is optional, a hash that contains extra
information.
Return value: (any)
podtohtml_metacpan
Usage:
podtohtml_metacpan(%args) -> [status, msg, payload, meta]
Show POD documentation roughly like how MetaCPAN would display it.
This is a shortcut for:
% podtohtml --template metacpan-20180911 --browser
% podtohtml --metacpan
This function is not exported.
Arguments ('*' denotes required arguments):
* infile => *perl::pod_or_pm_filename* (default: "-")
Input file (POD).
If not found, will search in for .pod or .pm files in @INC.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200
means OK, 4xx caller error, 5xx function error). Second element (msg) is
a string containing error message, or 'OK' if status is 200. Third
element (payload) is optional, the actual result. Fourth element (meta)
is called result metadata and is optional, a hash that contains extra
information.
Return value: (any)
HOMEPAGE
Please visit the project's homepage at
.
SOURCE
Source repository is at
.
BUGS
Please report any bugs or feature requests on the bugtracker website
When submitting a bug or request, please include a test-file or a patch
to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
pod2html, Pod::Html
AUTHOR
perlancar
COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2019, 2018, 2017 by
perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.