/ 
App-OrgUtils-0.11
River stage one • 2 direct dependents • 2 total dependents
/ App::ListOrgHeadlines

NAME

App::ListOrgHeadlines - List headlines in Org files

VERSION

version 0.11

SYNOPSIS

# See list-org-headlines script

DESCRIPTION

FUNCTIONS

None are exported, but they are exportable.

list_org_headlines(%args) -> [STATUS_CODE, ERR_MSG, RESULT]

List all headlines in all Org files.

Returns a 3-element arrayref. STATUS_CODE is 200 on success, or an error code between 3xx-5xx (just like in HTTP). ERR_MSG is a string containing error message, RESULT is the actual result.

Arguments (* denotes required arguments):

  • files* => array

  • detail => bool (default 0)

    Show details instead of just titles.

  • done => bool

    Filter todo items that are done.

  • due_in => int

    Filter todo items which is due in this number of days.

    Note that if the todo's due date has warning period and the warning period is active, then it will also pass this filter irregardless. Example, if today is 2011-06-30 and due_in is set to 7, then todo with due date <2011-07-10 > won't pass the filter but <2011-07-10 Sun +1y -14d> will (warning period 14 days is already active by that time).

  • from_level => int (default 1)

    Filter headlines having this level as the minimum.

  • has_tags => array

    Filter headlines that have the specified tags.

  • lack_tags => array

    Filter headlines that don't have the specified tags.

  • priority => str

    Filter todo items that have this priority.

  • sort => code|str (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

    Filter todo items that have this state.

  • time_zone => str

    Will be passed to parser's options.

    If not set, TZ environment variable will be picked as default.

  • to_level => int

    Filter headlines having this level as the maximum.

  • todo => bool (default 0)

    Filter headlines that are todos.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Steven Haryanto.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.