Template:Description/doc: Difference between revisions

Latest revision as of 18:58, 15 December 2024

Description

This template automatically populates the description for several items.

Parameter

The name of the item in English (or the unqualified item ID from Content\Data\Objects.xnb).

Use

Enter the following:

{{Description|''item name''}}
{{Description|''item number''}}

Examples

{{Description|Wild Horseradish}}

...results in

A spicy root found in the spring.

{{Description|Prismatic Shard}}

...results in

A very rare and powerful substance with unknown origins.

{{Description|700}}

...results in

A relative of the catfish that eats a variety of foods off the lake bottom.

Recipes/Blueprints

These take a second parameter, the name of the item in the wiki's native language.

{{Description|Recipe|Lucky Lunch}}
{{Description|Blueprint|Stone Brazier}}

Spanish Example

In Spanish, for example, this would look like:

{{Description|Recipe|Almuerzo de la suerte}}
{{Description|Blueprint|Brasero de piedra}}

...which would result in

Receta para cocinar «Almuerzo de la suerte»

Planos para fabricar «Brasero de piedra»

Chinese Example

In Chinese, this would look like:

{{Description|Recipe|幸运午餐}}
{{Description|Blueprint|石头火炬}}

...which would result in

一个用于制作幸运午餐的配方

用于制造石头火炬的设计图

Notes

This template was created to assist in translating the wiki from English into other languages. In other languages, this template allows the item name to be in English or in the other language.

Items from the following data files are included:

Data\BigCraftables.xnb
Data\Boots.xnb
Data\Buildings.xnb
Data\Hats.xnb
Data\Objects.xnb
Data\Weapons.xnb
Data\Furniture.xnb (Catalogue & Furniture Catalogue names)
Strings\Objects.xnb (Catalogue & Furniture Catalogue descriptions)
Data\FarmAnimals.xnb (name of Void Chicken)
Strings\StringsFromCSFiles.xnb (tools, furniture, wallpaper, flooring, animals, recipes, blueprints)
Strings\1_6_Strings.xnb (various additions in version 1.6.x)

@@ Line 2: / Line 2: @@
 This template automatically populates the description for several items.
-==Parameters==
+==Parameter==
-#The name of the item in English (or the [[Modding:Object_data|item ID]] from <tt>Content\Data\ObjectInformation.xnb</tt>).
+The name of the item in English (or the [[Modding:Common data field types#Item ID|unqualified item ID]] from <samp>Content\Data\Objects.xnb</samp>).
-#Add italics with "italic=true"
 ==Use==
@@ Line 17: / Line 16: @@
 {{Description|Wild Horseradish}}
-<pre>{{Description|Prismatic Shard|italic=true}}</pre>
+<pre>{{Description|Prismatic Shard}}</pre>
 ...results in
-{{Description|Prismatic Shard|italic=true}}
+{{Description|Prismatic Shard}}
 <pre>{{Description|700}}</pre>
 ...results in
 {{Description|700}}
+==Recipes/Blueprints==
+These take a second parameter, the name of the item in the wiki's native language.
+<pre>{{Description|Recipe|Lucky Lunch}}
+{{Description|Blueprint|Stone Brazier}}</pre>
+===Spanish Example===
+In Spanish, for example, this would look like:
+<pre>{{Description|Recipe|Almuerzo de la suerte}}
+{{Description|Blueprint|Brasero de piedra}}</pre>
+...which would result in
+Receta para cocinar «Almuerzo de la suerte»
+Planos para fabricar «Brasero de piedra»
+===Chinese Example===
+In Chinese, this would look like:
+<pre>{{Description|Recipe|幸运午餐}}
+{{Description|Blueprint|石头火炬}}</pre>
+...which would result in
+一个用于制作 幸运午餐 的配方
+用于制造 石头火炬 的设计图
 ==Notes==
 This template was created to assist in translating the wiki from English into other languages.  In other languages, this template allows the item name to be in English or in the other language.
-<includeonly>[[Category:Transclusion templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
+Items from the following data files are included:
-<includeonly>[[de:Vorlage:{{PAGENAME}}]]
+#<samp>Data\BigCraftables.xnb</samp>
-[[es:Plantilla:{{PAGENAME}}]]
+#<samp>Data\Boots.xnb</samp>
-[[ja:テンプレート:{{PAGENAME}}]]
+#<samp>Data\Buildings.xnb</samp>
-[[pt:Predefinição:{{PAGENAME}}]]
+#<samp>Data\Hats.xnb</samp>
-[[ru:Шаблон:{{PAGENAME}}]]
+#<samp>Data\Objects.xnb</samp>
-[[zh:Template:{{PAGENAME}}]]</includeonly>
+#<samp>Data\Weapons.xnb</samp>
+#<samp>Data\Furniture.xnb</samp> (Catalogue & Furniture Catalogue names)
+#<samp>Strings\Objects.xnb</samp> (Catalogue & Furniture Catalogue descriptions)
+#<samp>Data\FarmAnimals.xnb</samp> (name of Void Chicken)
+#<samp>Strings\StringsFromCSFiles.xnb</samp> (tools, furniture, wallpaper, flooring, animals, recipes, blueprints)
+#<samp>Strings\1_6_Strings.xnb</samp> (various additions in version 1.6.x)
+<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>