Difference between revisions of "Template:Archive navigation/doc"

From blackwiki
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


Example display

Archive 1 |
Archive 2
| Archive 3

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

Template:Warchivenav


Archive page navigation

Template parameters

ParameterDescriptionTypeStatus
N1

Number of current archive page

Default
2
Example
2
Numberrequired
previous archive pageprev

Name of previous archive subpage.

Default
Archive N-1
Example
archive1
Stringoptional
next archive subpagenext

Name of next archive subpage.

Default
Archive N+1
Example
archive3
Pageoptional
show missing linksshowmissing

Show links to pages that are missing.

Default
1
Example
0
Booleanoptional