NAME

App::FilterOrgByHeadlines - Filter Org by headlines

VERSION

This document describes version 0.479 of App::FilterOrgByHeadlines (from Perl distribution App-OrgUtils), released on 2020-07-21.

FUNCTIONS

filter_org_by_headlines

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.

  • 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.

    Value is either a string or a regex. If string is in the form of /.../ or /.../i it is assumed to be a regex.

  • max_level => int

  • min_level => int

  • parent_match => str|re

    Only include headline whose parent 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.

  • 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])

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-App-OrgUtils.

BUGS

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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.