Editing Template:Yearbox/doc

Use '''{{tl|Yearbox}}''' on any page representing a year in [[Golarion]] history. It is designed to provide quick links to five years in the immediate past and future. In the case where there are entries for every year, it will automatically provide these links, but for situations where there are not entries for each year (such as long in the past when nothing notable happened in many individual years), manual overrides can be provided to give the five closest past and future years with events to note.

== Basic Usage ==
You ''must'' include the year on the template, ''despite'' the year number being in the article title. You should provide the year in [[Absalom Reckoning]]. Don't include the "AR" in the year&mdash;only the number is necessary.
<pre><nowiki>
{{Yearbox
|age  = Age of Lost Omens
|year = 4707
}}
</nowiki></pre>
This will produce:
{{Yearbox
|age  = Age of Lost Omens
|year = 4707
}}

In the above example, the 'age' parameter is optional. If it is omitted, it will simply not be displayed. Please see the [[:Category:Ages|Ages]] category for a list of suitable age names. It is important to give a valid age name if one is provided, because the template will provide a link to the article about that age.

==Overriding Years==
When the five immediate past or future years with notable events are ''not'' consecutive, you will need to provide manual overrides. Luckily this is not complicated, as in this example.
<pre><nowiki>
{{Yearbox
|age=Crown Wars
|year=-11400
|yp1=-11500
|yp2=-11600
|yp3=-11700
|yp4=-11800
|yp5=-12000
|yf1=-11300
|yf2=-11200
|yf3=-11003
|yf4=-11000
|yf5=-10900
}}
</nowiki></pre>
This will produce:
{{Yearbox
|age=Crown Wars
|year=-11400
|yp1=-11500
|yp2=-11600
|yp3=-11700
|yp4=-11800
|yp5=-12000
|yf1=-11300
|yf2=-11200
|yf3=-11003
|yf4=-11000
|yf5=-10900
}}

<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>