NAME

Sort::Sub::pod_sections_ala_perlancar - Sort POD sections (headings) PERLANCAR-style

VERSION

This document describes version 0.081 of Sort::Sub::pod_sections_ala_perlancar (from Perl distribution PERLANCAR-Sort-Sub), released on 2020-02-15.

SYNOPSIS

Generate sorter (accessed as variable) via Sort::Sub import:

 use Sort::Sub '$pod_sections_ala_perlancar'; # use '$pod_sections_ala_perlancar<i>' for case-insensitive sorting, '$pod_sections_ala_perlancar<r>' for reverse sorting
 my @sorted = sort $pod_sections_ala_perlancar ('item', ...);

Generate sorter (accessed as subroutine):

 use Sort::Sub 'pod_sections_ala_perlancar<ir>';
 my @sorted = sort {pod_sections_ala_perlancar} ('item', ...);

Generate directly without Sort::Sub:

 use Sort::Sub::pod_sections_ala_perlancar;
 my $sorter = Sort::Sub::pod_sections_ala_perlancar::gen_sorter(
     ci => 1,      # default 0, set 1 to sort case-insensitively
     reverse => 1, # default 0, set 1 to sort in reverse order
 );
 my @sorted = sort $sorter ('item', ...);

Use in shell/CLI with sortsub (from App::sortsub):

 % some-cmd | sortsub pod_sections_ala_perlancar
 % some-cmd | sortsub pod_sections_ala_perlancar --ignore-case -r

DESCRIPTION

POD sections in a Perl documentation are usually ordered according to a certain convention, e.g.:

 NAME
 VERSION
 SYNOPSIS
 DESCRIPTION
 ...

I include this convention plus some more for my specific POD sections.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/PERLANCAR-Sort-Sub.

SOURCE

Source repository is at https://github.com/perlancar/perl-PERLANCAR-Sort-Sub.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=PERLANCAR-Sort-Sub

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

Pod::Weaver::Plugin::PERLANCAR::SortSections, which uses the sort specification in this module, to actually sort POD sections in POD documents during dzil build.

Sort::Sub

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2019, 2017, 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.

cpanm PERLANCAR::Sort::Sub

perl -MCPAN -e shell
install PERLANCAR::Sort::Sub