Acme-CPANModules-WrappingText

 view release on metacpan or  search on metacpan

README  view on Meta::CPAN

    Text::LineFold
        Author: NEZUMI <https://metacpan.org/author/NEZUMI>

    Text::Wrap
        Author: ARISTOTLE <https://metacpan.org/author/ARISTOTLE>

        Core module.

ACME::CPANMODULES FEATURE COMPARISON MATRIX
     +----------------------+--------------+-------------+-----------------+
     | module               | can_ansi *1) | can_cjk *2) | can_unicode *3) |
     +----------------------+--------------+-------------+-----------------+
     | App::TextWrapUtils   | N/A          | N/A         | N/A             |
     | Lingua::JA::Fold     | no           | yes         | no              |
     | Text::ANSI::Fold     | yes          | yes         | yes             |
     | Text::ANSI::Util     | yes          | no          | no              |
     | Text::ANSI::WideUtil | yes          | no          | yes             |
     | Text::WideChar::Util | no           | no          | yes             |
     | Text::Fold           | no           | no          | yes             |
     | Text::LineFold       | no           | no          | no              |
     | Text::Wrap           | no           | no          | no              |
     +----------------------+--------------+-------------+-----------------+

    Notes:

    1. can_ansi: Can wrap text that contains ANSI color/escape codes
    2. can_cjk: Can wrap CJK wide characters
    3. can_unicode: Can wrap Unicode text, including wide characters

FAQ
  What is an Acme::CPANModules::* module?
    An Acme::CPANModules::* module, like this module, contains just a list
    of module names that share a common characteristics. It is a way to
    categorize modules and document CPAN. See Acme::CPANModules for more
    details.

  What are ways to use this Acme::CPANModules module?
    Aside from reading this Acme::CPANModules module's POD documentation,

lib/Acme/CPANModules/WrappingText.pm  view on Meta::CPAN

our $LIST = {
    summary => "List of modules and utilities to wrap text",
    description => <<'_',

See also: <prog:fold> Unix command line.

_
    # TODO: use Module::Features
    entry_features => {
        can_unicode => {summary => 'Can wrap Unicode text, including wide characters'},
        can_cjk     => {summary => 'Can wrap CJK wide characters'},
        can_ansi    => {summary => 'Can wrap text that contains ANSI color/escape codes'},
    },
    entries => [
        {
            module => 'App::TextWrapUtils',
            script => 'textwrap',
            description => <<'_',

CLI front-end for various backends mentioned in this list.

lib/Acme/CPANModules/WrappingText.pm  view on Meta::CPAN

        },
        {
            module => 'Lingua::JA::Fold',
            function => 'fold',
            description => <<'_',

Specifically for folding Japanese (and other CJK) text.

_
            features => {
                can_unicode => 0,
                can_cjk => 1,
                can_ansi => 0,
            },
        },
        {
            module => 'Text::ANSI::Fold',
            function => 'ansi_fold',
            description => <<'_',

_
            features => {
                can_unicode => 1,
                can_cjk => 1,
                can_ansi => 1,
            },
        },
        {
            module => 'Text::ANSI::Util',
            function => 'ta_wrap',
            description => <<'_',

For wrapping text that contains ANSI escape/color codes.

_
            features => {
                can_unicode => 0,
                can_cjk => 0,
                can_ansi => 1,
            },
        },
        {
            module => 'Text::ANSI::WideUtil',
            function => 'ta_mbwrap',
            description => <<'_',

For wrapping text that contains ANSI escape/color codes *and* Unicode wide
characters.

_
            features => {
                can_unicode => 1,
                can_cjk => 0,
                can_ansi => 1,
            },
        },
        {
            module => 'Text::WideChar::Util',
            function => 'mbwrap',
            description => <<'_',

For wrapping text that contains Unicode wide characters.

_
            features => {
                can_unicode => 1,
                can_cjk => 0,
                can_ansi => 0,
            },
        },
        {
            module => 'Text::Fold',
            function => 'fold_text',
            description => <<'_',

_
            features => {
                can_unicode => 1,
                can_cjk => 0,
                can_ansi => 0,
            },
        },
        {
            module => 'Text::LineFold',
            method => 'fold',
            description => <<'_',

_
            features => {
                can_unicode => 0,
                can_cjk => 0,
                can_ansi => 0,
            },
        },
        {
            module => 'Text::Wrap',
            description => <<'_',

Core module.

_
            features => {
                can_unicode => 0,
                can_cjk => 0,
                can_ansi => 0,
            },
        },
    ],
};

1;
# ABSTRACT: List of modules and utilities to wrap text

lib/Acme/CPANModules/WrappingText.pm  view on Meta::CPAN

Author: L<ARISTOTLE|https://metacpan.org/author/ARISTOTLE>

Core module.


=back

=head1 ACME::CPANMODULES FEATURE COMPARISON MATRIX

 +----------------------+--------------+-------------+-----------------+
 | module               | can_ansi *1) | can_cjk *2) | can_unicode *3) |
 +----------------------+--------------+-------------+-----------------+
 | App::TextWrapUtils   | N/A          | N/A         | N/A             |
 | Lingua::JA::Fold     | no           | yes         | no              |
 | Text::ANSI::Fold     | yes          | yes         | yes             |
 | Text::ANSI::Util     | yes          | no          | no              |
 | Text::ANSI::WideUtil | yes          | no          | yes             |
 | Text::WideChar::Util | no           | no          | yes             |
 | Text::Fold           | no           | no          | yes             |
 | Text::LineFold       | no           | no          | no              |
 | Text::Wrap           | no           | no          | no              |

lib/Acme/CPANModules/WrappingText.pm  view on Meta::CPAN

Notes:

=over

=item 1. can_ansi: Can wrap text that contains ANSI color/escape codes

=item 2. can_cjk: Can wrap CJK wide characters

=item 3. can_unicode: Can wrap Unicode text, including wide characters

=back

=head1 FAQ

=head2 What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module
names that share a common characteristics. It is a way to categorize modules and
document CPAN. See L<Acme::CPANModules> for more details.

lib/Module/Features/TextWrapper.pm  view on Meta::CPAN

our %FEATURES_DEF = (
    v => 1,
    summary => 'Features of modules that wrap text',
    description => <<'_',

Keywords: fold

_
    features => {
        can_unicode => {summary => 'Can wrap Unicode text, including wide characters'},
        can_cjk     => {summary => 'Can wrap CJK wide characters'},
        can_ansi    => {summary => 'Can wrap text that contains ANSI color/escape codes'},
    },
);

1;
# ABSTRACT: Features of modules that wrap text

__END__

lib/Module/Features/TextWrapper.pm  view on Meta::CPAN

=over

=item * can_ansi

Optional. Type: bool. Can wrap text that contains ANSI color/escape codes. 

=item * can_cjk

Optional. Type: bool. Can wrap CJK wide characters. 

=item * can_unicode

Optional. Type: bool. Can wrap Unicode text, including wide characters. 

=back

For more details on module features, see L<Module::Features>.

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/Acme-CPANModules-WrappingText>.