Pod::AsciiDoctor(3pm) | User Contributed Perl Documentation | Pod::AsciiDoctor(3pm) |
NAME¶
Pod::AsciiDoctor - Convert from POD to AsciiDoc
VERSION¶
version 0.102002
SYNOPSIS¶
Converts the POD of a Perl module to AsciiDoc format.
use Pod::AsciiDoctor; my $adoc = Pod::AsciiDoctor->new(); $adoc->parse_from_filehandle($fh); print $adoc->adoc();
SUBROUTINES/METHODS¶
initialize¶
adoc¶
_prop¶
sanitise¶
append¶
command¶
Overrides Pod::Parser::command
verbatim¶
Overrides Pod::Parser::verbatim
textblock¶
Overrides Pod::Parser::textblock
interior_sequence¶
Overrides Pod::Parser::interior_sequence (Copied from the Pod::Parser)
make_header¶
make_text¶
set_formatting¶
AUTHOR¶
Balachandran Sivakumar, "<balachandran at balachandran.org>" Abhisek Kumar Rout, "<akr.optimus at gmail.com>"
BUGS¶
Please report any bugs or feature requests to "bug-pod-asciidoctor at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Pod-AsciiDoctor>. 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::AsciiDoctor
You can also look for information at:
- RT: CPAN's request tracker (report bugs here)
- AnnoCPAN: Annotated CPAN documentation
- CPAN Ratings
- Search CPAN
ACKNOWLEDGEMENTS¶
LICENSE AND COPYRIGHT¶
Copyright 2015 Balachandran Sivakumar, Abhisek Kumar Rout.
This program is free software; you can redistribute it and/or modify it under the terms of the the Apache License (2.0). You can get a copy of the license at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
SUPPORT¶
Websites¶
The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.
- MetaCPAN
A modern, open-source CPAN search engine, useful to view POD in HTML format.
- RT: CPAN's Bug Tracker
The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.
<https://rt.cpan.org/Public/Dist/Display.html?Name=Pod-AsciiDoctor>
- CPANTS
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
- CPAN Testers
The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.
- CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.
- CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
Bugs / Feature Requests¶
Please report any bugs or feature requests by email to "bug-pod-asciidoctor at rt.cpan.org", or through the web interface at <https://rt.cpan.org/Public/Bug/Report.html?Queue=Pod-AsciiDoctor>. You will be automatically notified of any progress on the request by the system.
Source Code¶
The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)
<https://github.com/shlomif/Pod-AsciiDoctor>
git clone git://github.com/shlomif/Pod-AsciiDoctor.git
AUTHOR¶
Shlomi Fish <shlomif@cpan.org>
BUGS¶
Please report any bugs or feature requests on the bugtracker website <https://github.com/shlomif/Pod-AsciiDoctor/issues>
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.
COPYRIGHT AND LICENSE¶
This software is Copyright (c) 2013 by Balachandran Sivakumar <balachandran@balachandran.org>.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
2024-03-22 | perl v5.40.0 |