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

NAME

App::OrgUtils - Some utilities for Org documents

VERSION

This document describes version 0.486 of App::OrgUtils (from Perl distribution App-OrgUtils), released on 2023-07-12.

DESCRIPTION

This distribution includes a few modules (scripts) for dealing with Org documents; some originally created as examples/demos for Org::Parser. The following are the included scripts:

1. browse-org
2. count-done-org-todos
3. count-org-todos
4. count-undone-org-todos
5. dump-org-structure
6. dump-org-structure-tiny
7. list-org-anniversaries
8. list-org-headlines
9. list-org-priorities
10. list-org-tags
11. list-org-todo-states
12. list-org-todos
13. move-done-org-todos
14. org2html
15. org2html-wp
16. orgdump
17. orgdump-tiny
18. orgstat
19. stat-org-document

FUNCTIONS

reverse_org_headlines

Usage:

reverse_org_headlines(%args) -> any

Reverse Org headlines.

This function is not exported.

Arguments ('*' denotes required arguments):

  • file => filename (default: "-")

    Path to an Org file.

    "-" means standard input.

  • level => posint (default: 1)

    (No description)

Return value: (any)

sort_org_headlines

Usage:

sort_org_headlines(%args) -> any

.

This function is not exported.

Arguments ('*' denotes required arguments):

  • file => filename (default: "-")

    Path to an Org file.

    "-" means standard input.

  • level => posint (default: 1)

    (No description)

  • sort_args => array[str]

    Arguments to pass to the Sort::Sub::* routine.

  • sort_sub => sortsub::spec

    Name of a Sort::Sub::* module (without the prefix).

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.

SEE ALSO

Org::Parser

orgsel in App::orgsel

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTOR

Steven Haryanto <stevenharyanto@gmail.com>

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 -l

If 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) 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.