Template:Contact/Documentation: Difference between revisions

Revision as of 15:02, 31 August 2023

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

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

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

{{Contact|Rook|Transportation (Aerospace)|c=3|e=3|l=4|s=0}} returns:

@@ Line 1: / Line 1: @@
 <includeonly>[[Category:Character Template]]</includeonly>
-{{Template|Contact}} is used on {{Category|Character}} pages to identify the type and ratings of a {{Category|Player Character}}'s [[Contacts]].
+{{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 two numbered {{Parameter|mandatory|string}}s and four named {{Parameter|mandatory|integer}}s.
+* {{Code|1}} must be the name of a {{Category|Player Character}}.
+* {{Code|2}} must be the type of [[Contact]].
+* {{Code|c}} is the contact's [[Contact#Connection|Connection]].
+* {{Code|e}} is the contact's [[Contact#Expertise|Expertise]].
+* {{Code|l}} is the contact's [[Contact#Loyalty|Loyalty]].
+* {{Code|s}} is the contact's [[Contact#Size|Size]].
+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)|c=3|e=3|l=4|s=0}}</nowiki>}} returns: {{Return|{{Contact|Rook|Transportation (Aerospace)|c=3|e=3|l=4|s=0}}}}