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

NAME

Org::Element::Text - Represent text

VERSION

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

DESCRIPTION

Derived from Org::Element.

Org::Element::Text is an object that represents a piece of text. It has text and style attributes. Simple text like Jakarta or *Jakarta!* will be represented, respectively, as (text=Jakarta, style='') and text=Jakarta!, style=B (for bold).

This object can also hold other inline (non-block) elements, e.g. links, radio targets, timestamps, time ranges. They are all put in the children attribute.

ATTRIBUTES

text => str

Plain text for this object only. Note that if you want to get a plain text representation for the whole text (including child elements), you'd want the as_text method.

style => str

''=normal, I=italic, B=bold, U=underline, S=strikethrough, V=verbatim, C=code

METHODS

as_text => str

From Org::ElementRole::Inline.

as_string => str

From Org::Element.

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.