The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

PERLANCAR / App-TextFragmentUtils-0.002 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

              
NAME
    App::TextFragmentUtils - CLI utilities related to Text::Fragment
VERSION
    This document describes version 0.002 of App::TextFragmentUtils (from
    Perl distribution App-TextFragmentUtils), released on 2021-05-25.
DESCRIPTION
    This distributions provides the following command-line utilities related
    to text fragment:
    *   get-fragment
    *   list-fragments
FUNCTIONS
  get_fragment
    Usage:
     get_fragment(%args) -> [$status_code, $reason, $payload, \%result_meta]
    Get fragment with a certain ID in text.
    If there are multiple occurences of the fragment with the same ID ,
    This function is not exported.
    Arguments ('*' denotes required arguments):
    *   comment_style => *str* (default: "shell")
        Comment style.
    *   filename* => *filename*
    *   id* => *str*
        Fragment ID.
    *   label => *str* (default: "FRAGMENT")
        Comment label.
    Returns an enveloped result (an array).
    First element ($status_code) is an integer containing HTTP status code
    (200 means OK, 4xx caller error, 5xx function error). Second element
    ($reason) is a string containing error message, or "OK" if status is
    200. Third element ($payload) is optional, the actual result. Fourth
    element (%result_meta) is called result metadata and is optional, a hash
    that contains extra information.
    Return value: Fragment (array)
    Will return status 200 if fragment is found. Result will be a hash with
    the following keys: "raw" (string), "payload" (string), "attrs" (hash),
    "id" (string, can also be found in attributes).
    Return 404 if fragment is not found.
  list_fragments
    Usage:
     list_fragments(%args) -> [$status_code, $reason, $payload, \%result_meta]
    List fragments in text.
    This function is not exported.
    Arguments ('*' denotes required arguments):
    *   comment_style => *str* (default: "shell")
        Comment style.
    *   filename* => *filename*
    *   label => *str* (default: "FRAGMENT")
        Comment label.
    Returns an enveloped result (an array).
    First element ($status_code) is an integer containing HTTP status code
    (200 means OK, 4xx caller error, 5xx function error). Second element
    ($reason) is a string containing error message, or "OK" if status is
    200. Third element ($payload) is optional, the actual result. Fourth
    element (%result_meta) is called result metadata and is optional, a hash
    that contains extra information.
    Return value: List of fragments (array)
    Will return status 200 if operation is successful. Result will be an
    array of fragments, where each fragment is a hash containing these keys:
    "raw" (string), "payload" (string), "attrs" (hash), "id" (string, can
    also be found in attributes).
HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-TextFragmentUtils>.
SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-TextFragmentUtils>.
BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=App-TextFragmentUtils
    >
    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.
SEE ALSO
    Text::Fragment
AUTHOR
    perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
    This software is copyright (c) 2021, 2016 by 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.