- COPYRIGHT AND LICENSE
Org::Document - Represent an Org document
This document describes version 0.45 of Org::Document (from Perl distribution Org-Parser), released on 2015-08-18.
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
Derived from Org::Element.
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
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).
new(from_string => ...)
Create object from string.
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.
cmp_priorities($p1, $p2) => -1|0|-1
Compare two priorities
$p2. Return result like Perl's
cmp: 0 if the two are the same, -1 if
$p1 is of higher priority (since it's more to the left position in priority list, which is sorted highest-first) than
$p2, and 1 if
$p2 is of lower priority than
$p2 has unknown priority, will return undef.
$doc->cmp_priorities('A', 'A') # -> 0 $doc->cmp_priorities('A', 'B') # -> -1 (A is higher than B) $doc->cmp_priorities('C', 'B') # -> 1 (C is lower than B) $doc->cmp_priorities('X', 'A') # -> undef (X is unknown)
Note that X could be known if there is a
#+PRIORITIES setting which defines it.
Please visit the project's homepage at https://metacpan.org/release/Org-Parser.
Source repository is at https://github.com/perlancar/perl-Org-Parser.
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.
COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by email@example.com.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.