Difference between revisions of "Template:Archive navigation/doc"
Jump to navigation
Jump to search
blackwiki>GPHemsley (→Usage: Add note about showmissing=0) |
blackwiki>GPHemsley (Add template data.) |
||
| Line 29: | Line 29: | ||
</includeonly> | </includeonly> | ||
| + | <templatedata> | ||
| + | { | ||
| + | "params": { | ||
| + | "1": { | ||
| + | "label": "N", | ||
| + | "description": "Number of current archive page", | ||
| + | "example": "2", | ||
| + | "type": "number", | ||
| + | "default": "2", | ||
| + | "required": true, | ||
| + | "suggested": true | ||
| + | }, | ||
| + | "prev": { | ||
| + | "label": "previous archive page", | ||
| + | "description": "Name of previous archive subpage.", | ||
| + | "type": "string", | ||
| + | "default": "Archive N-1", | ||
| + | "example": "archive1" | ||
| + | }, | ||
| + | "showmissing": { | ||
| + | "label": "show missing links", | ||
| + | "description": "Show links to pages that are missing.", | ||
| + | "example": "0", | ||
| + | "type": "boolean", | ||
| + | "default": "1" | ||
| + | }, | ||
| + | "next": { | ||
| + | "label": "next archive subpage", | ||
| + | "description": "Name of next archive subpage.", | ||
| + | "example": "archive3", | ||
| + | "type": "wiki-page-name", | ||
| + | "default": "Archive N+1" | ||
| + | } | ||
| + | }, | ||
| + | "description": "Archive page navigation", | ||
| + | "paramOrder": [ | ||
| + | "1", | ||
| + | "prev", | ||
| + | "next", | ||
| + | "showmissing" | ||
| + | ] | ||
| + | } | ||
| + | </templatedata> | ||
Revision as of 08:34, 22 November 2016
| This is a documentation subpage for Template:Archive navigation. It contains usage information, categories and other content that is not part of the original template page. |
Example display
Usage
{{archive-nav|N}} where N is archive number. Archive subpages must be named as "Archive 1", "Archive 2", "Archive 3", etc. for this to work. Otherwise use {{archive-nav|N|prev=Prev|next=Next}}, where Prev and Next are the names of the preceding and following archive subpages (e.g. {{archive-nav|3|prev=Archive2|next=archive 4}}).
Optionally, you can use {{archive number}} to provide N for you.
By default, a link to the next archive will be generated, even if that archive does not exist. To suppress this link, use showmissing=0.
See also
- {{Archive number}} for a way to automatically insert the archive number.
- {{archive nav}}
- {{Talk archive navigation}}
Archive page navigation
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| N | 1 | Number of current archive page
| Number | required |
| previous archive page | prev | Name of previous archive subpage.
| String | optional |
| next archive subpage | next | Name of next archive subpage.
| Page | optional |
| show missing links | showmissing | Show links to pages that are missing.
| Boolean | optional |