NAME
Org::To::Base - Base class for Org exporters
VERSION
This document describes version 0.14 of Org::To::Base (from Perl distribution Org-To-HTML), released on 2014-08-16.
SYNOPSIS
# Not to be used directly. Use one of its subclasses, like Org::To::HTML.DESCRIPTION
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).
ATTRIBUTES
include_tags => 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.
exclude_tags => 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.
METHODS
$exp->export($doc) => STR
Export Org.
$exp->export_elements(@elems) => STR
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.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Org-To-HTML.
SOURCE
Source repository is at https://github.com/sharyanto/perl-Org-To-HTML.
BUGS
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.
AUTHOR
Steven Haryanto <stevenharyanto@gmail.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by Steven Haryanto.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.