.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Data::Page::Pageset 3pm"
.TH Data::Page::Pageset 3pm "2021-01-03" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Data::Page::Pageset \- change long page list to be shorter and well navigate
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Pages number can be very high, and it is not comfortable to show user from the first page to the last page list. Sometimes we need split the page list into some sets to shorten the page list, the form is like:
.PP
.Vb 1
\& 1\-6 7\-12 13 14 15 16 17 18 19\-24 25\-30 31\-36 37\-41
.Ve
.PP
the first two part indicats the two pagesets, and in current pageset, we provide the normal page list from the first one to the last one, and provide the rest pagesets to indicate the pages scope.
.PP
In this module, you can specify the pages_per_set or max_pagesets for fine showing.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\& use Data::Page::Pageset;
\& # we use Data::Page object, so do prepare
\& my $page = Data::Page\->new($total_entries, $entries_per_page, $current_page);
\& # create the pageset object
\& my $pageset = Data::Page::Pageset\->new( $page );
\& my $pageset = Data::Page::Pageset\->new( $page, 12 );
\& my $pageset = Data::Page::Pageset\->new( $page, { max_pagesets => $max_pagesets } );
\& my $pageset = Data::Page::Pageset\->new( $page, { pages_per_set => $pages_per_set } );
\&
\& # for using
\& foreach my $chunk ( $pageset\->total_pagesets ){
\&        if ( $chunk\->is_current ){
\&                map { print "$_ " } ( $chunk\->first .. $chunk\->last );
\&        }else{
\&                print "$chunk ";
\&        }
\& }
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew()\fR" 4
.IX Item "new()"
.Vb 2
\& # default page_per_set is 10
\& my $pageset = Data::Page::Pageset\->new( $page );
\&
\& # set the page_per_set to be 12
\& my $pageset = Data::Page::Pageset\->new( $page, 12 );
\& # another the same by passing hashref
\& my $pageset = Data::Page::Pageset\->new( $page, { pages_per_set => $pages_per_set } );
\&
\& # set the max_pagesets value, default is 1
\& my $pageset = Data::Page::Pageset\->new( $page, { max_pagesets => $max_pagesets } );
\& # if max_pagesets supplies, the pages_per_set setting will be ignore
\& my $pageset = Data::Page::Pageset\->new( $page, 
\&        { max_pagesets => $max_pagesets, pages_per_set => $pages_per_set } );
.Ve
.Sp
We must need \f(CW$pag\fRe(isa Data::Page) object.
.ie n .IP "max_pagesets( $number )" 4
.el .IP "max_pagesets( \f(CW$number\fR )" 4
.IX Item "max_pagesets( $number )"
.Vb 2
\& # set the max_pagesets value, and the $pageset\*(Aqs info will changed immediately
\& $pageset\->max_pagesets( $number );
.Ve
.ie n .IP "pages_per_set( $number )" 4
.el .IP "pages_per_set( \f(CW$number\fR )" 4
.IX Item "pages_per_set( $number )"
.Vb 3
\& # set the pages_per_set value, and the $pageset\*(Aqs info will changed immediately
\& $pageset\->pages_per_set( $number );
\& my $present_setting = $pageset\->pages_per_set();
.Ve
.ie n .IP "$pageset\->total_pages" 4
.el .IP "\f(CW$pageset\fR\->total_pages" 4
.IX Item "$pageset->total_pages"
return total pages' number.
.ie n .IP "$pageset\->total_pagesets" 4
.el .IP "\f(CW$pageset\fR\->total_pagesets" 4
.IX Item "$pageset->total_pagesets"
return the actual pagesets number.
.ie n .IP "$pageset\->first_pageset" 4
.el .IP "\f(CW$pageset\fR\->first_pageset" 4
.IX Item "$pageset->first_pageset"
.Vb 1
\& my $chunk = $pageset\->first_pageset;
.Ve
.Sp
return the first pageset, it's Data::Page::Pageset::Chunk object
.ie n .IP "$pageset\->last_pageset" 4
.el .IP "\f(CW$pageset\fR\->last_pageset" 4
.IX Item "$pageset->last_pageset"
.Vb 1
\& my $chunk = $pageset\->last_pageset;
.Ve
.Sp
return the last pageset, it's Data::Page::Pageset::Chunk object
.ie n .IP "$pageset\->current_pageset" 4
.el .IP "\f(CW$pageset\fR\->current_pageset" 4
.IX Item "$pageset->current_pageset"
.Vb 1
\& my $chunk = $pageset\->current_pageset;
.Ve
.Sp
return the current pageset which current page is in this pageset, it's Data::Page::Pageset::Chunk object
.ie n .IP "$pageset\->previous_pageset" 4
.el .IP "\f(CW$pageset\fR\->previous_pageset" 4
.IX Item "$pageset->previous_pageset"
.Vb 1
\& my $chunk = $pageset\->previous_pageset;
.Ve
.Sp
return the previous pageset, it's Data::Page::Pageset::Chunk object
.ie n .IP "$pageset\->next_pageset" 4
.el .IP "\f(CW$pageset\fR\->next_pageset" 4
.IX Item "$pageset->next_pageset"
.Vb 1
\& my $chunk = $pageset\->next_pageset;
.Ve
.Sp
return the next pageset, it's Data::Page::Pageset::Chunk object
.SH "Data::Page::Pageset::Chunk object"
.IX Header "Data::Page::Pageset::Chunk object"
a \f(CW$pageset\fR gives you some \f(CW$chunk\fR to do more stuff as you see above. Here gives the \f(CW$chunk\fR methods
.IP "first" 4
.IX Item "first"
.Vb 2
\& # return the first page number in this chunk
\& $chunk\->first;
.Ve
.IP "last" 4
.IX Item "last"
.Vb 2
\& # return the last page number in this chunk
\& $chunk\->last;
.Ve
.IP "middle" 4
.IX Item "middle"
.Vb 2
\& # return the middle page number in this chunk
\& $chunk\->middle;
.Ve
.IP "pages" 4
.IX Item "pages"
.Vb 2
\& # return the pages number in this chunk
\& $chunk\->pages;
.Ve
.IP "is_current" 4
.IX Item "is_current"
.Vb 2
\& # return true if this $chunk contains the current_page
\& $chunk\->is_current;
.Ve
.IP "as_string" 4
.IX Item "as_string"
.Vb 4
\& # if this chunk is from page 3 to 7, then print \*(Aq3\-7\*(Aq
\& print $chunk;
\& print $chunk\->as_string;
\& print $chunk\->as_string(\*(Aq\-\*(Aq);
\&
\& # you can change default \*(Aq\-\*(Aq as:
\& print $chunk\->as_string(\*(Aq~\*(Aq);
.Ve
.Sp
if the \f(CW$chunk\fR only contains one page, it will only return the page number.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Data::Page is what we need, Data::Pageset is the similar one, Template::Plugin::Pageset is the wrapper for this to using it more converiently in \s-1TT2\s0 tempale.
.SH "BUGS"
.IX Header "BUGS"
just mail me to <me@chunzi.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2004 by Chun Sheng.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "AUTHOR"
.IX Header "AUTHOR"
Chun Sheng, <me@chunzi.org>