NAME

orgdump-tiny - Dump Org document structure (using Org::Parser::Tiny)

VERSION

This document describes version 0.484 of orgdump-tiny (from Perl distribution App-OrgUtils), released on 2023-01-19.

SYNOPSIS

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

Given an Org document like this:

 text before first headline

 * headline1
 ** headline1.1
 * headline2

will output something like:

 (Org::Parser::Tiny::Node::Document) {preamble=>"text before first headline\n\n"}
 |-- (Org::Parser::Tiny::Node::Headline) {is_done=>0,is_todo=>0,level=>1,preamble=>"",raw=>"* headline1\n",title=>"headline1",todo_state=>""}
 |   \-- (Org::Parser::Tiny::Node::Headline) {is_done=>0,is_todo=>0,level=>2,preamble=>"",raw=>"** headline1.1\n",title=>"headline1.1",todo_state=>""}
 \-- (Org::Parser::Tiny::Node::Headline) {is_done=>0,is_todo=>0,level=>1,preamble=>"",raw=>"* headline2\n",title=>"headline2",todo_state=>""}

DESCRIPTION

This script parses input using Org::Parser::Tiny and dump the structure using Org::Dump. 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

dump-org-structure

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.

cpanm App::OrgUtils

perl -MCPAN -e shell
install App::OrgUtils