Anonymous
×
Create a new article
Write your page title here:
We currently have 55 articles on SR5 Foundry VTT System Wiki. Type your article name above or click on one of the titles below and start writing!



SR5 Foundry VTT System Wiki

Template:Parameter/Documentation

Revision as of 20:21, 19 November 2023 by Mr. Johnson (talk | contribs) (Created page with "<includeonly>Category:Categorization Template</includeonly> {{Template|Parameter}} is used with in the template namespace to identify and categorize templates based on their usage of parameters. ==Usage== It accepts one {{Parameter|mandatory}}, one of {{Code|mandatory}}, {{Code|optional}}, {{Code|no}}, or {{Code|none}}. It also accepts one {{Parameter|optional|string}}, arbitrary text describing the parameter, typically something like {{Code|string}} or {{Code|integ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Template:Parameter is used with in the template namespace to identify and categorize templates based on their usage of parameters.

Usage

It accepts one mandatory parameter, one of mandatory, optional, no, or none.

It also accepts one optional string parameter, arbitrary text describing the parameter, typically something like string or integer.

Return

None of these will work correctly in the documtation subpage, but will appear in the actual documentation. It's invoked twice above, but for clarity sake...

{{Parameter|mandatory}} adds the template to the Templates with Mandatory Parameters category and returns:

mandatory parameter

{{Parameter|optional}} adds the template to the Templates with Optional Parameters category and returns:

optional parameter

{{Parameter|no}} or {{Parameter|none}} adds the template to the Templates without Parameters category and returns:

no parameters

The optional parameter is inserted between the two words. For instance, {{Parameter|optional|magenta}} returns:

optional magenta parameter