Difference between revisions of "Template:Argbox/doc"
From Game Detectives Wiki
[checked revision] | [checked revision] |
Line 125: | Line 125: | ||
| Status of the ARG | | Status of the ARG | ||
| | | | ||
− | | <code>Active</code>, <code>On Hold</code>, <code>Completed</code> or <code> | + | | <code>Active</code>, <code>On Hold</code>, <code>Completed</code> or <code>Discontinued</code> |
| String | | String | ||
| Optional | | Optional |
Revision as of 23:19, 30 May 2018
This is a documentation subpage for Template:Argbox. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on a very large number of pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing any changes on the talk page before implementing them. |
- Description
This is the {{argbox}} or ARG Info Box meta-template. This template is used to create an arg infobox on a given page, as well as assign the page to a category determined by the root page name.
- Syntax
Type {{argbox}}
somewhere, with parameters as shown below.
- Sample output
{{argbox | float = left | name = Valve ARG | image = File:Example.png | imagewidth = 150 | description = This it the description of an arg, I somehow forgot about it | creator = [[Valve]] | creator2 = [[Valve]] | type = Official | status = Completed | discovered = 1970-01-01 | completed = 1971-01-01 | closed = 1971-01-01 | reopened = 1972-01-01 | timeline = [[Valve]] }}
Results in...
Valve ARG | |
---|---|
This it the description of an arg, I somehow forgot about it | |
Type | Official |
Creators | Valve & Valve |
Discovered | 1970-01-01 |
Completed | 1971-01-01 |
Closed | 1971-01-01 |
Reopened | 1972-01-01 |
Timeline | Valve |
- Parameters
Parameter | Description | Default | Accepted Values | Type | Status |
---|---|---|---|---|---|
float | box is aligned to the the left or the right. | right
|
left or right
|
String | Optional |
clear | content is delayed until just the right or left column is complete. | right
|
left or right
|
String | Optional |
name | The name of the ARG infobox | Title of the current page | String | Optional | |
image | The thumb of the ARG infobox | Image:Example.png
|
any valid link from local source or external | String | Optional |
imagewidth | Width of the thumb image of the ARG info box | 250
|
any valid integer | Int | Optional |
description | Short description of the ARG | String | Optional | ||
creator | A creator of the ARG | String | Optional | ||
creator2 | A second creator of the ARG | String | Optional | ||
creator3 | A third creator of the ARG | String | Optional | ||
type | The type of the ARG | Official , Unofficial , Investigation
|
String | Optional | |
status | Status of the ARG | Active , On Hold , Completed or Discontinued
|
String | Optional | |
discovered | Date of the ARG discovery, YYYY-MM-DD | Date | Optional | ||
completed | Date of the ARG completion, YYYY-MM-DD | Date | Optional | ||
closed | Date of the ARG closing, YYYY-MM-DD (to be used ONLY in conjunction with reopened) | Date | Optional | ||
reopened | Date of the ARG reopening, YYYY-MM-DD | Date | Optional | ||
timeline | Wikilink to the timeline article of the ARG | String | Optional | ||
halloffame | Whether to render a link to a Hall of Fame | true or emtpy
|
Boolean | Optional |