Template:Orphan/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

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 7 orphaned articles.

How to use

The simplest way to add this template to an article is to copy and paste either {{Orphan|date=November 2024}} or {{Orphan|{{subst:DATE}}}} at the top of the article.

  • Please do not subst: this template.

When to use

This template should only be put on articles which meet the orphan criteria. Use your judgment about whether to add this template. Do not add this template to articles that you honestly believe [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 parameter is set to either the current month or the previous month (currently November 2024 or October 2024). It is also visible on all pages where it is used inside the {{multiple issues}} template. Older-dated orphan templates used outside of the {{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 common.css file (create the file if you don't have one yet):

.ambox-Orphan{display: table !important;}

This may not work in some older browsers - if it doesn't work, use

.ambox-Orphan{display: block !important;}

instead.

Alternatively, to never see this tag, you could instead add to your common.css:

.ambox-Orphan{ display: none !important; }

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.

Parameters

date

You may use a date parameter with this template, for example {{Orphan|date=November 2024}} to help with the categorisation of articles requiring links.

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, {{orphan|date=Month Year|att=November 2024}}, where the |date= parameter is the date the template was originally placed on the page, and the |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, {{Orphan|date=November 2024|incat=November 2024}}


TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Orphan in articles based on its TemplateData.

TemplateData for Orphan

<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": "August 2023" }, "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 "att" 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 November 2024), it places it into "Category:Attempted de-orphan from {{{att}}} (e.g. Category:Attempted de-orphan from November 2024).

See also