join "", (
"name), "\">",
encode_entities($elem->raw_content),
"\n\n"
);
}
sub export_fixed_width_section {
my ($self, $elem) = @_;
join "", (
"",
encode_entities($elem->text),
"\n"
);
}
sub export_comment {
my ($self, $elem) = @_;
join "", (
"\n"
);
}
sub export_drawer {
my ($self, $elem) = @_;
# currently not exported
'';
}
sub export_footnote {
my ($self, $elem) = @_;
# currently not exported
'';
}
sub export_headline {
my ($self, $elem) = @_;
my @htags = $elem->get_tags;
my @children = @{$elem->children // []};
if ($self->include_tags) {
if (!defined(first {$_ ~~ @htags} @{$self->include_tags})) {
# headline doesn't contain include_tags, select only
# suheadlines that contain them
@children = ();
for my $c (@{ $elem->children // []}) {
next unless $c->isa('Org::Element::Headline');
my @hl_included = $elem->find(
sub {
my $el = shift;
return unless
$elem->isa('Org::Element::Headline');
my @t = $elem->get_tags;
return defined(first {$_ ~~ @t}
@{$self->include_tags});
});
next unless @hl_included;
push @children, $c;
}
return '' unless @children;
}
}
if ($self->exclude_tags) {
return '' if defined(first {$_ ~~ @htags}
@{$self->exclude_tags});
}
join "", (
"level, ">",
$self->export_elements($elem->title),
"level, ">\n\n",
$self->export_elements(@children)
);
}
sub export_list {
my ($self, $elem) = @_;
my $tag;
my $type = $elem->type;
if ($type eq 'D') { $tag = 'DL' }
elsif ($type eq 'O') { $tag = 'OL' }
elsif ($type eq 'U') { $tag = 'UL' }
join "", (
"<$tag>\n",
$self->export_elements(@{$elem->children // []}),
"\n\n"
);
}
sub export_list_item {
my ($self, $elem) = @_;
my $html = [];
if ($elem->desc_term) {
push @$html, "";
} else {
push @$html, "";
}
if ($elem->check_state) {
push @$html, "[", $elem->check_state, "]";
}
if ($elem->desc_term) {
push @$html, $self->export_elements($elem->desc_term);
push @$html, " ";
push @$html, "";
}
push @$html, $self->export_elements(@{$elem->children}) if $elem->children;
if ($elem->desc_term) {
push @$html, " \n";
} else {
push @$html, "\n";
}
join "", @$html;
}
sub export_radio_target {
my ($self, $elem) = @_;
# currently not exported
'';
}
sub export_setting {
my ($self, $elem) = @_;
# currently not exported
'';
}
sub export_table {
my ($self, $elem) = @_;
join "", (
"\n",
$self->export_elements(@{$elem->children // []}),
"
\n\n"
);
}
sub export_table_row {
my ($self, $elem) = @_;
join "", (
"",
$self->export_elements(@{$elem->children // []}),
" \n"
);
}
sub export_table_cell {
my ($self, $elem) = @_;
join "", (
"",
$self->export_elements(@{$elem->children // []}),
" "
);
}
sub export_table_vline {
my ($self, $elem) = @_;
# currently not exported
'';
}
sub __escape_target {
my $target = shift;
$target =~ s/[^\w]+/_/g;
$target;
}
sub export_target {
my ($self, $elem) = @_;
# target
join "", (
"target), "\">"
);
}
sub export_text {
my ($self, $elem) = @_;
my $style = $elem->style;
my $tag;
if ($style eq 'B') { $tag = 'B' }
elsif ($style eq 'I') { $tag = 'I' }
elsif ($style eq 'U') { $tag = 'U' }
elsif ($style eq 'S') { $tag = 'STRIKE' }
elsif ($style eq 'C') { $tag = 'CODE' }
elsif ($style eq 'V') { $tag = 'TT' }
my $html = [];
push @$html, "<$tag>" if $tag;
my $text = encode_entities($elem->text);
$text =~ s/\R\R/\n\n\n\n/g;
push @$html, $text;
push @$html, $self->export_elements(@{$elem->children}) if $elem->children;
push @$html, "" if $tag;
join "", @$html;
}
sub export_time_range {
my ($self, $elem) = @_;
$elem->as_string;
}
sub export_timestamp {
my ($self, $elem) = @_;
$elem->as_string;
}
sub export_link {
my ($self, $elem) = @_;
my $html = [];
push @$html, "link =~ m!^\w+:!) {
# looks like a url
push @$html, $elem->link;
} else {
# assume it's an anchor
push @$html, "#", __escape_target($elem->link);
}
push @$html, "\">";
if ($elem->description) {
push @$html, $self->export_elements($elem->description);
} else {
push @$html, $elem->link;
}
push @$html, "";
join "", @$html;
}
1;
=pod
=head1 NAME
Org::To::HTML - Export Org document to HTML
=head1 VERSION
version 0.07
=head1 SYNOPSIS
use Org::To::HTML qw(org_to_html);
# non-OO interface
my $res = org_to_html(
source_file => 'todo.org', # or source_str
#target_file => 'todo.html', # defaults return the HTML in $res->[2]
#html_title => 'My Todo List', # defaults to file name
#include_tags => [...], # default exports all tags.
#exclude_tags => [...], # behavior mimics emacs's include/exclude rule
#css_url => '/path/to/my/style.css', # default none
#naked => 0, # if set to 1, no HTML/HEAD/BODY will be output.
);
die "Failed" unless $res->[0] == 200;
# OO interface
my $oeh = Org::To::HTML->new();
my $html = $oeh->export($doc); # $doc is Org::Document object
=head1 DESCRIPTION
Export Org format to HTML. To customize, you can subclass this module.
This module uses L logging framework.
This module uses L for object system.
This module's functions have L specs.
=head1 ATTRIBUTES
=head2 naked => BOOL
If set to true, export_document() will not output HTML/HEAD/BODY wrapping
element. Default is false.
=head2 html_title => STR
Title to use in TITLE element. If unset, defaults to "(no title)" when
exporting.
=head2 css_url => STR
If set, export_document() will output a LINK element pointing to this CSS.
=head1 METHODS
=for Pod::Coverage BUILD export_.+
=head2 $exp->export_document($doc) => HTML
Export document to HTML.
=head1 FUNCTIONS
None is exported by default, but they can be.
=head1 SEE ALSO
L
=head1 FUNCTIONS
=head2 org_to_html(%args) -> [status, msg, result, meta]
Export Org document to HTML.
This is the non-OO interface. For more customization, consider subclassing
Org::To::HTML.
Arguments ('*' denotes required arguments):
=over 4
=item * B => I
Add a link to CSS document.
=item * B => I
Exclude trees that carry one of these tags.
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.
excludeBtags.
=item * B => I
HTML document title, defaults to source_file.
=item * B => I
Include trees that carry one of these tags.
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.
=item * B => I
Don't wrap exported HTML with HTML/HEAD/BODY elements.
=item * B => I
Source Org file to export.
=item * B => I
Alternatively you can specify Org string directly.
=item * B => I
HTML file to write to.
If not specified, HTML string will be returned.
=back
Return value:
Returns an enveloped result (an array). First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
=head1 AUTHOR
Steven Haryanto
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2012 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.
=cut
__END__