27 Jun 2021 03:27:16 UTC
- Distribution: Org-Parser
- Module version: 0.555
- Source (raw)
- Browse (raw)
- How to Contribute
- Repository (git clone)
- Issues (3)
- Testers (175 / 2 / 2)
- KwaliteeBus factor: 1
- 86.13% Coverage
- License: perl_5
- Perl: v5.10.1
- Activity24 month
- Download (60.03KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version++ed by:2 non-PAUSE usersPERLANCAR perlancar
- $el->children_as_string() => STR
- $el->as_string() => STR
- $el->seniority => INT
- $el->prev_sibling() => ELEMENT | undef
- $el->next_sibling() => ELEMENT | undef
- $el->extra_walkables => LIST
- $el->find(CRITERIA) => ELEMENTS
- $el->headline() => ELEMENT
- $el->headlines() => ELEMENTS
- $el->field_name() => STR
- COPYRIGHT AND LICENSE
Org::Element - Base class for Org document elements
This document describes version 0.555 of Org::Element (from Perl distribution Org-Parser), released on 2021-06-27.
# Don't use directly, use the other Org::Element::* classes.
This is the base class for all the other Org element classes.
Link to document object. Elements need this to access file-wide settings, properties, etc.
Link to parent element. Undef if this element is the root element.
Return a concatenation of children's as_string(), or "" if there are no children.
Return the string representation of element. The default implementation will just use _str (if defined) concatenated with children_as_string().
Find out the ranking of brothers/sisters of all sibling. If we are the first child of parent, return 0. If we are the second child, return 1, and so on.
Return extra walkable elements. The default is to return an empty list, but some elements can have this, for Org::Element::Headline's title is also a walkable element.
Call CODEREF for node and all descendent nodes (and extra walkables), depth-first. Code will be given the element object as argument.
Find subelements. CRITERIA can be a word (e.g. 'Headline' meaning of class 'Org::Element::Headline') or a class name ('Org::Element::ListItem') or a coderef (which will be given the element to test). Will return matched elements.
Run CODEREF for parent, and its parent, and so on until the root element (the document), or until CODEREF returns a false value. CODEREF will be supplied ($el, $parent). Will return the last parent walked.
Get current headline. Return undef if element is not under any headline.
Get current headline (in the first element of the result list), its parent, its parent's parent, and so on until the topmost headline. Return empty list if element is not under any headline.
Try to extract "field name", being defined as either some text on the left side:
DEADLINE: <2011-06-09 >
or a description term in a description list:
- wedding anniversary :: <2011-06-10 >
Remove element from the tree. Basically just remove the element from its parent.
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.
This software is copyright (c) 2021, 2020, 2019, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by firstname.lastname@example.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.