++ed by:
ADAMJS RRWO

2 PAUSE user(s)
1 non-PAUSE user(s).

Steven Haryanto

NAME

Org::Document - Represent an Org document

VERSION

This document describes version 0.38 of Org::Document (from Perl distribution Org-Parser), released on 2014-05-17.

SYNOPSIS

 use Org::Document;

 # create a new Org document tree from string
 my $org = Org::Document->new(from_string => <<EOF);
 * heading 1a
 some text
 ** heading 2
 * heading 1b
 EOF

DESCRIPTION

Derived from Org::Element.

ATTRIBUTES

tags => ARRAY

List of tags for this file, usually set via #+FILETAGS.

todo_states => ARRAY

List of known (action-requiring) todo states. Default is ['TODO'].

done_states => ARRAY

List of known done (non-action-requiring) states. Default is ['DONE'].

priorities => ARRAY

List of known priorities. Default is ['A', 'B', 'C'].

drawer_names => ARRAY

List of known drawer names. Default is [qw/CLOCK LOGBOOK PROPERTIES/].

properties => ARRAY

File-wide properties.

radio_targets => ARRAY

List of radio target text.

time_zone => ARRAY

If set, will be passed to DateTime->new() (e.g. by Org::Element::Timestamp).

METHODS

new(from_string => ...)

Create object from string.

load_element_modules()

Load all Org::Element::* modules. This is useful when wanting to work with element objects retrieved from serialization, where the element modules have not been loaded.

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/sharyanto/perl-Org-Parser.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Org-Parser

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.




Hosting generously
sponsored by Bytemark