/ 
App-OrgUtils-0.18
River stage one • 2 direct dependents • 2 total dependents
/ App::ListOrgAnniversaries

NAME

App::ListOrgAnniversaries - List headlines in Org files

VERSION

version 0.18

SYNOPSIS

# See list-org-anniversaries script

DESCRIPTION

This module uses Log::Any logging framework.

FUNCTIONS

None are exported, but they are exportable.

None are exported by default, but they are exportable.

list_org_anniversaries(%args) -> [status, msg, result, meta]

This function expects contacts in the following format:

* First last                              :office:friend:
  :PROPERTIES:
  :BIRTHDAY:     1900-06-07
  :EMAIL:        foo@example.com
  :OTHERFIELD:   ...
  :END:

or:

* Some name                               :office:
  - birthday   :: [1900-06-07 ]
  - email      :: foo@example.com
  - otherfield :: ...

Using PROPERTIES, dates currently must be specified in "YYYY-MM-DD" format. Other format will be supported in the future. Using description list, dates can be specified using normal Org timestamps (repeaters and warning periods will be ignored).

By convention, if year is '1900' it is assumed to mean year is not specified.

By default, all contacts' anniversaries will be listed. You can filter contacts using tags ('hastags' and 'lackstags' options), or by 'duein' and 'maxoverdue' options (duein=14 and maxoverdue=2 is what I commonly use in my startup script).

Arguments ('*' denotes required arguments):

  • cache_dir => str

    Cache Org parse result.

    Since Org::Parser can spend some time to parse largish Org files, this is an option to store the parse result. Caching is turned on if this argument is set.

  • due_in => int

    Only show anniversaries that are due in this number of days.

  • field_pattern => str (default: "(?:birthday|anniversary)")

    Field regex that specifies anniversaries.

  • files => array

  • has_tags => array

    Filter headlines that have the specified tags.

  • lacks_tags => array

    Filter headlines that don't have the specified tags.

  • max_overdue => int

    Don't show dates that are overdue more than this number of days.

  • sort => any (default: "due_date")

    Specify sorting.

    If string, must be one of 'date', '-date' (descending).

    If code, sorting code will get [REC, DUEDATE] 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), and DUEDATE is the DateTime object.

  • time_zone => str

    Will be passed to parser's options.

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

  • today => any

    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.

Return value:

Returns an enveloped result (an array). First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

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