View source for Template:Orphan/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{Twinkle standard installation}}

'''Template:Orphan''' is responsible for populating sub-categories of [[:Category:Orphaned articles]].

==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.

==When to use==
This template should only be put on articles which meet the [[WP:Orphan#Criteria|orphan criteria]].

==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 [[LIMSWiki:Substitution|subst:]] this template.

==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>'''Month Year'''<nowiki>}}</nowiki>'''</code>,

where the "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.

===few===
If the article only has one or two links to it and it is felt more are required and possible the few option can be used. For example, <code><nowiki>{{Orphan|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>|few=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>

Setting the |few= parameter populates [[:Category:Low linked articles]].

Per [[special:permalink/553836193#few orphan tag|this request]], [[WP:AWB|AWB]] does not remove <nowiki>{{orphan}}</nowiki> if |few= is set.

Per the discussion at [[template talk:Orphan#"Few links" template?]], this parameter was limited to populating [[:Category:Low linked articles]], and the "as few other articles link to it" message was removed.

===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#"Few links" template?]], this parameter was, but is not currently, used in the template itself.

==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}}]]).


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