Template:Contact/Documentation: Difference between revisions

Latest revision as of 17:14, 1 May 2025

Template:Contact is used on Contact Character pages to identify the type and ratings of a Player Character's Contacts.

Usage

When first invoked on a character page, it has three numbered mandatory string parameters and multiple named mandatory integer parameters.

1 must be the name of a Player Character.
2 must be the contact's type; it will be parsed by Template:SplitP, so parenthetical notations are ignored.
3 is the center of the contact's operations.
c is the contact's Connection.
e is the contact's Expertise.
l is the contact's Loyalty.

It also has three optional parameters

s (default: 0) is the contact's Size.
skills only applies to Service and Legwork Contacts.
name (default: {{PAGENAME}}) overides the text label on the infobox.

The second time it is invoked on a page, only l is required — all other parameters flow from the first instance.

Returns

{{Contact|Rook|Transportation (Aerospace)|Seattle Metroplex|skills=Things, Stuff|c=3|e=3|l=4|s=0}} returns:

In addition, it adds the page to Contact along with an appropriate subcategory for it's type.

@@ Line 1: / Line 1: @@
 <includeonly>[[Category:Character Template]]</includeonly>
-<!--Template Description-->
+{{Template|Contact}} is used on {{Category|Contact}} {{Category|Character}} pages to identify the type and ratings of a {{Category|Player Character}}'s [[Contacts]].
 ==Usage==
-<!--Parameters and such go here.-->
+When first invoked on a character page, it has three numbered {{Parameter|mandatory|string}}s and multiple named {{Parameter|mandatory|integer}}s.
+* {{Code|1}} must be the name of a {{Category|Player Character}}.
+* {{Code|2}} must be the [[Contacts#Contact Types|contact's type]]; it will be parsed by {{Template|SplitP}}, so parenthetical notations are ignored.
+* {{Code|3}} is the center of the contact's operations.
+* {{Code|c}} is the contact's [[Contacts#Connection|Connection]].
+* {{Code|e}} is the contact's [[Contacts#Expertise|Expertise]].
+* {{Code|l}} is the contact's [[Contacts#Loyalty|Loyalty]].
+It also has three {{Parameter|optional}}s
+* {{Code|s}} (default: {{Code|0}}) is the contact's [[Contacts#Size|Size]].
+* {{code|skills}} only applies to Service and Legwork Contacts.
+* {{code|name}} (default: {{Code|<nowiki>{{PAGENAME}}</nowiki>}}) overides the text label on the infobox.
+The second time it is invoked on a page, only {{Code|l}} is required &mdash; all other parameters flow from the first instance.
 ==Returns==
-<!--Examples go here.-->
+{{Code|<nowiki>{{Contact|Rook|Transportation (Aerospace)|Seattle Metroplex|skills=Things, Stuff|c=3|e=3|l=4|s=0}}</nowiki>}} returns: {{Return|{{Contact|Rook|Transportation (Aerospace)|Seattle Metroplex|skills=Things, Stuff|c=3|e=3|l=4|s=0}}}}
+In addition, it adds the page to {{Category|Contact}} along with an appropriate subcategory for it's type.