Editing Template:Orphan/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{High-use}}
{{Twinkle standard installation}}
{{AWB standard installation}}
{{No subst}}

{{for|the template for orphan images|Template:Orphan file}}

'''Template:Orphan''' is used on pages with no incoming links from other articles or lists. The template is responsible for populating sub-categories of [[:Category:Orphaned articles]]. There are currently {{PAGESINCATEGORY:All orphaned articles}} orphaned articles.

==How to use==
The simplest way to add this template to an article is to copy and paste either <code><nowiki>{{Orphan|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code> or  <code><nowiki>{{Orphan|{{subst:DATE}}}}</nowiki></code> at the top of the article.

* Please do not [[Wikipedia:Subst|subst:]] this template.

==When to use==
This template should only be put on articles which meet the [[WP:Orphan#Criteria|orphan criteria]].  Use your judgment about whether to add this template.  Do not add this template to articles that you honestly believe [[WP:CANTDEORPHAN|will be impossible to de-orphan]].  Instead of using this template, please make an effort to de-orphan the article ''yourself''.

==Visibility==
The template message is visible on all pages where the [[#date|date parameter]] is set to either the current month or the previous month (currently <u>{{Monthyear}}</u> or <u>{{Monthyear-1}}</u>). It is also visible on all pages where it is used inside the {{tl|multiple issues}} template. Older-dated orphan templates used outside of the {{tl|multiple issues}} template are invisible by default, but are still categorized. To override the default and make the message visible on all pages where it's placed, put the following line in your [[special:mypage/common.css|common.css]] file (create the file if you don't have one yet):
<syntaxhighlight lang="css">
.ambox-Orphan{display: table !important;}
</syntaxhighlight> This may not work in some older browsers - if it doesn't work, use <syntaxhighlight lang=css>.ambox-Orphan{display: block !important;}</syntaxhighlight> instead.
Alternatively, to '''''never''''' see this tag, you could instead add to your [[Special:MyPage/common.css|common.css]]:
<syntaxhighlight lang="css">
.ambox-Orphan{ display: none !important; }
</syntaxhighlight>
The orphan message box is invisible on ''this'' page by default. If you have correctly installed the above common.css the orphan message box is visible here.

===Rationale===
There are {{PAGESINCAT:All orphaned articles}} orphaned articles in the [[Wikipedia:WikiProject Orphanage|WikiProject Orphanage]]-backlog. The tags on newly created articles are visible for a month or two, in hopes that the article's creators or reviewers will tend to the issue. After a couple of months it's assumed that the WikiProject will need to take on the task, and project members use their common.css files to keep the templates visible. The community consensus is that this issue is insufficiently critical to merit notifying general readers of the issue for more than a couple of months, unless the article has {{tl|multiple issues}}. Please review the discussions related to this on [[Template talk:Orphan]] and its archives.

==Automated placement and adjustment==
Several semi-automated tools and bots facilitate orphan-tagging. Some notes on tool implementation:
* Per [[Wikipedia talk:AutoWikiBrowser/Feature requests/Archive 7#Another tweak for orphans|Another tweak for orphans]], as of March 9, 2010{{needs update}} [[Wikipedia:AutoWikiBrowser|AutoWikiBrowser]] (AWB) restricts orphan tag addition to linkless pages as a default option.
* Per [[Wikipedia talk:AutoWikiBrowser/Feature requests/Archive 7#Move orphan (and some more) tags on the top|Move orphan (and some more) tags on the top]], AWB moves incorrectly positioned orphan tags to the correct location for orphan tags, at or near the top of the article.

==Parameters==

===date===
You may use a date parameter with this template, for example <code><nowiki>{{Orphan|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code> to help with the categorisation of articles requiring links. If you leave it out, a [[WP:BOT|bot]] will fill it in (but this will result in more edits and watchlist alerts, so adding the date right away is preferred).

===att===
If you have made an unsuccessful attempt to de-orphan the article, then please add the month/year of the attempt to the template, like so, <code><nowiki>{{orphan|date=</nowiki>Month Year<nowiki>|att=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>, where the {{para|date}} parameter is the date the template was ''originally'' placed on the page, and the {{para|att}} parameter is set to equal the ''current'' month and year. This places it in [[:Category:Attempted de-orphan]] for that date and also hides the article message box. The "att" is an abbreviation for "attempt", as in "I attempted to de-orphan this article but failed".

===incat===
If the article has no link and probably never will, but is well categorised the incat option can be used. For example, <code><nowiki>{{Orphan|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>|incat=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>

Per the discussion at [[template talk:Orphan/Archive 2#"Few links" template?]], this parameter was, but is not currently, used in the template itself.

==TemplateData==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "This template should only be put on articles which meet the orphan criteria.",
	"params": {
		"date": {
			"label": "Date",
			"description": "The date this template was added to the page. (Input: Monthname Year)",
			"type": "string",
			"required": true,
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}"
		},
		"att": {
			"label": "De-orphan attempt",
			"description": "If you have made an unsuccessful attempt to de-orphan the article, please fill in this field to record the attempt. (Input: Monthname Year)",
			"type": "string",
			"required": false
		},
		"incat": {
			"label": "In Category",
			"description": "If the article has no link and probably never will, but is well categorised this option can be used.(Input: Monthname Year)",
			"type": "string",
			"required": false
		}
	}
}
</templatedata>

==Categories==
This template places the article into "Category:All orphaned articles" as well as "Category:Orphaned articles from {{{date}}}".
If the "<code>att</code>" parameter is set, the article will still be in [[:Category:All orphaned articles]], but instead of placing the article into "Category:Orphaned articles from {{{date}}}" (e.g. [[:Category:Orphaned articles from {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]]), it places it into "Category:Attempted de-orphan from {{{att}}} (e.g. [[:Category:Attempted de-orphan from {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]]).

==See also==
* [[Wikipedia:AutoWikiBrowser/General fixes#Mainspace tagger]]
* [[User:Magioladitis/AWB and orphans]]
* [[User:CleanupWorklistBot]]
** e.g., for [[Wikipedia:WikiProject Athletics|WikiProject Athletics]]: [https://tools.wmflabs.org/bambots/cwb/bycat/Athletics.html#Orphaned%20articles Cleanup listing]
** e.g., [[Wikipedia:WikiProject Tennis/Cleanup listing]]
* [[Wikipedia:Bots/Requests for approval/Addbot 16]]
* [[Wikipedia:Bots/Requests for approval/Addbot 18]]
* [[Wikipedia:WikiProject Orphanage]]
* {{tl|Orphaned essay}}: for orphaned [[Wikipedia:Wikipedia essays|essays]] in the [[Wikipedia:Project namespace|project namespace]]

<includeonly>{{Sandbox other||
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Internal link maintenance templates|{{PAGENAME}}]]
[[Category:Templates for orphaned articles|{{PAGENAME}}]]

}}</includeonly>