/ 
Org-Parser-0.560
River stage two • 10 direct dependents • 13 total dependents
/ Org::Element::Timestamp

NAME

Org::Element::Timestamp - Represent Org timestamp

VERSION

This document describes version 0.560 of Org::Element::Timestamp (from Perl distribution Org-Parser), released on 2023-08-05.

DESCRIPTION

Derived from Org::Element.

Supported formats:

  • [...] and <...> (active) forms

  • basic date: [2013-10-27 Sun]

  • event duration: [2011-03-23 Wed 10:12-11:23]

  • repeater: [2011-03-23 Wed +3m] including ++ and .+

  • habit-style repeater: [2011-03-23 Wed 10:12 +1d/2d]

  • warning period: <2011-05-25 Wed +17.1m -13.2d>

BUGS AND LIMITATIONS

  • Habit-style repeater (e.g. 2d/3d) is not yet represented in recurrence

    The recurrence object currently will still only include 2d (without the maximum interval).

ATTRIBUTES

datetime => DATETIME_OBJ

has_time => BOOL

event_duration => INT

Event duration in seconds, e.g. for event timestamp like this:

<2011-03-23 10:15-13:25>

event_duration is 7200+600=7800 (2 hours 10 minutes).

recurrence => DateTime::Event::Recurrence object

is_active => BOOL

METHODS

$el->clear_parse_result

Clear parse result.

Since the DateTime::Set::ICal (recurrence) object contains coderefs (and thus poses problem to serialization), an option is provided to remove parse result. You can do this prior to serializing the object.

Timestamp will automatically be parsed again from _str when one of the attributes is accessed.

as_string => str

From Org::Element.

as_text => str

From Org::ElementRole::Inline.

HOMEPAGE

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

SOURCE

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

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2022, 2021, 2020, 2019, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by perlancar <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.

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.