README.textile

• @{$}@
  The absolute page number.
• @{#}@
  The displayed page number.
• @{*}@
  The page title.
• @{current}@
  The text given by @current@ attribute, enabled only on the current tab.
• @{href}@
  The page URL.
• @{link}@
  The text given by @link@ attribute, replaced by @first@, @prev@, etc when necessary.
• @{pages}@
  The total pages number.
• @{rel}@
  The page relation (@next@, @prev@).

For example, the following (container tag) will generate a @@ pagination list: bc. <txp:etc_pagination link="Page {}" current="selected" wraptag="select" atts='name="pg"'> <option value="{}" {current}>{link} </txp:etc_pagination h4. Examples h5. Example 1 bc. <txp:etc_pagination range="2" prev="Previous" next="Next" wraptag="ul" break="li" /> This example outputs, if there are ten pages and we are on the third one, like so: bc. Previous 1 2 3 … 10 Next The @@ and @@ tags linking to @first@, @prev@, @current@, @next@, @last@, @gap@ pages, will be given the corresponding value of @rel@ or @data-rel@ attributes. h5. Example 2 bc. <txp:etc_pagination range="0"> Page {*} of {pages} </txp:etc_pagination> This example outputs, if there are eight pages and we are on the sixth one, like so: bc. Page 6 of 8 h5. Example 3 bc. <txp:etc_pagination wraptag="nav" class="paginator" range="3" atts='aria-label="Blog navigation"' prev='Prev, Prev' next='Next, Next' link='{}, {}' gap='…' mask='{prev}{next} {first}{<+}{links}{+>}{last} ' /> Fully customised HTML solutions can be achieved - this example outputs, if there are eleven pages and we are on the fifth one, like so: bc. Prev Next 1 … 4 5 6 … 11 h3. etc_numpages tag bc. <txp:etc_numpages /> The etc_numpages tag is a single helper tag that counts the number of pages in various lists (articles, images, links, ...). This tag is typically used as a pages attribute value, passed to etc_pagination, like this: bc. <txp:etc_pagination pages='<txp:numpages section="example" />' /> h4. Attributes Most attributes come from @<txp:article />@ and other Textpattern list tags: @limit="10"@The default value of pageby, see below. @offset="0"@The number of items to exclude from the beginning of the list. @pageby="number"@The maximum number of items per page. @table="txp_table"@A name of Textpattern database table from which the list will be extracted. Default: @textpattern@ (articles). @total="number"@An optional list length, if known. @author@, @category@, @excerpted@, @exclude@, @expired@, @id@, @include@, @keywords@, @month@, @realname@, @section@, @status@, @time@These attributes have the same function as in "txp:article_custom":http://www.textpattern.net/wiki/index.php?title=article_custom and other "list tags":http://www.textpattern.net/wiki/index.php?title=Category:List_Tags. h4. Examples h5. Example 1 bc. txp:if_individual_article <txp:etc_pagination pgcounter="page" pages='<txp:etc_numpages section="news" />' /> </txp:if_individual_article> This example shows pagination on individual article pages within the @news@ section (i.e., not on an article list context page). h3. etc_offset tag bc. <txp:article_custom offset='<txp:etc_offset pgcounter="page" pageby="5" />' limit="5" /> Used as helper tag to calculate the offset of article|image|... listing tags. The example above sets the offset to @15@ on a page with @...&page=4@ URL, so @<txp:article_custom />@ will display the fourth page of 5 articles. h4. Attributes @pageby="10"@The number of items per page. @pgcounter="pg"@The URL variable to be considered as page number. @offset="0"@An optional page offset. @type="value|page|start|end"@Outputs either the raw (escaped) value of @pgcounter@, or the calculated page number, or the start page item number, or the end page item number. h4. Examples h5. Example 1 bc. Showing articles <txp:etc_offset type="start" /> to <txp:etc_offset type="end" /> Outputs @Showing articles 21 to 30@ on the third page of the standard @<txp:article />@ list. h2. Authors/credits Written by "Oleg Loukianov":http://www.iut-fbleau.fr/projet/etc/ and inspired by "ob1_pagination":http://forum.textpattern.com/viewtopic.php?id=3724. Many thanks to "all additional contributors":https://github.com/etc-plugins/etc_pagination/graphs/contributors.