Template:Item/Documentation: Difference between revisions

Help

Latest revision as of 05:37, 3 December 2023

Template:Item simplyfies the wiki syntax for creating shortened, more readable links to Item articles.

It accepts one mandatory string parameter and one optional string parameter.

Will be combined with the string Item to create a link to a Item article, so it must be a page that exists.
- ammo can be substituted for Ammunition
- modification and mod can be substituted for Gear Modification
If set to s will adjust the returned text as pluralized for words that don't simply slap an "s" on the end: Echo, Quality, Summon/Compile, and Compile. It has no effect when used with other initial parameters.

{{Item|Echo}} returns:

{{Item|Echo}}s returns...

...which is undesirable.

Instead, use {{Item|Echo|s}} to return:

@@ Line 3: / Line 3: @@
 ==Usage==
 It accepts one {{Parameter|mandatory|string}} and one {{parameter|optional|string}}.
-# Will be combined with the string {{Code|&nbsp;Item}} to create a link to a {{Category|Item}} article, so it must be a page that exists. There is no valiation.
+# Will be combined with the string {{Code|&nbsp;Item}} to create a link to a {{Category|Item}} article, so it must be a page that exists.
-# If set to {{Code|s}} will adjust the returned text as pluralized for words that don't simply slap an "s" on the end, {{code|Echo}} and {{Code|Summon/Compile}}. It has no effect when used iwth other initial parameters.
+#* {{Code|ammo}} can be substituted for {{Code|Ammunition}}
+#* {{Code|modification}} and {{Code|mod}} can be substituted for {{Code|Gear Modification}}
+# If set to {{Code|s}} will adjust the returned text as pluralized for words that don't simply slap an "s" on the end: {{Code|Echo}}, {{Code|Quality}}, {{Code|Summon/Compile}}, and {{Code|Compile}}. It has no effect when used with other initial parameters.
 ==Returns==
 {{Code|<nowiki>{{Item|Echo}}</nowiki>}} returns: {{Return|{{Item|Echo}}}}
 {{Code|<nowiki>{{Item|Echo}}s</nowiki>}} returns... {{Return|{{Item|Echo}}s}}
 ...which is undesirable.
-Instead, use {{Code|<nowiki>{{Item|Echo|s}}</nowiki>}} to returns: {{Return|{{Item|Echo|s}}}}
+Instead, use {{Code|<nowiki>{{Item|Echo|s}}</nowiki>}} to return: {{Return|{{Item|Echo|s}}}}