App::FilterOrgByHeadlines - Filter Org by headlines
This document describes version 0.472 of App::FilterOrgByHeadlines (from Perl distribution App-OrgUtils), released on 2020-02-06.
Usage:
filter_org_by_headlines(%args) -> str|array[str]
Filter Org by headlines.
This routine uses simple regex instead of Org::Parser, for faster performance.
This function is not exported.
Arguments ('*' denotes required arguments):
ascendant_match => str|re
Only include headline whose ascendant matches this.
Value is either a string or a regex. If string is in the form of /.../ or /.../i it is assumed to be a regex.
/.../
/.../i
has_tags => array[str]
Only include headline which have all these tags.
input* => str
Value is either a string or an array of strings.
is_done => bool
Only include headline which is a done todo item.
is_todo => bool
Only include headline which is a todo item.
lacks_tags => array[str]
Only include headline which lack all these tags.
level => int
match => str|re
Only include headline which matches this.
max_level => int
min_level => int
parent_match => str|re
Only include headline whose parent matches this.
return_array => bool
Return array of strings instead of strings.
with_content => bool (default: 1)
Include headline content.
with_preamble => bool (default: 1)
Include text before any headline.
Return value: (str|array[str])
Please visit the project's homepage at https://metacpan.org/release/App-OrgUtils.
Source repository is at https://github.com/perlancar/perl-App-OrgUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-OrgUtils
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020, 2019, 2018, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by 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.
To install App::OrgUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::OrgUtils
CPAN shell
perl -MCPAN -e shell install App::OrgUtils
For more information on module installation, please visit the detailed CPAN module installation guide.