Template:Auto change/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:Auto change (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.


This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

This template is intended to add information to a page after a certain amount of time has passed or at a specific date and time.

[edit] Usage

This template must be substituted.


{{subst:auto change |time= |before= |after= |purgelink= |linebreak= }}

Required field(s)

|before : The information to be shown before the deadline. Default is nothing.

and/or

|after : The information to be shown after the deadline. Default is nothing.

Optional fields

|time : The amount of time you wish to go before adding the information, or a specific date and time. Default is +7 days. For examples, see ParserFunctions #time (second variable).

|purgelink : Set to |purgelink=yes to add a purgelink to the right of where the template is substituted. This can be useful to refresh the page (see below). Default is disabled.

|linebreak : Set to |linebreak=yes to add <br clear="right" /> between the purgelink and the rest of the template. Only works if "purgelink" is enabled. Default is disabled.

[edit] Example

{{subst:auto change |time=6 hours |before='''n00b''' |after='''1337''' }}

will result in "n00b" 0–5.99 hours after the template was added, and in "1337" 6— hours after the template was added.

[edit] Limitation

Changes made when the function passes the deadline may not be visible at first, then a purge may be needed.