Template:Infobox literature/doc: Difference between revisions
mNo edit summary |
(added changed parameters) |
||
Line 15: | Line 15: | ||
|alternate_name=alternate_name | |alternate_name=alternate_name | ||
|alternate_link= | |alternate_link= | ||
|weight=weight| | <!--GENERAL--> | ||
| | |category=category | ||
| | |weight=weight | ||
| | |map=map | ||
|consumed=consumed | |||
| | |writable=writable | ||
| | |page_number=page_number | ||
| | <!--EFFECT--> | ||
| | |unhappy_change=unhappy_change | ||
|boredom_change=boredom_change | |||
|class_name=class_name | |stress_change=stress_change | ||
|recipes=recipes | |||
<!--TECHNICAL DETAILS--> | |||
|class_name=class_name | |||
}} | }} | ||
<pre> | <pre> | ||
Line 34: | Line 37: | ||
|alternate_name= | |alternate_name= | ||
|alternate_link= | |alternate_link= | ||
<!--GENERAL--> | |||
|category= | |||
|weight= | |weight= | ||
| | |map= | ||
|consumed= | |||
|writable= | |||
|page_number= | |||
<!--EFFECT--> | |||
|unhappy_change= | |unhappy_change= | ||
|boredom_change= | |boredom_change= | ||
|stress_change= | |stress_change= | ||
| | |recipes= | ||
<!--TECHNICAL DETAILS--> | |||
|class_name= | |class_name= | ||
}}</pre> | }}</pre> | ||
==Parameters== | ==Parameters== | ||
===Heading/Image=== | |||
;display_name: The display name of the item as it appears in-game. Leaving blank will display the pagename. | ;display_name: The display name of the item as it appears in-game. Leaving blank will display the pagename. | ||
;image: An image of the icon displayed at 120px. A 120px variant should be used if it has one. | ;image: An image of the icon displayed at 120px. A 120px variant should be used if it has one. | ||
Line 64: | Line 60: | ||
;alternate_name: The name of the alternate item image. Leaving blank will display no name when the image is hovered over. | ;alternate_name: The name of the alternate item image. Leaving blank will display no name when the image is hovered over. | ||
;alternate_link: An optional link to the alternate image page. Leaving blank will have no link. | ;alternate_link: An optional link to the alternate image page. Leaving blank will have no link. | ||
===General=== | |||
;weight: The base weight of the item. | ;weight: The base weight of the item. | ||
; | ;category: The in-game category the item is displayed in in the inventory. | ||
;recipes: The recipes taught by this item. ''(remove if value is false)'' | |||
; | |||
;skill_book: Whether this item is a skill book. ''(remove if value is false)'' | ;skill_book: Whether this item is a skill book. ''(remove if value is false)'' | ||
;consumed: Whether this item is consumed once used. ''(remove if value is false)'' | ;consumed: Whether this item is consumed once used. ''(remove if value is false)'' | ||
;writable: Whether this item can be written/annotated with a pen or pencil. ''(remove if value is false)'' | ;writable: Whether this item can be written/annotated with a pen or pencil. ''(remove if value is false)'' | ||
;page_number: The number of pages in this item. ''(remove if value is empty)'' | ;page_number: The number of pages in this item. ''(remove if value is empty)'' | ||
===Effect=== | |||
;unhappy_change: The value of unhappiness that is changed from using/consuming this item. ''(remove if value is empty)'' | |||
;boredom_change: The value of boredom that is changed from using/consuming this item. ''(remove if value is empty)'' | |||
;stress_change: The value of stress that is changed from using/consuming this item. ''(remove if value is empty)'' | |||
===Technical details=== | |||
;class_name: The item's class name. | ;class_name: The item's class name. | ||
Line 82: | Line 80: | ||
|display_name=Book | |display_name=Book | ||
|image=Book_120px.png | |image=Book_120px.png | ||
|weight=0.5| | |category=Literature | ||
|unhappy_change=-40 | |weight=0.5 | ||
|boredom_change=-50 | |consumed=True | ||
|stress_change=-40 | |unhappy_change=-40 | ||
|boredom_change=-50 | |||
|class_name=Base.Book | |stress_change=-40 | ||
|class_name=Base.Book | |||
}}<pre>{{infobox literature | }}<pre>{{infobox literature | ||
|display_name=Book | |display_name=Book | ||
|image=Book_120px.png | |image=Book_120px.png | ||
|category=Literature | |||
|weight=0.5 | |weight=0.5 | ||
| | |consumed=True | ||
|unhappy_change=-40 | |unhappy_change=-40 | ||
|boredom_change=-50 | |boredom_change=-50 | ||
|stress_change=-40 | |stress_change=-40 | ||
|class_name=Base.Book | |class_name=Base.Book | ||
}}</pre> | }}</pre> | ||
{{clear}} | |||
'''[[Skill Books|Skill Book]] infobox''' | '''[[Skill Books|Skill Book]] infobox''' | ||
{{infobox literature | {{infobox literature | ||
|display_name=Metalwork for Beginners | |display_name=Metalwork for Beginners | ||
|image=Book7.png | |image=Book7.png | ||
|category=literature | |||
|weight=0.8 | |weight=0.8 | ||
| | |skill_trained=[[Metalworking]] | ||
|page_number=220 | |page_number=220 | ||
|class_name=Base.BookMetalWelding1 | |class_name=Base.BookMetalWelding1 | ||
}}<pre> | }}<pre> | ||
Line 117: | Line 113: | ||
|display_name=Metalwork for Beginners | |display_name=Metalwork for Beginners | ||
|image=Book7.png | |image=Book7.png | ||
|category=literature | |||
|weight=0.8 | |weight=0.8 | ||
| | |skill_trained=[[Metalworking]] | ||
|page_number=220 | |page_number=220 | ||
|class_name=Base.BookMetalWelding1 | |class_name=Base.BookMetalWelding1 | ||
}}</pre> | }}</pre> | ||
{{clear}} | |||
'''[[Recipe Magazines|Recipe Magazine]] infobox''' | '''[[Recipe Magazines|Recipe Magazine]] infobox''' | ||
{{infobox literature | {{infobox literature | ||
|display_name=The Herbalist | |display_name=The Herbalist | ||
|image=MagazineFood.png | |image=MagazineFood.png | ||
|category=Literature | |||
|weight=0.1 | |weight=0.1 | ||
| | |recipes=Herbalist | ||
|class_name=Base.HerbalistMag | |class_name=Base.HerbalistMag | ||
}}<pre> | }}<pre> | ||
{{infobox literature | {{infobox literature | ||
|display_name=The Herbalist | |display_name=The Herbalist | ||
|image=MagazineFood.png | |image=MagazineFood.png | ||
|category=Literature | |||
|weight=0.1 | |weight=0.1 | ||
| | |recipes=Herbalist | ||
|class_name=Base.HerbalistMag | |class_name=Base.HerbalistMag | ||
}}</pre> | }}</pre> | ||
{{clear}} | |||
'''[[Maps|Map]] infobox''' | '''[[Maps|Map]] infobox''' | ||
{{infobox literature | {{infobox literature | ||
|display_name=March Ridge Map | |display_name=March Ridge Map | ||
|image=Map.png | |image=Map.png | ||
|category=Item | |||
|weight=0.1 | |weight=0.1 | ||
|writable=True | |writable=True | ||
|class_name=Base.MarchRidgeMap | |class_name=Base.MarchRidgeMap | ||
}}<pre> | }}<pre> | ||
Line 161: | Line 152: | ||
|display_name=March Ridge Map | |display_name=March Ridge Map | ||
|image=Map.png | |image=Map.png | ||
|category=Item | |||
|weight=0.1 | |weight=0.1 | ||
|writable=True | |writable=True | ||
|class_name=Base.MarchRidgeMap | |class_name=Base.MarchRidgeMap | ||
}}</pre> | }}</pre> | ||
{{clear}} | |||
'''[[Journal]] infobox''' | '''[[Journal]] infobox''' | ||
{{infobox literature | {{infobox literature | ||
|display_name=Journal | |display_name=Journal | ||
|image=Notebook.png | |image=Notebook.png | ||
|category=Literature | |||
|weight=0.1 | |weight=0.1 | ||
|writable=True | |writable=True | ||
|page_number=20 | |page_number=20 | ||
|class_name=Base.Journal | |class_name=Base.Journal | ||
}}<pre> | }}<pre> | ||
Line 184: | Line 172: | ||
|display_name=Journal | |display_name=Journal | ||
|image=Notebook.png | |image=Notebook.png | ||
|category=Literature | |||
|weight=0.1 | |weight=0.1 | ||
|writable=True | |writable=True | ||
|page_number=20 | |page_number=20 | ||
|class_name=Base.Journal | |class_name=Base.Journal | ||
}}</pre> | }}</pre> | ||
{{clear}} |
Revision as of 13:53, 11 August 2018
This is a documentation subpage for Template:Infobox literature.
It contains usage information and other content that is not part of the original template page. |
This infobox is used to create an infobox in an article about food items.
Usage
To use this template in an article, copy the template below, then paste the template into an article.
All parameters are optional – those you do not populate with data will not show up in the infobox when the article is saved.
It is strongly advised to only include variables that are relevant to the specific item in question, i.e. parameters that do not display as false or 0.
{{infobox literature |display_name= |image= |alternate_image= |alternate_name= |alternate_link= <!--GENERAL--> |category= |weight= |map= |consumed= |writable= |page_number= <!--EFFECT--> |unhappy_change= |boredom_change= |stress_change= |recipes= <!--TECHNICAL DETAILS--> |class_name= }}
Parameters
Heading/Image
- display_name
- The display name of the item as it appears in-game. Leaving blank will display the pagename.
- image
- An image of the icon displayed at 120px. A 120px variant should be used if it has one.
- alternate_image
- An alternate image displayed at 32px. Can be an empty, packaged, open or any other variant.
- alternate_name
- The name of the alternate item image. Leaving blank will display no name when the image is hovered over.
- alternate_link
- An optional link to the alternate image page. Leaving blank will have no link.
General
- weight
- The base weight of the item.
- category
- The in-game category the item is displayed in in the inventory.
- recipes
- The recipes taught by this item. (remove if value is false)
- skill_book
- Whether this item is a skill book. (remove if value is false)
- consumed
- Whether this item is consumed once used. (remove if value is false)
- writable
- Whether this item can be written/annotated with a pen or pencil. (remove if value is false)
- page_number
- The number of pages in this item. (remove if value is empty)
Effect
- unhappy_change
- The value of unhappiness that is changed from using/consuming this item. (remove if value is empty)
- boredom_change
- The value of boredom that is changed from using/consuming this item. (remove if value is empty)
- stress_change
- The value of stress that is changed from using/consuming this item. (remove if value is empty)
Technical details
- class_name
- The item's class name.
Examples
Book infobox
Book | |
---|---|
Book | |
General | |
Category | Literature |
Encumbrance | 0.5 |
Consumed | True |
Effect | |
Unhappiness | -40 |
Boredom | -50 |
Stress | -40 |
Technical details | |
Base ID | Base.Book |
{{infobox literature |display_name=Book |image=Book_120px.png |category=Literature |weight=0.5 |consumed=True |unhappy_change=-40 |boredom_change=-50 |stress_change=-40 |class_name=Base.Book }}
Skill Book infobox
Metalwork for Beginners | |
---|---|
General | |
Category | literature |
Encumbrance | 0.8 |
Total pages | 220 pages |
Technical details | |
Base ID | Base.BookMetalWelding1 |
{{infobox literature |display_name=Metalwork for Beginners |image=Book7.png |category=literature |weight=0.8 |skill_trained=[[Metalworking]] |page_number=220 |class_name=Base.BookMetalWelding1 }}
Recipe Magazine infobox
The Herbalist | |
---|---|
General | |
Category | Literature |
Encumbrance | 0.1 |
Skills learned | Herbalist |
Technical details | |
Base ID | Base.HerbalistMag |
{{infobox literature |display_name=The Herbalist |image=MagazineFood.png |category=Literature |weight=0.1 |recipes=Herbalist |class_name=Base.HerbalistMag }}
Map infobox
March Ridge Map | |
---|---|
General | |
Category | Item |
Encumbrance | 0.1 |
Writable | True |
Technical details | |
Base ID | Base.MarchRidgeMap |
{{infobox literature |display_name=March Ridge Map |image=Map.png |category=Item |weight=0.1 |writable=True |class_name=Base.MarchRidgeMap }}
Journal infobox
Journal | |
---|---|
General | |
Category | Literature |
Encumbrance | 0.1 |
Writable | True |
Total pages | 20 pages |
Technical details | |
Base ID | Base.Journal |
{{infobox literature |display_name=Journal |image=Notebook.png |category=Literature |weight=0.1 |writable=True |page_number=20 |class_name=Base.Journal }}