Pod::AsciiDoctor(3pm)

📦 version 0.102002, in opensuse-leap 16.0

✨ NAME ✨

okay so this is the Pod::AsciiDoctor(3pm) page and she is literally a converter — Pod::AsciiDoctor takes POD and turns it into AsciiDoc. That's the whole vibe, no cap. 🦋

🎀 VERSION 🎀

version 0.102002 — that's the one, bestie.

🌸 SYNOPSIS 🌸

Converts the POD of a Perl module to AsciiDoc format. So it's giving "POD glow-up into AsciiDoc" and honestly? Obsessed.

use Pod::AsciiDoctor;

my $adoc = Pod::AsciiDoctor->new();
$adoc->parse_from_filehandle($fh);
print $adoc->adoc();

That's literally it — you use the module, make a new object, feed it a filehandle with parse_from_filehandle($fh), then print the adoc() output. Periodt. 🫶

💅 SUBROUTINES/METHODS 💅

Here's every method chilling in this module — some of them are overrides of Pod::Parser stuff, so they have inherited main-character energy:

  • 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
ngl the non-override ones don't come with extra lore in the original, so I'm not gonna invent what they do — respectfully 💀

🔥 AUTHOR 🔥

Balachandran Sivakumar, "<balachandran at balachandran.org>" and Abhisek Kumar Rout, "<akr.optimus at gmail.com>" — these two made it happen. 👑

💀 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. Slay, you'll get updates. ✨

💜 SUPPORT 💜

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

perldoc Pod::AsciiDoctor

You can also look for information at:

🧚 ACKNOWLEDGEMENTS 🧚

(no content in the original — iconic minimalism, she said nothing and left 💅)

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

(and yes, "the the" is literally in the source, bestie 😭 don't come for me)

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 💖

(yes, there are two SUPPORT sections — she's extra like that 💅)

⭐ 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.

🐛 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.

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

mwah 💅 and that's the whole page — brought to you by perl v5.42.0, dated 2024-03-22. iykyk ✨🫶

📦 where this page comes from