Browse Source

Clarify a bit the pager term

Closes #775
index-subcmd
Vincent Prouillet 5 years ago
parent
commit
fd19469e40
1 changed files with 12 additions and 9 deletions
  1. +12
    -9
      docs/content/documentation/templates/pagination.md

+ 12
- 9
docs/content/documentation/templates/pagination.md View File

@@ -11,27 +11,30 @@ while both a paginated taxonomy page and a paginated section page gets a
`paginator` variable of the `Pager` type: `paginator` variable of the `Pager` type:


```ts ```ts
// How many items per page
// How many items per pager
paginate_by: Number; paginate_by: Number;
// The base URL for the pagination: section permalink + pagination path // The base URL for the pagination: section permalink + pagination path
// You can concatenate an integer with that to get a link to a given pagination page.
// You can concatenate an integer with that to get a link to a given pagination pager.
base_url: String; base_url: String;
// How many pagers in this paginator
// How many pagers in total
number_pagers: Number; number_pagers: Number;
// Permalink to the first page
// Permalink to the first pager
first: String; first: String;
// Permalink to the last page
// Permalink to the last pager
last: String; last: String;
// Permalink to the previous page, if there is one
// Permalink to the previous pager, if there is one
previous: String?; previous: String?;
// Permalink to the next page, if there is one
// Permalink to the next pager, if there is one
next: String?; next: String?;
// All pages for the current page
// All pages for the current pager
pages: Array<Page>; pages: Array<Page>;
// Which page are we on
// Which pager are we on
current_index: Number; current_index: Number;
``` ```


A pager is a page of the pagination: if you have 100 pages and are paginating 10 by 10, you will have 10 pagers containing
each 10 pages.

## Section ## Section


A paginated section gets the same `section` variable as a normal A paginated section gets the same `section` variable as a normal


Loading…
Cancel
Save