Template:Auto-outdated/doc

From FamilySearch Wiki
Jump to: navigation, search

Purpose

The purpose of this template is to provide a means of automatically outdating an article based on a set number of days since its last revision date. This could be used on general articles by setting the Auto-outdated parameter to something like 365 days, 180 days, or 90 days. This template would be most beneficial when used with more time sensitive articles (such as, Community News or WikiProject status) by setting the parameter to 7 days to ensure weekly updates.

Besides checking and displaying the Current Alert Status on the template display as either “OKAY” or “Expired” the template will also install a category (Category:Auto-outdated) when the parser functions trip the “Expired” notification. By routinely checking the above category, all instances of pages that have tripped the expiration date can be reviewed and corrected (resetting the “timer” by updating the article or at least checking it and performing a dummy save).

The parser functions compare the CURRENT TIME STAMP with the REVISION TIME STAMP based on the values using the day of the year value. Initially a check is performed to determine if the two years are equal so the difference of the values can be determined but if they are not, the days to the end of the previous year are added to the days in the current year. A third result (a two year gap) has been added to allow for set points up to 730 days although greater than 365 days is probably impracticable.

Technically the template parameter could be any number greater than zero but realistically should be limited from 1 to 365 days (as a three year span during the initial check will result in an error). Although this could be adjusted to include more than the current two year span it is not of a high priority since an article worth tagging with this template should be reviewed at least yearly and there is a possibility that more appropriate parser functions (such as “AgeParse”) may become available with newer versions of MediaWiki.

Also note that there is currently a 1 day error that will occur in leap years but this calculation is not a critical operation therefore this is not considered important and again, newer parser functions with newer versions of MediaWiki could correct this issue.

Input parameters

This template is called using {{Auto-outdated}} and is associated with Category:Auto-outdated.

Parameter #1 is activated using {{Auto-outdated|14}} where “14” is the template parameter for the number of days from the last revision date before the template activates the “expired” condition (and installs the Category:Auto-outdated). The parameter value can be any integer number but the recommended values are 1 to 365 days (the default for parameter one is 7 days).

Parameter #2 is activated using {{Auto-outdated|14|sub-category name}} to create a sub-category to group the pages based on some criteria such as "current news articles".

Parameter #3 results in an additional sub-category that can be used to further group the pages {{Auto-outdated|14|sub-category name|secondary sub-category name}}. This secondary sub-category could be used if the page fits multiple topics or if a sub-category is created for a specific individual or group (such as Wiki Support).

Note: The default setting for the two sub-category parameters is Category:Auto-outdated to prevent extra categories from being created. If a new parameter value is entered it will result in a red link if it did not previously exist and the sub-category page must be created. It should then be specified as a sub-category of "Category:Auto-outdated" by adding [[Category:Auto-outdated]] as the category for the new page.

Internal calculations

Calculated parser equation values:

30     Set point (Default parameter one)
291  CurrentYear - day of year
14  RevisionYear - day of year
277      Option 1: Current Year days minus Revision Year days
642  Option 2: Revision days (from end of year) plus Current Year days
1007  Option 3: Revision days (from end of year) plus 365 plus Current Year days
Category:Auto-outdated  Category added when "expired".
Auto-outdated  Default category for parameter two.
Auto-outdated  Default category for parameter three.