NAME

Tree::FSMethods::Org - Perform filesystem-like operations on Org document tree

VERSION

This document describes version 0.004 of Tree::FSMethods::Org (from Perl distribution Tree-FSMethods), released on 2021-10-07.

SYNOPSIS

            

              
              
use Tree::FSMethods::Org;
my $fs = Tree::FSMethods::Org->new(
    # specify an already parsed Org document ...
    tree => $tree,
    # tree1 => $tree,
    # tree2 => $other_tree,
    # ... or request parse from a file
    org_file => "/some/path/to/file.org",
    # org_file1 => ...
    # org_file2 => ...
    # defaults to getting from title(), with "[...]" trimmed (priority like
    # "[#B]" or statistics cookie like "[20%]" or "[2/10]")
    # filename_method => 'filename',
);
            
          

DESCRIPTION

This is a subclass of Tree::FSMethods with some nicer defaults for Org document tree produced by Org::Parser::Tiny.

METHODS

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Tree-FSMethods.

SOURCE

Source repository is at https://github.com/perlancar/perl-Tree-FSMethods.

SEE ALSO

Tree::FSMethods

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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020 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=Tree-FSMethods

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.