Difference between revisions of "Template:Argbox/doc"
From Game Detectives Wiki
| [checked revision] | [checked revision] |
| (23 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<noinclude>{{Documentation subpage}} | <noinclude>{{Documentation subpage}} | ||
{{high-risk}}</noinclude> | {{high-risk}}</noinclude> | ||
| − | |||
;Description | ;Description | ||
| − | + | This is the {{t|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 | ;Syntax | ||
| − | + | Type <code>{{t|argbox|...}}</code> somewhere, with parameters as shown below. | |
;Sample output | ;Sample output | ||
<pre>{{argbox | <pre>{{argbox | ||
| float = left | | float = left | ||
| name = Valve ARG | | name = Valve ARG | ||
| − | | image = File: | + | | image = File:NewExample3.png |
| − | | imagewidth = | + | | imagewidth = 400 |
| description = This it the description of an arg, I somehow forgot about it | | description = This it the description of an arg, I somehow forgot about it | ||
| − | | creator = Valve | + | | creator = [[Valve]] |
| + | | creator2 = [[Valve]] | ||
| type = Official | | type = Official | ||
| − | | status = | + | | status = Active |
| − | | discovered = 1970-01- | + | | discovered = 1970-01-31 |
| − | | completed = 1971-01- | + | | completed = 1971-01-31 |
| − | | closed = 1971-01- | + | | closed = 1971-01-31 |
| − | | reopened = 1972-01- | + | | reopened = 1972-01-31 |
| timeline = [[Valve]] | | timeline = [[Valve]] | ||
}}</pre> | }}</pre> | ||
| Line 28: | Line 28: | ||
| float = left | | float = left | ||
| name = Valve ARG | | name = Valve ARG | ||
| − | | image = File: | + | | image = File:NewExample3.png |
| − | | imagewidth = | + | | imagewidth = 400 |
| description = This it the description of an arg, I somehow forgot about it | | description = This it the description of an arg, I somehow forgot about it | ||
| creator = [[Valve]] | | creator = [[Valve]] | ||
| − | | status = | + | | creator2 = [[Valve]] |
| − | | type = | + | | status = Active |
| − | | discovered = 1970-01- | + | | type = OfficialExample |
| − | | completed = 1971-01- | + | | discovered = 1970-01-31 |
| − | | closed = 1971-01- | + | | completed = 1971-01-31 |
| − | | reopened = 1972-01- | + | | closed = 1971-01-31 |
| + | | reopened = 1972-01-31 | ||
| timeline = [[Valve]] | | timeline = [[Valve]] | ||
}} | }} | ||
{{clear}} | {{clear}} | ||
| − | + | ;Parameters | |
| − | {| class="wikitable" | + | {| class="wikitable sortable" |
! Parameter | ! Parameter | ||
! Description | ! Description | ||
| Line 80: | Line 81: | ||
|- | |- | ||
| imagewidth | | imagewidth | ||
| − | | Width of the thumb image of the ARG info box | + | | Width of the thumb image of the ARG info box. Also controls the width of the argbox itself. |
| − | |<code> | + | |<code>400</code> |
|any valid integer | |any valid integer | ||
| Int | | Int | ||
| Line 94: | Line 95: | ||
|- | |- | ||
| creator | | 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 | | String | ||
| Optional | | Optional | ||
| Line 103: | Line 118: | ||
| The type of the ARG | | The type of the ARG | ||
| | | | ||
| − | | <code>Official</code>, <code> | + | | <code>Official</code>, <code>Unofficial</code>, <code>Investigation</code> |
| String | | String | ||
| Optional | | Optional | ||
| Line 110: | 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 | ||
| Line 129: | Line 144: | ||
|- | |- | ||
| closed | | closed | ||
| − | | Date of the ARG closing, YYYY-MM-DD | + | | Date of the ARG closing, YYYY-MM-DD |
| | | | ||
| | | | ||
| Line 150: | Line 165: | ||
|- | |- | ||
| halloffame | | halloffame | ||
| − | | | + | | Whether to render a link to a Hall of Fame |
| | | | ||
| <code>true</code> or emtpy | | <code>true</code> or emtpy | ||
| Boolean | | Boolean | ||
| + | | Optional | ||
| + | |- | ||
| + | | popupContent | ||
| + | | Manual override for given arg's investigation list dialog popup | ||
| + | | | ||
| + | | Any string including parsable wikitext (no HTML) | ||
| + | | String | ||
| Optional | | Optional | ||
|} | |} | ||
Latest revision as of 14:39, 28 September 2021
 | 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:NewExample3.png
| imagewidth = 400
| description = This it the description of an arg, I somehow forgot about it
| creator = [[Valve]]
| creator2 = [[Valve]]
| type = Official
| status = Active
| discovered = 1970-01-31
| completed = 1971-01-31
| closed = 1971-01-31
| reopened = 1972-01-31
| 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-31 |
| Completed | 1971-01-31 |
| Closed | 1971-01-31 |
| Reopened | 1972-01-31 |
| 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. Also controls the width of the argbox itself. | 400
|
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 | 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 | |
| popupContent | Manual override for given arg's investigation list dialog popup | Any string including parsable wikitext (no HTML) | String | Optional |
