perlancar > Org-To-HTML > org-to-html

Download:
Org-To-HTML-0.15.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

org-to-html - Export Org document to HTML

VERSION ^

This document describes version 0.15 of org-to-html (from Perl distribution Org-To-HTML), released on 2015-08-18.

SYNOPSIS ^

Usage:

 % org-to-html [options]

DESCRIPTION ^

This is the non-OO interface. For more customization, consider subclassing Org::To::HTML.

OPTIONS ^

* marks required options.

Configuration options

--config-path=filename

{en_US Set path to configuration file}.

Can be specified multiple times.

--config-profile=s

{en_US Set configuration profile to use}.

--no-config

{en_US Do not use any configuration file}.

Environment options

--no-env

{en_US Do not read environment for default options}.

Output options

--format=s

{en_US Choose output format, e.g. json, text}.

Default value:

 undef
--json

{en_US Set output format to json}.

--naked-res

{en_US When outputing as JSON, strip result envelope}.

Default value:

 0

{en_US By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]
}

Other options

--css-url=s

{en_US Add a link to CSS document}.

--exclude-tags-json=s

{en_US Exclude trees that carry one of these tags} (JSON-encoded).

See --exclude-tags.

--exclude-tags=s@

{en_US Exclude trees that carry one of these tags}.

{en_US 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. }

Can be specified multiple times.

--help, -h, -?

{en_US Display help message and exit}.

--html-title=s

{en_US HTML document title, defaults to source_file}.

--include-tags-json=s

{en_US Include trees that carry one of these tags} (JSON-encoded).

See --include-tags.

--include-tags=s@

{en_US Include trees that carry one of these tags}.

{en_US 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. }

Can be specified multiple times.

--naked

{en_US Don't wrap exported HTML with HTML/HEAD/BODY elements}.

--source-file=s

{en_US Source Org file to export}.

--source-str=s

{en_US Alternatively you can specify Org string directly}.

--target-file=s

{en_US HTML file to write to}.

{en_US If not specified, HTML string will be returned. }

--version, -v

{en_US Display program's version and exit}.

COMPLETION ^

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C org-to-html org-to-html

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete org-to-html 'p/*/`org-to-html`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

ENVIRONMENT ^

ORG_TO_HTML_OPT => str

Specify additional command-line options

CONFIGURATION FILE ^

This script can read configuration file, which by default is searched at ~/.config/org-to-html.conf, ~/org-to-html.conf or /etc/org-to-html.conf (can be changed by specifying --config-path). All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

Configuration file is in the format of IOD, which is basically INI with some extra features.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

List of available configuration parameters:

 css_url (see --css-url)
 exclude_tags (see --exclude-tags)
 format (see --format)
 html_title (see --html-title)
 include_tags (see --include-tags)
 naked (see --naked)
 naked_res (see --naked-res)
 source_file (see --source-file)
 source_str (see --source-str)
 target_file (see --target-file)

FILES ^

~/.config/org-to-html.conf

~/org-to-html.conf

/etc/org-to-html.conf

HOMEPAGE ^

Please visit the project's homepage at https://metacpan.org/release/Org-To-HTML.

SOURCE ^

Source repository is at https://github.com/perlancar/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 ^

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE ^

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.

syntax highlighting: