Org::To::Base - Base class for Org exporters
This document describes version 0.16 of Org::To::Base (from Perl distribution Org-To-HTML), released on 2015-09-03.
# 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
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.
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.
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.
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.
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 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.
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.