Org::To::Base - Base class for Org exporters
This document describes version 0.236 of Org::To::Base (from Perl distribution Org-To-HTML), released on 2023-11-06.
# Not to be used directly. Use one of its subclasses, like Org::To::HTML.
This module is a base class for Org exporters. To create an exporter, subclass from this class (as well as add Org::To::Role role) and provide an implementation for the export_*() methods. Add extra attributes for export options as necessary (for example, Org::To::HTML adds html_title, css_url, and so on).
html_title
css_url
Arrayref. Works like Org's 'org-export-select-tags' variable. If the whole document doesn't have any of these tags, then the whole document will be exported. Otherwise, trees that do not carry one of these tags will be excluded. If a selected tree is a subtree, the heading hierarchy above it will also be selected for export, but not the text below those headings.
Arrayref. If the whole document doesn't have any of these tags, then the whole document will be exported. Otherwise, trees that do not carry one of these tags will be excluded. If a selected tree is a subtree, the heading hierarchy above it will also be selected for export, but not the text below those headings.
exclude_tags is evaluated after "include_tags".
exclude_tags
String. Optional. Can be set for informational purposes, e.g. will be used as default title when document does not set C>#+TITLE>.
Export Org.
Export Org element objects and with the children, recursively. Will call various export_*() methods according to element class. Should return a string which is the exported document.
export_*()
Several hooks are recognized and will be invoked if defined:
before_export_element
Will be called before calling each export_*(). Will be passed hash argument %hash containing these keys: hook (hook name, in this case before_export_element), elem (the element object).
%hash
hook
elem
after_export_element
Will be called after calling each export_*(). Will be passed hash argument %hash containing these keys: hook (hook name, in this case after_export_element), elem (the element object).
Please visit the project's homepage at https://metacpan.org/release/Org-To-HTML.
Source repository is at https://github.com/perlancar/perl-Org-To-HTML.
perlancar <perlancar@cpan.org>
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2023, 2022, 2020, 2018, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by perlancar <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.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Org-To-HTML
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.
To install Org::To::HTML, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Org::To::HTML
CPAN shell
perl -MCPAN -e shell install Org::To::HTML
For more information on module installation, please visit the detailed CPAN module installation guide.