Template:Engineering/doc

From Wikipedia, the free encyclopedia

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

[edit] Usage

This template {{Engineering}} adds articles to subcategories of Category:WikiProject Engineering and is a self-reference. Please add it to talk pages of relevant articles and non-article pages.

This template should be transcluded as {{Engineering}} and not substituted {{subst:}} because it employs conditional code. Transclusion also allows easy updating of all the WikiProject's talk pages without having to edit thousands of pages individually. For examples of how the template will appear under various parameter scenarios, please see WikiProject Engineering/Examples.

The template also employs several optional data field parameters as described below. The full syntax is as follows:

{{Engineering
|class=
|importance=
|imageneeded=
|in=
|in2=
|in3=
|imagedetails=
|unref=
|nested=
|past-collaboration=
|past-selected-article=
|past-selected-picture=
|peer-review=
|old-peer-review=
|attention=
|small=
}}

[edit] Parameters legend

  • class: FA, FL, A, GA, B, Start, Stub, List, NA, Cat, Dab, Image, Portal, Project, Redirect, Template, and blank (#default). NA is "non article", which includes categories, disambiguous pages, images, portals, project namespace (e.g., prefix Wikipedia: also called the Wikipedia namespace), redirects, and templates. Some of the option descriptions may be found at WikiProject Engineering/Quality scale.
  • importance: Top, High, Mid, Low, NA, and blank (#default). Some of the option descriptions may be found at WikiProject Engineering/Importance scale.
  • imageneeded: Answer yes to request that a photograph, map, drawing, diagram, equation, or other image be added to the page. Leave blank or delete if not.
  • in: Used in conjunction with the imageneeded=yes parameter to place the image request into a specific location, such as a Engineering county. For example, "in=Los Angeles County, California" will place the article talk page into Category:Wikipedia requested photographs in Los Angeles County, California. Leave blank or delete if not.
    • Additional in2 and in3 parameters used in conjunction with the imageneeded=yes parameter may be used to specify up to three total location categories (such as for celebrities and other people who may frequent multiple county locations).
  • imagedetails: This free-form parameter can be used in conjunction with the imageneeded parameter to add specific details about the images being requested. For example, "imagedetails=Please add an action shot to this article." will add the following to the template display: "An editor suggests the following: Please add a live-action shot to this article."
  • unref: Answer yes if the page needs additional references or inline citations. Leave blank or delete if not.
  • nested: Answer yes to nest the template, such as under {{WikiProjectBannerShell}}. Leave blank if not yet.
  • past-collaboration: Enter Month Year (e.g., "past-collaboration=February 2007") if the page previously was selected as the WikiProject's collaboration of the week/month. Leave blank or delete if not.
  • past-selected-article: Enter Month Year (e.g., "past-selected-article=March 2007") if the article previously was selected as the Engineering Portal's article of the month. Leave blank or delete if not.
  • past-selected-picture: Enter Month Year (e.g., "past-selected-picture=March 2008") if the image previously was selected as the Engineering Portal's picture of the month. Leave blank or delete if not.
  • peer-review: Enter yes if the page currently being peer reviewed.
  • old-peer-review: Enter yes if the page has had a peer reviewed.
  • auto: This parameter is set to yes by bots that automatically assess a page as Stub-class if the page uses a stub template.
  • attention: Answer yes if the page needs immediate attention. Leave blank or delete if not.
  • small: Answer yes to make the template smaller and lined up vertically on the right side of the talk page.

[edit] Notes

To avoid needlessly cluttering up talk pages, it is usually appropriate to remove any unused parameters from the template. A common initial configuration for the template includes the following basic parameters:

{{Engineering|class=|importance=|imageneeded=|imagedetails=|in=|unref=|nested=}}