Difference between revisions of "Help:Templates"
sc4e>JoeST m (→Infobox Templates: added infobox TGI) |
m (49 revisions imported) |
||
(39 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
A list of templates and reasons why you would use them, including appropriate locations, etc... | A list of templates and reasons why you would use them, including appropriate locations, etc... | ||
− | + | ==How to Use a Template== | |
+ | To use a template in a document just include the code in the ''What you type'' column in the tables below. Or use the info under the Syntax heading on the template page itself. Remember to fill in all the parameters associated with the template, or it wont display properly. | ||
− | + | For example, to include the Language template (on a page with Dutch, French and Japanese translations): | |
− | <pre>{| | + | <pre>{{Languages|nl|fr|ja}}</pre> will look like this: |
− | + | {{Languages|nl|fr|ja}} | |
− | |||
− | |||
− | |||
− | |||
− | |} | ||
− | + | ==Curent Templates== | |
− | + | The the sections below show all of the templates currently available on the wiki. | |
− | + | ===Userpage Templates=== | |
− | + | {{main|Help:Userboxes}} | |
− | + | {| border="1" cellspacing="0" cellpadding="5" width=100% | |
− | + | ! style="background:#1e90ff;"| Template Name | |
− | + | ! style="background:#1e90ff;"| What you type | |
− | + | ! style="background:#1e90ff;"| What you see | |
− | + | ! style="background:#1e90ff;"| Variables | |
− | |||
− | |||
− | ==Userpage Templates== | ||
− | |||
− | {| border="1" cellspacing="0" cellpadding="5" | ||
− | ! style="background:# | ||
− | ! style="background:# | ||
− | ! style="background:# | ||
− | ! style="background:# | ||
|- | |- | ||
− | | | + | | {{tll|SiteProfile}} |
| <nowiki>{{SiteProfile| site = | id = | name = }}</nowiki> | | <nowiki>{{SiteProfile| site = | id = | name = }}</nowiki> | ||
− | | | + | | {{SiteProfile| site = sc4d | id = 11 | name = Freedo50}} |
− | |||
| | | | ||
− | *'''site''' - The name of the site | + | *'''site''' - The name of the site |
*'''id''' - Your user ID | *'''id''' - Your user ID | ||
*'''name''' - (optional) can be added if you want your name to replace "My" | *'''name''' - (optional) can be added if you want your name to replace "My" | ||
+ | |- | ||
+ | | {{tll|Userbox}} | ||
+ | | <pre>{{Userbox | ||
+ | | border-c = | ||
+ | | border-s = | ||
+ | | id-c = | ||
+ | | id-s = | ||
+ | | id-fc = | ||
+ | | id-fs = | ||
+ | | id-p = | ||
+ | | id-lh = | ||
+ | | info-c = | ||
+ | | info-s = | ||
+ | | info-fc = | ||
+ | | info-fs = | ||
+ | | info-p = | ||
+ | | info-lh = | ||
+ | | id = | ||
+ | | info = | ||
+ | }}</pre> | ||
+ | | {{Userbox}} | ||
+ | | | ||
+ | * '''border-c:''' The border colour of the userbox | ||
+ | * '''border-s:''' The border size of the userbox | ||
+ | * '''id-c:''' The background colour of the id box | ||
+ | * '''id-s:''' The font size of the id box | ||
+ | * '''id-fc:''' The font colour of the id box | ||
+ | * '''id-p:''' The distance between the border and the content of the id box | ||
+ | * '''id-lh:''' The distance between lines of text in the id box | ||
+ | * '''info-c:''' The background colour of the info box | ||
+ | * '''info-s:''' The font size of the info box | ||
+ | * '''info-fc:''' The font colour of the info box | ||
+ | * '''info-p:''' The distnace between the border and the content of the info box | ||
+ | * '''info-lh:''' The distance between lines of text in the info box | ||
+ | * '''id:''' The content of the id box | ||
+ | * '''info:''' The content of the info box | ||
|} | |} | ||
− | ==Infobox Templates== | + | ===Infobox Templates=== |
− | {| border="1" cellspacing="0" cellpadding="5" | + | {| border="1" cellspacing="0" cellpadding="5" width=100% |
− | ! style="background:# | + | ! style="background:#1e90ff;"| Template Name |
− | ! style="background:# | + | ! style="background:#1e90ff;"| What you type |
− | ! style="background:# | + | ! style="background:#1e90ff;"| What you see |
− | ! style="background:# | + | ! style="background:#1e90ff;"| Variables |
|- | |- | ||
− | | | + | | {{tll|Infobox TGI}} |
− | | < | + | | <pre>{{Infobox TGI |
+ | | name = | ||
+ | | format = | ||
+ | | type = | ||
+ | | group = | ||
+ | | instance = | ||
+ | | comments = }}</pre> | ||
+ | | See [[Template:Infobox_TGI#Example| the template description]] for details | ||
| | | | ||
− | + | *'''name''' - The name of the TGI. | |
− | |||
− | *'''name''' - | ||
*'''format''' - | *'''format''' - | ||
*'''type''' - The Type ID of the object, defines what file type the file is (?) | *'''type''' - The Type ID of the object, defines what file type the file is (?) | ||
*'''group''' - The Group ID of the object | *'''group''' - The Group ID of the object | ||
*'''instance''' - The Instance ID of the object | *'''instance''' - The Instance ID of the object | ||
− | *'''comments''' (optional) - | + | *'''comments''' (optional) - Any comments on the TGI. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | | + | | {{tll|Infobox lot}} |
− | | < | + | | <pre>{{infobox lot |
− | | | + | |type = |
− | + | |image1 = | |
+ | |image2 = | ||
+ | |desc = | ||
+ | |credits = | ||
+ | |support = | ||
+ | |download-site = | ||
+ | |download-id = | ||
+ | }}</pre> | ||
+ | | See [[Template:Infobox_lot#Example| the template description]] for details | ||
| | | | ||
*'''type''' - the type of lot it is (either plop or grow). | *'''type''' - the type of lot it is (either plop or grow). | ||
Line 86: | Line 108: | ||
*'''download-id''' - the download lot id | *'''download-id''' - the download lot id | ||
|- | |- | ||
− | | [[Template: | + | | {{tll|Infobox grow}} |
− | | < | + | | <pre>{{infobox grow |
+ | |download-site = | ||
+ | |download-id = | ||
+ | |image1 = | ||
+ | |image2 = | ||
+ | |desc = | ||
+ | |credits = | ||
+ | |support = | ||
+ | |size = | ||
+ | |style = | ||
+ | |type = | ||
+ | |stage = | ||
+ | |occupants = | ||
+ | |worth = | ||
+ | |bulldoze-cost = | ||
+ | |construction-time = | ||
+ | |fire = | ||
+ | |power = | ||
+ | |water = | ||
+ | |air-mag = | ||
+ | |air-spr = | ||
+ | |water-mag = | ||
+ | |water-spr = | ||
+ | |garbage-mag = | ||
+ | |garbage-spr = | ||
+ | |depend = | ||
+ | }}</pre> | ||
+ | | See [[Template:Infobox_grow#Example| the template description]] for details | ||
+ | | | ||
+ | *''image1'', ''image2'', ''desc'', ''credits'', ''support'', ''download-site'', ''download-id'' - See [[Template:Infobox_lot]] for details. | ||
+ | *'''size''' ([a]x[b]) - Lot size a tiles long by b tiles wide. | ||
+ | *'''type''' - The type of lot Residential, Commercial, Industrial, Agricultural | ||
+ | *'''style''' - The [[Tileset]] the lot grows under | ||
+ | *'''stage''' - The [[Growth Stage]] of the lot. | ||
+ | *'''occupants''' - The maximum number of Sims that can live/work in the LOT | ||
+ | *'''worth''' - | ||
+ | *'''bulldoze-cost''' - The number of Simoleons (without the § sign as that is already there) the building costs to demolish. | ||
+ | *'''construction-time''' - The time it takes for the lot to be constructed | ||
+ | *'''fire''' - The maximum fire stage, if the lot reaches this stage in a fire it will be destroyed. | ||
+ | *'''power''' - The amount of electrical power consumed by the lot, in MWh/month. | ||
+ | *'''water''' - The amount of water consumed by the lot, in Gallons/month. | ||
+ | *'''air-mag''' - The magnitued of Air Pollution over '''air-spr''' tiles. | ||
+ | *'''water-mag''' - The magnitude of Water Pollution over '''water-spr''' tiles. | ||
+ | *'''garbage-mag''' - The magnitude of Garbage Pollution over '''garbage-spr''' tiles. | ||
+ | *'''depend - Any dependencies that are needed for this lot to work. | ||
+ | |- | ||
+ | | {{tll|Infobox plop}} | ||
+ | | <pre>{{infobox plop | ||
+ | |download-site = | ||
+ | |download-id = | ||
+ | |image1 = | ||
+ | |image2 = | ||
+ | |desc = | ||
+ | |credits = | ||
+ | |support = | ||
+ | |size = | ||
+ | |menu = | ||
+ | |jobs = | ||
+ | |plop-cost = | ||
+ | |monthly-cost = | ||
+ | |bulldoze-cost = | ||
+ | |park-mag = | ||
+ | |park-spr = | ||
+ | |landmark-mag = | ||
+ | |landmark-spr = | ||
+ | |fire = | ||
+ | |power = | ||
+ | |water = | ||
+ | |air-mag = | ||
+ | |air-spr = | ||
+ | |water-mag = | ||
+ | |water-spr = | ||
+ | |garbage-mag = | ||
+ | |garbage-spr = | ||
+ | |depend = | ||
+ | }}</pre> | ||
+ | | See [[Template:Infobox_plop#Example| the template description]] for details | ||
| | | | ||
− | + | *''image1'', ''image2'', ''desc'', ''credits'', ''support'', ''download-site'', ''download-id'' - See [[Template:Infobox_lot]] for details. | |
− | + | *'''size''' ([a]x[b]) - Lot size a tiles long by b tiles wide. | |
− | + | *'''menu''' - The menu the lot resides in. | |
+ | *'''jobs''' - The number of jobs the lot supplies (can be formatted with $'s if the lot supplies multiple wealth jobs). | ||
+ | *'''plop-cost''' - The number of Simoleons (without the § sign as that is already there) the building costs to build. | ||
+ | *'''bulldoze-cost''' - The number of Simoleons (without the § sign as that is already there) the building costs to demolish. | ||
+ | *'''park-mag''' - The magnitude of Park Effect over '''park-spr''' tiles. | ||
+ | *'''landmark-mag''' - The magnitude of Landmark Effect over '''landmark-spr''' tiles. | ||
+ | *'''fire''' - The maximum fire stage, if the lot reaches this stage in a fire it will be destroyed. | ||
+ | *'''power''' - The amount of electrical power consumed by the lot, in MWh/month. | ||
+ | *'''water''' - The amount of water consumed by the lot, in Gallons/month. | ||
+ | *'''air-mag''' - The magnitued of Air Pollution over '''air-spr''' tiles. | ||
+ | *'''water-mag''' - The magnitude of Water Pollution over '''water-spr''' tiles. | ||
+ | *'''garbage-mag''' - The magnitude of Garbage Pollution over '''garbage-spr''' tiles. | ||
+ | *'''depend - Any dependencies that are needed for this lot to work. | ||
|} | |} | ||
− | ==Request/Marking Templates== | + | ===Request/Marking Templates=== |
{{main|Help:Marking Articles}} | {{main|Help:Marking Articles}} | ||
− | + | {{Help:Marking Articles}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | ==Language Templates== | + | ===Language Templates=== |
− | + | {| border="1" cellspacing="0" cellpadding="5" width=100% | |
− | * | + | ! style="background:#1e90ff;"| Template Name |
+ | ! style="background:#1e90ff;"| What you type | ||
+ | ! style="background:#1e90ff;"| What you see | ||
+ | ! style="background:#1e90ff;"| Variables | ||
+ | |- | ||
+ | | width="10%"| {{tll|Languages}} | ||
+ | | width="10%"| <pre>{{languages | ||
+ | |lang1 | ||
+ | |lang2 | ||
+ | |lang3 | ||
+ | |lang4 | ||
+ | ... | ||
+ | |lang19 | ||
+ | }}</pre> | ||
+ | | width="60%"| {{languages|de|fr|ja|zh}} | ||
+ | | width="20%"| *'''lang''' (multiple, optional) - the 2 character code of the languages where a translation of this page is available. '''The code for English (en) does not need to be inlcuded, its presence is assumed by the template.''' | ||
+ | |} | ||
− | {| border="1" cellspacing="0" cellpadding="5" | + | ===Other Templates=== |
− | ! style="background:# | + | {| border="1" cellspacing="0" cellpadding="5" width=100% |
− | ! style="background:# | + | ! style="background:#1e90ff;"| Template Name |
− | ! style="background:# | + | ! style="background:#1e90ff;"| What you type |
− | ! style="background:# | + | ! style="background:#1e90ff;"| What it does |
+ | ! style="background:#1e90ff;"| Variables | ||
|- | |- | ||
− | | | + | | {{tll|Download}} |
− | | < | + | | <pre>{{Download |
+ | |exchange = | ||
+ | |id = | ||
+ | }}</pre> | ||
+ | | Will provide a link to a download on one of the SC4 Exchanges (SC4D/BSC LEX, STEX, TPPEX or PLEX). | ||
| | | | ||
+ | * '''Exchange:''' The name of the exchange. Can be; LEX, STEX, TPP or PLEX. | ||
+ | * '''id:''' The id of the download on that exchange (if Exchange isn't specified, ID is the full URL). | ||
+ | |- | ||
+ | | {{tll|Main}} | ||
+ | | <pre>{{main|articlename}}</pre> | ||
+ | | Used when transcluding a section of an article to provide a link to the whole article. | ||
+ | | '''articlename:''' Replace this variable with the title of the article you wish to link to. | ||
+ | |} | ||
+ | |||
+ | ===Navbox Templates=== | ||
+ | See [[:Category:General article templates]] for navboxes in use at this site. | ||
− | + | ==How to Make a Template== | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | ||
− | + | [[Category:Templates]] | |
− | |||
− | |||
− |
Latest revision as of 21:36, 3 August 2019
A list of templates and reasons why you would use them, including appropriate locations, etc...
Contents
How to Use a Template
To use a template in a document just include the code in the What you type column in the tables below. Or use the info under the Syntax heading on the template page itself. Remember to fill in all the parameters associated with the template, or it wont display properly.
For example, to include the Language template (on a page with Dutch, French and Japanese translations):
{{Languages|nl|fr|ja}}
will look like this:
Languages: |
English • Dutch (Nederlands) • French (français) • Japanese (日本語)
|
Curent Templates
The the sections below show all of the templates currently available on the wiki.
Userpage Templates
Template Name | What you type | What you see | Variables | ||
---|---|---|---|---|---|
{{SiteProfile| site = | id = | name = }} |
| ||||
{{Userbox | border-c = | border-s = | id-c = | id-s = | id-fc = | id-fs = | id-p = | id-lh = | info-c = | info-s = | info-fc = | info-fs = | info-p = | info-lh = | id = | info = }} |
|
|
Infobox Templates
Template Name | What you type | What you see | Variables |
---|---|---|---|
{{Infobox TGI | name = | format = | type = | group = | instance = | comments = }} |
See the template description for details |
| |
{{infobox lot |type = |image1 = |image2 = |desc = |credits = |support = |download-site = |download-id = }} |
See the template description for details |
| |
{{infobox grow |download-site = |download-id = |image1 = |image2 = |desc = |credits = |support = |size = |style = |type = |stage = |occupants = |worth = |bulldoze-cost = |construction-time = |fire = |power = |water = |air-mag = |air-spr = |water-mag = |water-spr = |garbage-mag = |garbage-spr = |depend = }} |
See the template description for details |
| |
{{infobox plop |download-site = |download-id = |image1 = |image2 = |desc = |credits = |support = |size = |menu = |jobs = |plop-cost = |monthly-cost = |bulldoze-cost = |park-mag = |park-spr = |landmark-mag = |landmark-spr = |fire = |power = |water = |air-mag = |air-spr = |water-mag = |water-spr = |garbage-mag = |garbage-spr = |depend = }} |
See the template description for details |
|
Request/Marking Templates
Template Name | What you type | What you see | Variables | ||
---|---|---|---|---|---|
{{current}} |
|
N/A | |||
{{review}} |
|
N/A | |||
{{expand}} |
|
N/A | |||
{{stub|extracontent}} |
|
extracontent: any information relating to what particular information is required. | |||
{{sectstub|extracontent}} | extracontent: any information relating to what particular information is required. | ||||
{{inappropriate tone}} |
|
N/A | |||
{{wikify}} |
|
N/A | |||
{{external}} |
|
N/A | |||
{{globalize}} |
|
N/A | |||
{{cleanup}} |
|
N/A | |||
{{rename|newname|reason}} |
|
rename: your suggestion for the new name of the article
| |||
{{remove|reason}} |
|
reason: why you think the article is no longer necessary |
Language Templates
Template Name | What you type | What you see | Variables | |||
---|---|---|---|---|---|---|
{{languages |lang1 |lang2 |lang3 |lang4 ... |lang19 }} |
|
*lang (multiple, optional) - the 2 character code of the languages where a translation of this page is available. The code for English (en) does not need to be inlcuded, its presence is assumed by the template. |
Other Templates
Template Name | What you type | What it does | Variables |
---|---|---|---|
{{Download |exchange = |id = }} |
Will provide a link to a download on one of the SC4 Exchanges (SC4D/BSC LEX, STEX, TPPEX or PLEX). |
| |
{{main|articlename}} |
Used when transcluding a section of an article to provide a link to the whole article. | articlename: Replace this variable with the title of the article you wish to link to. |
See Category:General article templates for navboxes in use at this site.