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

From blackwiki
Jump to navigation Jump to search
blackwiki>GPHemsley
(Add template data.)
blackwiki>Zyxw
m (add {{TemplateData header}} (via JWB))
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<includeonly>{{esoteric}}</includeonly>
 
<includeonly>{{esoteric}}</includeonly>
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
  
 
===Example display===
 
===Example display===
Line 23: Line 23:
 
{{Warchivenav}}
 
{{Warchivenav}}
  
<includeonly>
+
== TemplateData ==
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
{{TemplateData header}}
[[Category:Archival templates|{{PAGENAME}}]]
 
[[Category:Talk header templates|{{PAGENAME}}]]
 
 
 
</includeonly>
 
 
<templatedata>
 
<templatedata>
 
{
 
{
Line 72: Line 68:
 
}
 
}
 
</templatedata>
 
</templatedata>
 +
 +
<includeonly>
 +
<!-- CATEGORIES HERE, THANKS -->
 +
[[Category:Archival templates]]
 +
[[Category:Talk header templates]]
 +
 +
</includeonly>

Revision as of 03:59, 24 February 2017


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

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

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