Difference between revisions of "Template:Moratorium/doc"

m (updating)
m
Line 2: Line 2:
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
==Purpose==
 
==Purpose==
The '''moratorium''' template should be used when an article falls under BattleTechWiki's [[Policy:Moratorium|moratorium policy]] guidelines. In general, this is for a new product that has just been released and lasts for two months after release.
+
This template will automatically display one of two '''moratorium''' statements based on whether a particular date has been reached or not. It should be used when an article falls under BattleTechWiki's [[Policy:Moratorium|moratorium policy]] guidelines. In general, this is for a new product that has just been released and lasts for two months after release.
 
==Usage==
 
==Usage==
Cut and paste '''<nowiki>{{moratorium|the ending date of the moratorium}}</nowiki>''' into the top of the article. For example:
+
{{tlx|Moratorium|''year''|''month''|''day''}}
 +
 
 +
* Parameters 1, 2, and 3 are the Year, Month, and Day that the Moratorium expires (normally 2 months from the date of release).
 +
** If the day is omitted, the template will activate on the first day of the specified month. 
 +
** If the month is also omitted, the template will activate on 1 January of the specified year.
 +
** If the year is also omitted, the template will activate immediately.
 +
 
 +
==Examples==
 +
===Moratorium date has not yet arrived===
 +
When the moratorium date has not yet arrived, the template displays the following message and adds the page to the {{cl|Sources under Moratorium}}:
 
<pre>
 
<pre>
{{moratorium|July 2, 2037}}
+
{{moratorium|2037|07|02}}
 
</pre>
 
</pre>
 
Will display:
 
Will display:
{{moratorium|July 2, 2037}}
+
{{moratorium|2037|07|02}}
 
+
===Moratorium date has arrived===
When the moratorium date has arrived, the template displays a different message. For example:
+
When the moratorium date has arrived, the template displays a different message.
 
<pre>
 
<pre>
{{moratorium|July 2, 2009}}
+
{{moratorium|2009|07|02}}
 
</pre>
 
</pre>
  
 
Will display:
 
Will display:
{{moratorium|July 2, 2009}}
+
{{moratorium|2009|07|02}}
  
 
<includeonly>
 
<includeonly>

Revision as of 18:54, 16 March 2024

Purpose

This template will automatically display one of two moratorium statements based on whether a particular date has been reached or not. It should be used when an article falls under BattleTechWiki's moratorium policy guidelines. In general, this is for a new product that has just been released and lasts for two months after release.

Usage

{{Moratorium|year|month|day}}

  • Parameters 1, 2, and 3 are the Year, Month, and Day that the Moratorium expires (normally 2 months from the date of release).
    • If the day is omitted, the template will activate on the first day of the specified month.
    • If the month is also omitted, the template will activate on 1 January of the specified year.
    • If the year is also omitted, the template will activate immediately.

Examples

Moratorium date has not yet arrived

When the moratorium date has not yet arrived, the template displays the following message and adds the page to the Category:Sources under Moratorium:

{{moratorium|2037|07|02}}

Will display:

Moratorium date has arrived

When the moratorium date has arrived, the template displays a different message.

{{moratorium|2009|07|02}}

Will display: