NAME
App::ListOrgHeadlines - List all headlines in all Org files
VERSION
This document describes version 0.487 of App::ListOrgHeadlines (from Perl distribution App-OrgUtils), released on 2024-01-09.
SYNOPSIS
# See list-org-headlines scriptDESCRIPTION
FUNCTIONS
list_org_headlines
Usage:
list_org_headlines(%args) -> [$status_code, $reason, $payload, \%result_meta]List all headlines in all Org files.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
allow_duplicates => bool
Whether to allow headline to be listed more than once.
This is only relevant when
group_by_tagsis on. Normally when a headline has several tags, it will only be listed under its first tag. But when this option is turned on, the headline will be listed under each of its tag (which mean a single headline will be listed several times).detail => bool (default: 0)
Show details instead of just titles.
done => bool
Only show todo items that are done.
due_in => int
Only show todo items that are (nearing|passed) due.
If value is not set, then will use todo item's warning period (or, if todo item does not have due date or warning period in its due date, will use the default 14 days).
If value is set to something smaller than the warning period, the todo item will still be considered nearing due when the warning period is passed. For example, if today is 2011-06-30 and due_in is set to 7, then todo item with due date <2011-07-10 > won't pass the filter (it's still 10 days in the future, larger than 7) but <2011-07-10 Sun +1y -14d> will (warning period 14 days is already passed by that time).
files* => array[filename]
(No description)
from_level => int (default: 1)
Only show headlines having this level as the minimum.
group_by_tags => bool (default: 0)
Whether to group result by tags.
If set to true, instead of returning a list, this function will return a hash of lists, keyed by tag: {tag1: [hl1, hl2, ...], tag2: [...]}. Note that a headline that has several tags will only be listed under its first tag, unless when
allow_duplicatesis set to true, in which case the headline will be listed under each of its tag.has_tags => array[str]
Only show headlines that have the specified tags.
lacks_tags => array[str]
Only show headlines that don't have the specified tags.
maximum_priority => str
Only show todo items that have at most this priority.
Note that the default priority list is [A, B, C] (A being the highest) and it can be customized using the
#+PRIORITIESsetting.minimum_priority => str
Only show todo items that have at least this priority.
Note that the default priority list is [A, B, C] (A being the highest) and it can be customized using the
#+PRIORITIESsetting.priority => str
Only show todo items that have this priority.
sort => str|code (default: "due_date")
Specify sorting.
If string, must be one of 'due_date', '-due_date' (descending).
If code, sorting code will get [REC, DUE_DATE, HL] as the items to compare, where REC is the final record that will be returned as final result (can be a string or a hash, if 'detail' is enabled), DUE_DATE is the DateTime object (if any), and HL is the Org::Headline object.
state => str
Only show todo items that have this state.
time_zone => date::tz_name
Will be passed to parser's options.
If not set, TZ environment variable will be picked as default.
to_level => int
Only show headlines having this level as the maximum.
today => obj
Assume today's date.
You can provide Unix timestamp or DateTime object. If you provide a DateTime object, remember to set the correct time zone.
todo => bool
Only show headlines that are todos.
with_unknown_priority => bool
Also show items with no/unknown priority.
Relevant only when used with
minimum_priorityand/ormaximum_priority.If this option is turned on, todo items that does not have any priority or have unknown priorities will still be included. Otherwise they will not be included.
Returns an enveloped result (an array).
First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.
Return value: (any)
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.
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 -lIf 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) 2024, 2023, 2022, 2021, 2020, 2019, 2018, 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=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.