/ 
App-OrgUtils-0.486
River stage one • 2 direct dependents • 2 total dependents
/ dump-org-structure

NAME

dump-org-structure - Dump Org document structure

VERSION

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

SYNOPSIS

$ dump-org-structure   foo.org
$ dump-org-structure < bar.org

Given an Org document like this:

* Andi Angkasa
- email :: andi@example.com
- birthday :: [1981-03-31 ]

will output something like:

Document:
  Headline: l=1
    (title)
    Text: "Andi Angkasa"
    (children)
    List: D(-) indent=0
      ListItem: -
        (description term)
        Text: "email"
        (children)
        Text: " andi@example.com\n"
      ListItem: -
        (description term)
        Text: "birthday"
        (children)
        Text: " "
        Timestamp: dt=1981-03-31T00:00:00 "[1981-03-31 Tue]"
        Text: "\n"

DESCRIPTION

This script parse input using Org::Parser and dump the structure in an outline format. This script is mostly used for debugging.

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

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