App::ListOrgAnniversaries - List headlines in Org files
version 0.13
# See list-org-anniversaries script
This module uses Log::Any logging framework.
None are exported, but they are exportable.
List all anniversaries in Org files.
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):
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 => code|str (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.
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.
Steven Haryanto <stevenharyanto@gmail.com>
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.
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.