NAME

Org::ElementRole::Inline - Role for inline elements

VERSION

This document describes version 0.558 of Org::ElementRole::Inline (from Perl distribution Org-Parser), released on 2022-06-23.

DESCRIPTION

This role is applied to elements that are "inline": elements that can occur inside text and put as a child of Org::Element::Text.

REQUIRES

as_text => str

Get the "rendered plaintext" representation of element. Most elements would return the same result as as_string, except for elements like Org::Element::Link which will return link description instead of the link itself.

METHODS

is_block => bool (0)

is_inline => bool (1)

children_as_text => str

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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 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.