User:Magill/Project-Documentation common parameters

From Lotro-Wiki.com
Jump to: navigation, search

Goal of this page

This page intends to define and document the "standard" opening parameters for use in all templates.

It still needs much work.

References

Background

Most templates are built using various other templates. Many of these are classified in "Category: Utility Templates

  • Tooltip enabled pages are currently all pages using
Template: Item Tooltip
Template: Effect
Template: Recipe
Template: Skill
Template: Trait


General: failure modes

Page Naming

There are three different "names" associated with each Article (page) in the Wiki.
Display failures occur when there is a "mis-match" amongst these three.
  1. The "actual page name" by which the WIKI stores the page in its database -- this is "not editable" and appears at the top of the page.
    To change this name, you must either "Move" the page or "Delete" the old page and re-create it with the new name.
  2. The "| name =" parameter in most Templates. This is simply the "display" name, used on, typically, the Tooltip created.
  3. The "| disambigpage=" parameter in most Templates. This is the key parameter. (I wish I knew what it really does/how/why it works).
  4. This is normally created by the template using "subst: PAGENAME" or "SUBPAGNAME"
Most typically, when the "disambigpage" parameter does not equal the "actual page name" the page does not display correctly.
Usually this incorrect display is a "left-right" switch. I.e. items which should display on the right side of the page display on the left.

Opening parameters common to "all" Templates

The following group of parameters should begin and be common across all Templates and pages.
In fact, not all pages and templates have all of the parameters.
  • This is a standardization project which needs to be worked on.
Templates to which this applies (all utilize Template: Tooltip )


 | mode            = {{{mode|}}}
 | arg             = {{{arg|}}}
 | amount          = {{{amount|}}}
 | nocat           = Blank or Yes. If yes, then do NOT perform automatic categorization for this article.
 | name            = {{subst:PAGENAME}}
 | icon            = -icon
 | disambigpage    = {{subst:FULLPAGENAME}}
 | quality         = <!-- Common, Uncommon, Rare, Incomparable, Epic -->
| mode = {{{mode |}}}
This value should never be modified. It passes the appropriate information along to subsequent templates.
| arg = {{{arg |}}}
This value should never be modified. It passes the appropriate information along to subsequent templates
| amount = {{{amount|}}}
This value should never be modified. It passes the appropriate information along to subsequent templates.
  • "arg" and "amount" are apparently used interchangeably, depending upon the template author.
| nocat =
Blank or Yes. If yes, then do NOT perform automatic categorization for this article.
  • This parameter has not been implemented in all templates.
| name=
The name of the item/effect/etc, displayed at the top of the box just to the right of the icon in the Tooltip.
The value, {{subst:PAGENAME}}, found in most templates usually works well, but if the item name does not equal the "actual page name," replace the code with the item name spelled exactly as in-game.
Example: the actual page is named "Chainsaw (Level 33)" but the item is named "Chainsaw" (and assumingly other Chainsaw pages exist).
| icon =
The filename (omit ".png") of the icon to be displayed at the top left of the tooltip.
Icons display at 32px when name matches disambigpage, 24px otherwise
  • This comment about icon size needs to be verified
Please use generic icons as far as possible. Navigate to wanted category from Category:Item Icons. Should an icon not exist, use the exact page name to avoid issues with names containing diacritics and apostrophes (do not use Magill/Project-Documentation common parameters). Neither Image: nor File: nor .PNG is necessary. Example: "Cloak 1 (incomparable)-icon"
| disambigpage = {{subst:FULLPAGENAME}}
Please retain {{subst:FULLPAGENAME}} in the disambigpage field of the Template. Otherwise you must use &#39; instead of any apostrophe ( ' ).
| quality=
item quality, passed to {{quality}} to generate formatted item name. Examples: Common, Uncommon, Rare, Incomparable, Epic
  • Note: "subst:" means -- Substitute. Therefore: {{subst:PAGENAME}} will be replaced (substituted) with the value of PAGENAME when the page is saved.


There are many more parameters in the Template: Tooltip than are used in most templates. "Mode=" Usage options are defined at Template: Tooltip

The following modes are used directly with things such as {{:Item: xxx|mode=link}}
  • mode=link
  • mode=icon
  • mode=imlink
  • mode=tableimlink

boilerplate for Category: Template Documentation files

== Description ==
=== Syntax ===
<blockquote>
=== Parameters explained ===
</blockquote>
=== Example ===
<includeonly>[[Category: General Wiki Templates]]</includeonly>
<noinclude>[[Category: Template Documentation]]</noinclude>