Difference between revisions of "Help:Templates"

From SC4D Encyclopaedia
Jump to navigation Jump to search
sc4e>JoeST
m
m (49 revisions imported)
 
(47 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.
  
−
==Userpage Templates==
+
For example, to include the Language template (on a page with Dutch, French and Japanese translations):
 +
<pre>{{Languages|nl|fr|ja}}</pre> will look like this:
 +
{{Languages|nl|fr|ja}}
  
−
==Request/Marking Templates==
+
==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
 +
|-
 +
| {{tll|SiteProfile}}
 +
| <nowiki>{{SiteProfile| site = | id = | name = }}</nowiki>
 +
| {{SiteProfile| site = sc4d | id = 11 | name = Freedo50}}
 +
|
 +
*'''site''' - The name of the site
 +
*'''id''' - Your user ID
 +
*'''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===
 +
{| 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
 +
|-
 +
| {{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.
 +
*'''format''' -
 +
*'''type''' - The Type ID of the object, defines what file type the file is (?)
 +
*'''group''' - The Group ID of the object
 +
*'''instance''' - The Instance ID of the object
 +
*'''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).
 +
*'''image1''' - an example image.
 +
*'''image2''' - another example image.
 +
*'''desc''' - the lot description (readme)
 +
*'''credits''' - any credits
 +
*'''supports''' - any supporting acts
 +
*'''download-site''' - the download site
 +
*'''download-id''' - the download lot id
 +
|-
 +
| {{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===
 
{{main|Help:Marking Articles}}
 
{{main|Help:Marking Articles}}
 +
{{Help:Marking Articles}}
 +
 +
===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.'''
 +
|}
 +
 +
===Other Templates===
 +
{| border="1" cellspacing="0" cellpadding="5" width=100%
 +
! style="background:#1e90ff;"| Template Name
 +
! style="background:#1e90ff;"| What you type
 +
! 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.
  
−
==Language Templates==
+
==How to Make a Template==
  
−
==Other Templates==
 
  
−
[[Category:Help]]
+
[[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...

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 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

Main article: Help:Userboxes
Template Name What you type What you see Variables
Template:SiteProfile 
(edit talk links history) 		{{SiteProfile| site = | id = | name = }}
35px Freedo50's SC4D Profile
  • site - The name of the site
  • id - Your user ID
  • name - (optional) can be added if you want your name to replace "My"
Template:Userbox 
(edit talk links history) 
{{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 = 
}}
id info
  • 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

Template Name What you type What you see Variables
Template:Infobox TGI 
(edit talk links history) 
{{Infobox TGI
| name = 
| format = 
| type = 
| group = 
| instance = 
| comments = }}
 See the template description for details
  • name - The name of the TGI.
  • format -
  • type - The Type ID of the object, defines what file type the file is (?)
  • group - The Group ID of the object
  • instance - The Instance ID of the object
  • comments (optional) - Any comments on the TGI.
Template:Infobox lot 
(edit talk links history) 
{{infobox lot 
|type = 
|image1 = 
|image2 = 
|desc = 
|credits = 
|support = 
|download-site = 
|download-id = 
}}
 See the template description for details
  • type - the type of lot it is (either plop or grow).
  • image1 - an example image.
  • image2 - another example image.
  • desc - the lot description (readme)
  • credits - any credits
  • supports - any supporting acts
  • download-site - the download site
  • download-id - the download lot id
Template:Infobox grow 
(edit talk links history) 
{{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
  • 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.
Template:Infobox plop 
(edit talk links history) 
{{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
  • 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

Main article: Help:Marking Articles
Template Name What you type What you see Variables
Template:Current 
(edit talk links history) 		{{current}}
Gnome globe current event.png This page documents a current event.
The information may change rapidly while the event progresses.
N/A
Template:Review 
(edit talk links history) 		{{review}}
Wiki review.png
 This article needs to reviewed for completeness.
If you have knowledge on this subject, please review the current content and make comments on the discussion page.
N/A
Template:Expand 
(edit talk links history) 		{{expand}}
Wiki incomplete.png
 This article is incomplete or unfinished
If you have knowledge on this subject, please help out by editing this page. Further information may be found on the discussion page.
N/A
Template:Stub 
(edit talk links history) 		{{stub|extracontent}}
Wiki stub.png
 This article is a stub
You can help by expanding it.
extracontent: any information relating to what particular information is required.
Template:Sectstub 
(edit talk links history) 		{{sectstub|extracontent}}
Wiki stub.png
 Please help improve this section by expanding it.
Further information might be found on the talk page.
extracontent: any information relating to what particular information is required.
Template:Inappropriate tone 
(edit talk links history) 		{{inappropriate tone}}
Wiki warning amber.png
 The tone, or writing style, of this article does not adhere to style guidelines
Specific concerns may be found on the discussion page. See Wikipedia's Guide to writing better articles for suggestions.
N/A
Template:Wikify 
(edit talk links history) 		{{wikify}}
Wiki warning amber.png
 This article needs to be Wikified
Specific concerns may be found on the discussion page.
N/A
Template:External 
(edit talk links history) 		{{external}}
Wiki warning amber.png
 This article need external links, or citations
See the discussion page
N/A
Template:Globalize 
(edit talk links history) 		{{globalize}}
Wiki warning amber.png This page may not contain a community-wide view on the subject.
Please notify the author of this page or edit it yourself.
N/A
Template:Cleanup 
(edit talk links history) 		{{cleanup}}
Wiki clean.png This page may require cleanup to meet quality standards.
Please improve this page if you can. See the Wikipedia Manual of Style for suggestions.
N/A
Template:Rename 
(edit talk links history) 		{{rename|newname|reason}}
Imbox notice.png It has been suggested that this page should be renamed to {{{newname}}}
The current title of this article is inappropriate because {{{reason}}}. See the discussion page for more info.
rename: your suggestion for the new name of the article


reason: why you think the article should be renamed

Template:Remove 
(edit talk links history) 		{{remove|reason}}
Wiki warning.png This page is marked to be removed because {{{reason}}}
If you edit this page your changes may be lost.
reason: why you think the article is no longer necessary

Language Templates

Template Name What you type What you see Variables
Template:Languages 
(edit talk links history) 
{{languages
|lang1
|lang2
|lang3
|lang4
...
|lang19
}}
Languages Languages:

English • German (Deutsch) • French (français) • Japanese (日本語) • Chinese (中文)


*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
Template:Download 
(edit talk links history) 
{{Download
|exchange =
|id =
}}
 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).
Template:Main 
(edit talk links history) 
{{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.

Navbox Templates

See Category:General article templates for navboxes in use at this site.

How to Make a Template

Retrieved from "https://wiki.sc4devotion.com/index.php?title=Help:Templates&oldid=2212"