Difference between revisions of "Template:Archive navigation/doc"
Jump to navigation
Jump to search
blackwiki>Jonverve (add) |
m (18 revisions imported) |
||
| (13 intermediate revisions by 10 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | + | <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE --> | |
| − | <!-- PLEASE ADD CATEGORIES | ||
===Example display=== | ===Example display=== | ||
<div style="text-align: center;"> | <div style="text-align: center;"> | ||
| − | <div style="display: inline;">← [[Template talk:Archive | + | <div style="display: inline;">← [[Template talk:Archive navigation|Archive 1]] |</div> |
<div style="display: inline;">'''Archive 2'''</div> | <div style="display: inline;">'''Archive 2'''</div> | ||
| − | <div style="display: inline;">| [[Template talk:Archive | + | <div style="display: inline;">| [[Template talk:Archive navigation|Archive 3]] →</div> |
</div> | </div> | ||
=== Usage === | === Usage === | ||
| − | < | + | <kbd><nowiki>{{archive-nav|N}}</nowiki></kbd> where N is archive number. Archive subpages must be named as "Archive 1", "Archive 2", "Archive 3", etc. for this to work. Otherwise use <kbd><nowiki>{{archive-nav|N|prev=Prev|next=Next}}</nowiki></kbd>, where Prev and Next are the names of the preceding and following archive subpages (e.g. <kbd><nowiki>{{archive-nav|3|prev=Archive2|next=archive 4}}</nowiki></kbd>). |
Optionally, you can use {{tl|archive number}} to provide N for you. | Optionally, you can use {{tl|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 <code>showmissing=0</code>. | ||
=== See also === | === See also === | ||
*{{tl|Archive number}} for a way to automatically insert the archive number. | *{{tl|Archive number}} for a way to automatically insert the archive number. | ||
*{{tl|archive nav}} | *{{tl|archive nav}} | ||
| − | *{{tl| | + | *{{tl|Talk archive navigation}} |
| − | |||
{{Warchivenav}} | {{Warchivenav}} | ||
| − | < | + | == TemplateData == |
| − | + | {{TemplateData header}} | |
| − | + | <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> | ||
| − | [[ | + | <includeonly>{{Sandbox other|| |
| − | [[ | + | <!-- CATEGORIES HERE, THANKS --> |
| − | </includeonly> | + | [[Category:Archival templates]] |
| + | [[Category:Talk header templates]] | ||
| + | }}</includeonly> | ||
Latest revision as of 12:46, 23 October 2020
| 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. |
Contents
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}}
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.
TemplateData for 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 |