Template:Timeline/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
No edit summary
Line 1: Line 1:
== Usage ==
== Usage ==
Copy and paste '''all''' of the text below onto whichever article page it is needed for (even if some fields are not needed copy all of the text).
This template works automatically. Simply place <nowiki>{{timeline}}</nowiki> on any year, date or century page.  The template does the rest for you. 
<pre>
{{timeline
| prev    =
| century =
| decade  =
| next    =
}}
</pre>


==Description of fields==
'''It is completely automatic, and has no user-definable parameters.'''
Below is what each of the fields of the infobox means.
==Sample output==
<pre>
Because this template uses parser functions that manipulate the PAGENAME of pages on which it is placed, it is impossible to show sample output on '''this''' page ('''{{FULLPAGENAME}}'''). If you wish to test it, just go to any timeline-related page and use it.
{{timeline
==Special note==
| prev    = Previous year
This is the second version of this template. The past version required users to specifically define several variables. Thus you may occasionally encounter pages where this template has defined parameters. These are harmless, and do not impinge upon the proper operation of this version of the templateTo reiterate, however, they are not required, or even used, by this template. Thus, editors should refrain from trying to define parameters such as "next", "prev", "century" and "decade".
| century = Century to which the year belongs (i.e., the 21st Century would be entered purely as <tt>21st</tt>)
| decade  = Decade to which the year belongs (i.e., 2010-2019 would be entered as <tt>2010s</tt>).  
| next    = Following year
}}
</pre>
 
==Alternate Useage for Decade pages==
Below is what each of the fields of the infobox means.
<pre>
{{timeline
| prev    = Previous decade (i.e., 2010-2019 would be entered as <tt>2010s</tt>).
| century = Century to which the decade belongs (i.e., the 21st Century would be entered purely as <tt>21st</tt>)
| decade  = Leave field blank to produce a link to [[Timeline]]
| next    = Following decade (i.e., 2010-2019 would be entered as <tt>2010s</tt>).
}}
</pre>
 
== Alternate Useage for Century pages ==
Below is what each of the fields of the infobox means.
<pre>
{{timeline
| prev    = Previous century (i.e., the 21st Century would be entered as <tt>21st century</tt>).
| century = Leave field blank
| decade = Leave field blank
| next    = Following decade (i.e., the 21st Century would be entered as <tt>21st century</tt>).
}}
</pre>


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

Revision as of 07:34, 31 March 2010

Usage

This template works automatically. Simply place {{timeline}} on any year, date or century page. The template does the rest for you.

It is completely automatic, and has no user-definable parameters.

Sample output

Because this template uses parser functions that manipulate the PAGENAME of pages on which it is placed, it is impossible to show sample output on this page (Template:Timeline/doc). If you wish to test it, just go to any timeline-related page and use it.

Special note

This is the second version of this template. The past version required users to specifically define several variables. Thus you may occasionally encounter pages where this template has defined parameters. These are harmless, and do not impinge upon the proper operation of this version of the template. To reiterate, however, they are not required, or even used, by this template. Thus, editors should refrain from trying to define parameters such as "next", "prev", "century" and "decade".