Template:Top/doc

From SW420
Jump to navigation Jump to search

Usage instructions

Add {{Top}} to the top of the article page. 

{{Top}}

As standard, order the template's fields like so: 

{{Top|btr|old|imp|reb|new|njo|lgc|real|fa|ffa|ga|fga|ca|fca|protection level|can|leg|canon=Some article|legends=Some article|hide=1|title=''Avenger''|title2=''Imperial''-class}}

Titles

  • title - use to italicize the part of the article title that is not in parentheses. Similarly, this parameter is also used to italicize or otherwise modify the title displayed when the article name includes "/Canon".
  • title2 - use if the page's name includes a parenthetical descriptor and you wish to italicize part of the parenthetical descriptor.
  • notitle - used to disable the title functionality, allowing for articles with mid-title parentheses to be unaffected.

Canon/Legends specifications

  • can - displays the canon banner. Only necessary on OOU articles; the canon banner is default for IU
  • leg - displays the Legends banner. Only necessary if the Legends banner is not already displayed by other criteria. These are: if an article has "/Legends" in its title, if an article has a canon counterpart with "/Canon" in its title, if the parameter "canon=" is used, or if an eras icon is used
  • legends - page name of the Legends article for the subject; defaults to "PAGENAME/Legends" (unless the current article ends with "/Canon", in which case this is subtracted)
  • canon - page name of the canon article for the subject; defaults to subtracting "/Legends" from the current page name (unless this name lacks this suffix, in which case "/Canon" is added)
  • noncanon - overrides the application of the Legends or Canon categories, preventing redundant categorization when the {{Noncanon}} template is used.
  • hide - hides the tab system. Can be used when articles in both continuities have identical names but are about different subjects and should therefore not be linked.
  • ncc - displays the non-canon banner with the black canon background
  • ncl - displays the non-canon banner with the yellow Legends background

Including a publishing era (see below) negates the use for type specification, as publishing eras are Legends only.

Publishing eras (Legends only)

Note: In-universe articles may not use parameters pertaining to Legends publishing eras in the Top template. These parameters may only be used on out-of-universe articles.

Other

Protection specifications

  • fprot - Articles fully protected against editing and/or moving
  • sprot - Articles semi-protected against editing and/or moving
  • ssprot - Articles super-semi-protected against editing
  • mprot - Articles fully protected against moving only
  • uprot - Files fully protected against uploading only

Note on banners: This template will not display the Legends banners on any non-mainspace article or any article that includes "real" as one of its parameters. If you wish to override this (for example, a video game or novel article), add either "canon" or "legends" as one of the parameters in the template to generate the correct banner.

Note on categories: Featured, former featured, good, former good, comprehensive, former comprehensive, fully protected, semi-protected, super-semi-protected, move protected articles, and the upload protected files are added automatically to their respective categories: Category:Wookieepedia Featured articles, Category:Wookieepedia former Featured articles, Category:Wookieepedia Good articles, Category:Wookieepedia former Good articles, Category:Wookieepedia Comprehensive articles, Category:Wookieepedia former Comprehensive articles, Category:Protected pages, Category:Semi-protected pages, Category:Super-semi-protected pages, Category:Move protected pages, and Category:Upload protected files.

Additional notes: The options that include the suffix "prot" will automatically detect the actual protection level on the page (except "ssprot", which uses the AbuseFilter and thus must be checked manually). If the protection level does not match the icon used, the icon will not be displayed and the page will be automatically added to Category:Pages with incorrect protection icons. Also, if the parameter does not match a valid option, the page will be placed into Category:Pages with bad parameters in Template:Top.

Example

{{Top|imp|reb|new}}
Retrieved from "https://sw420.com/index.php?title=Template:Top/doc&oldid=157817"