Template:NaturalSourceData/doc
From Reus
Revision as of 12:15, 20 August 2013 by Madman with a box (Talk | contribs)
Contents |
Description
This template is used to define a resource of any kind. It's not meant to be used within the Wiki directly but instead to define new templates for resources, like Template:Blueberry or Template:Strawberry. These created templates can then be used within the wiki to make the use of resources consistent across different pages and different languages. See the examples section for some possible use-cases.
Parameters
This template has a long list of named parameters. However mostly because it provides to define the values for all three levels of a resource so many parameters are listed 3 times.
{{NaturalSourceData
<!-- these three parameters don't define the resource but are used to define how the template gets expanded and looks like when used -->
| style = <!-- how to show this resource, see below for possible values -->
| level = <!-- the level of the resource to show, 1 is the default value -->
| lang = <!-- the language code to use for translation -->
<!-- the following parameters define all values of a resource -->
| name = <!-- the name of the resource -->
| type = <!-- the type of the resource, either plant, animal or mineral -->
| image = <!-- the name of the BASE image for this resource, e.g. APPLE_TREE -->
<!-- the following parameters specify which giant creates the resource using which ability on which biome -->
<!-- there room for three possibilities -->
<!-- leave empty if the resource is not created directly and can be only produced by transmutation -->
| giant1 =
| giantAbility1 =
| biome1 =
| giant2 =
| giantAbility2 =
| biome2 =
| giant3 =
| giantAbility3 =
| biome3 =
| baseLevel = <!-- the base level of the resource (Note: not used yet and still unsure if it's needed -->
<!-- the following parameters describe the resources this natural source supplies -->
<!-- there is a parameter for each level (1, 2, 3) -->
| aspects1 = <!-- the number of aspects possible -->
| aspects2 =
| aspects3 =
| food1 = <!-- the base number of food provided -->
| food2 =
| food3 =
| technology1 = <!-- the base number of technology provided -->
| technology2 =
| technology3 =
| wealth1 = <!-- the base number of wealth provided -->
| wealth2 =
| wealth3 =
| natura1 = <!-- the base number of natura provided -->
| natura2 =
| natura3 =
| danger1 = <!-- the base number of danger provided -->
| danger2 =
| danger3 =
| awe1 = <!-- the base number of awe provided -->
| awe2 =
| awe3 =
| range1 = <!-- the base number of range -->
| range2 =
| range3 =
<!-- these parameters describe activation conditions, symbiosis and transmutation -->
<!-- you should always use the special templates to fill this information -->
| activation1 = <!-- the condition required for minerals to activate their symbiosis -->
| activation2 =
| symbiosis1 = <!-- possible symbiosis -->
| symbiosis2 =
| transmutation1 = <!-- possible transmutations -->
| transmutation2 =
| transmutation3 =
}}
Examples
| Example Description | Code to use | Output | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| A Blueberry as an info box. This is how the Blueberry template looks like that is used in the examples below. |
{{NaturalSourceData
|style = info
|level = 1
|name = Blueberry
|image = BLUE BERRY
|giant1 = Forest
|giantAbility1 = Plant Fruit
|biome1 = Forest
|aspects1 = 1
|food1 = 5
|natura1 = 1
|symbiosis1 = Grove
|transmutation1 = {{Transmutation|to=Strawberry|aspectLv1=1|aspect1=Leaf|level=1}}
|transmutation2 = {{Transmutation|to=Apple Tree|aspectLv1=2|aspect1=Fruit|level=1}}
}}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| A Blueberry info box using the blueberry resource template | {{Blueberry|info}} or {{Blueberry|info|1}}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| A Blueberry info box for the level 2 Blueberry using the blueberry resource template | {{Blueberry|info|2}}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| A Blueberry info box using the blueberry resource template in German for level 2 | {{Blueberry|info|2|de}}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| A Blueberry and Strawberry within a table | {| class="wikitable sortable" font-size:95%; width:100%;"
|-
! style="width:200px;"|Name
! |Level
! |Yields
! |Symbiosis
! |Transmutation
{{NaturalSourceData
|style = table
|level = 1
|name = Blueberry
|image = BLUE BERRY
|giant1 = Forest
|giantAbility1 = Plant Fruit
|biome1 = Forest
|aspects1 = 1
|food1 = 5
|natura1 = 1
|symbiosis1 = Grove
|transmutation1 = {{Transmutation|to=Strawberry|aspectLv1=1|aspect1=Leaf|level=1}}
|transmutation2 = {{Transmutation|to=Apple Tree|aspectLv1=2|aspect1=Fruit|level=1}}
}}
{{NaturalSourceData
|style = table
|level = 1
|name = Strawberry
|image = STRAWBERRY
|aspects1 = 2
|food1 = 5
|natura1 = 4
|symbiosis1 = Adaptation
|transmutation1 = {{Transmutation|to=Pear Tree|aspectLv1=2|aspect1=Fruit|level=1}}
}}
|}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The same table but using the simplified resource templates for Blueberry and Strawberry |
{| class="wikitable sortable" font-size:95%; width:100%;"
|-
! Name
! Level
! Yields
! Symbiosis
! Transmutation
{{Blueberry|table|1}}
{{Strawberry|table|1}}
<!-- the 1 can also be ommited if only level 1 should be shown -->
|}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| The same table but this time showing level 2 of both natural sources. Note that now the transmutation from Strawberry to Plum Tree also is shown because it only becomes available for a Great Strawberry. |
{| class="wikitable sortable" font-size:95%; width:100%;"
|-
! Name
! Level
! Yields
! Symbiosis
! Transmutation
{{Blueberry|table|2}}
{{Strawberry|table|2}}
|}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Again the same table but this time in German |
{| class="wikitable sortable" font-size:95%; width:100%;"
|-
! Name
! Level
! Ertrag
! Symbiose
! Umwandlung
{{Blueberry|table|2|de}}
{{Strawberry|table|2|de}}
|}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| All forest plants in one table |
{| class="wikitable sortable" font-size:95%; width:100%;"
|-
! style="width:200px;"|Name
! |Level
! |Yields
! |Symbiosis
! |Transmutation
{{Blueberry|table}}
{{Strawberry|table}}
{{Apple Tree|table}}
{{Pear Tree|table}}
{{Cherry Tree|table|2}}
{{Plum Tree|table|2}}
{{Orange Tree|table|3}}
{{Dandelion|table}}
{{Nightshade|table}}
{{Foxglove|table}}
{{Sunflower|table|3}}
|}
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Creating new NaturalSource Data Templates
Creating new NaturalSource data templates is fairly easy. Here is a step by step guide.
- Create a new template page and name it after the natural source(e.g. Apple Tree).
- Do this by editing an existing page and input {{<Name of the NaturalSource >}} (e.g. {{Apple Tree}}), view the preview and click on the new red link.
- Or simply input the link http://wiki.reusgame.com/index.php?title=Template:<Name of the NaturalSource> (e.g. http://wiki.reusgame.com/index.php?title=Template:Apple Tree) into your browser.
- Copy the blank template code below and paste it into the new template page.
- Fill out the information about the natural source for all three levels. Parameters that are not needed (e.g. if the natural source doesn't provide technology) can be deleted or just left empty. See the second code block for an example.
- For the parameter type enter either "plant" for plant and herbs, "animal" or "mineral" (without ").
- The parameter baseLevel describes the minimum level for this source. An Apple Tree for example has a baseLevel of 1, because it can be created with level 1 abilities. A Plum Tree however has a baseLevel of 2, because it can only transmute from a Great Strawberry or Great Dandelion which are level 2 resources.
- The image parameter describes the name of the image for this natural source. Don't use the names with an appendix like _SMALL, only the base name of the image (e.g. for an Apple Tree the name would be APPLE_TREE). The template automatically takes the correct image for the desired level.
- The parameters giant, giantAbility and biome define where this natural source can be created. For the giant only use its name, without the ending "giant" (e.g. Ocean, Forest, etc.). Use the ability name that creates this natural source (e.g. Plant Fruit, Domestic Animals, etc.). Last enter the name of the biome this natural source can grow on (e.g. Forest, Swamp). For each of those parameters there are three versions to allow multiple giants, abilities and biomes (e.g. minerals can be created on different biomes). If a natural source isn't created directly through a giant, omit all three parameters, as can be seen in the Apple Tree example below.
- Input the values for aspects and resources for each level. Each attribute is available three times, one for each level.
- For the symbiosis simply state its name. The Apple Tree for example has a symbiosis called Meadow so add the line |symbiosis1 = Meadow. This will create a Symbiosis template which also to be filled out with the correct symbiosis information. Refer to the template page to see how to do it (its very similar to this one). Please note that if a symbiosis name is available for two different source (e.g. the Nightshade and Cherry Tree have the symbiosis Deep Roots but with different meanings), also add the name of the source to the symbiosis name (e.g. |symbiosis1 = Deep Roots Nightshade and |symbiosis1 = Deep Roots Cherry Tree to distinguish between them.
- For the transmutation use the Transmutation template. This one is also easy to use: State the name of the transmuted natural source and the level and name of the aspect needed. Also add the same parameters at the end as for symbiosis, but this time with parameter names. So for the Apple Tree it looks like this: |transmutation1 = {{Transmutation|to=Pear Tree|aspectLv1=2|aspect1=Leaf|level={{{2|}}}|lang={{{3|}}}}}. This says that the Apple Tree can transmute into a Pear Tree with a potent (that's the 2) Leaf aspect. If there's more than one possible aspect you can use the parameters "aspectLv2" and "aspect2" to specify it. The last two parameters again allow the automatic translation and correct level.
- Save the template page
- On the newly created page you will find a greenish block with the title Documentation. Click on the red link named "/doc" somehwere there to create the documentation for this natural source.
- Copy the code <includeonly>[[Category:Natural Source Data Templates]]</includeonly> and paste it into the documentation template page. This categorizes the template.
- (Optional) Copy the following code and also paste it into the documentation page. Replace <Name of the natural source> with the correct name (e.g. Apple Tree). This way the documentation page shows an overview of the resource with info boxes.
{|
{{ShowAll|<Name of the natural source>|info}}
|}
- Save the documentation page
- Done! You created a new data template. =]
The blank template:
<includeonly>{{NaturalSourceData
<!-- the parameters that are only passed, don't change! -->
| style = {{{1|}}}
| level = {{{2|}}}
| language = {{{3|}}}
<!-- the actual natural source data values -->
| name =
| type =
| baseLevel =
| image =
| giant1 =
| giantAbility1 =
| biome1 =
| giant2 =
| giantAbility2 =
| biome2 =
| giant3 =
| giantAbility3 =
| biome3 =
| aspects1 =
| aspects2 =
| aspects3 =
| food1 =
| food2 =
| food3 =
| technology1 =
| technology2 =
| technology3 =
| wealth1 =
| wealth2 =
| wealth3 =
| natura1 =
| natura2 =
| natura3 =
| danger1 =
| danger2 =
| danger3 =
| awe1 =
| awe2 =
| awe3 =
| range1 =
| range2 =
| range3 =
| activation1 =
| activation2 =
| symbiosis1 =
| symbiosis2 =
| transmutation1 =
| transmutation2 =
| transmutation3 =
}}</includeonly><noinclude>
{{Documentation}}
</noinclude>
The filled out Apple Tree template page:
<includeonly>{{NaturalSourceData
<!-- the parameters that are only passed, don't change! -->
| style = {{{1|}}}
| level = {{{2|}}}
| language = {{{3|}}}
<!-- the actual natural source data values -->
| name = Apple Tree
| type = plant
| baseLevel = 1
| image = APPLE_TREE
| aspects1 = 2
| aspects2 = 3
| aspects3 = 4
| food1 = 6
| food2 = 10
| food3 = 20
| natura1 = 4
| natura2 = 6
| natura3 = 8
| symbiosis1 = {{Meadow|{{{2|}}}|{{{3|}}}}}
| transmutation1 = {{Transmutation|to=Pear Tree|aspectLv1=2|aspect1=Fruit|level={{{2|}}}|lang={{{3|}}}}}
| transmutation2 = {{Transmutation|to=Cherry Tree|aspectLv1=3|aspect1=Growth|level={{{2|}}}|lang={{{3|}}}}}
}}</includeonly><noinclude>
{{Documentation}}
</noinclude>
The filled out Apple Tree template documentation page:
{|
{{ShowAll|Apple Tree|info}}
|}
<includeonly>
[[Category:Natural Source Data Templates]]
</includeonly>
See also
Within the examples two other templates are used to make the display of symbiosis and transmutations easier. They can be found here:
The used data templates can be found here:
- Template:Blueberry
- Template:Strawberry
- Template:Apple Tree
- Template:Grove
- Template:Adaption
- Template:Meadow
Another useful tempalte to show all available levels of a natural source at once can be found here:
