Template:Infobox literature/doc
|
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.
display_name | ||
|---|---|---|
 | ||
| ||
| General | ||
Encumbrance  |
weight | |
| Map | map | |
| Consumed | consumed | |
| Writable | writable | |
| Total pages | page_number pages | |
| Effect | ||
Unhappiness  |
unhappy_change | |
Boredom  |
boredom_change | |
Stress  |
stress_change | |
| Technical details | ||
| Base ID | class_name | |
{{infobox literature
|display_name=
|image=
|alternate_image=
|alternate_name=
|alternate_link=
|weight=
|weight_bkg=
|unhappy_change=
|unhappy_change_bkg=
|boredom_change=
|boredom_change_bkg=
|stress_change=
|stress_change_bkg=
|recipe_magazine=
|recipe_magazine_bkg=
|skill_book=
|skill_book_bkg=
|map=map
|map_bkg=
|consumed=
|consumed_bkg=
|writable=
|writable_bkg=
|page_number=
|page_number_bkg=
|class_name=
|class_name_bkg=
}}
Parameters
- 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.
- weight
- The base weight of the item.
- "_bkg" suffix
- Will display a slightly darker background over the row; used for simpler identification between each row. Leavin blank will leave white, whereas inserting anything will give the darkened background. (same for each parameter with _bkg)
- 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)
- recipe_magazine
- Whether this item is a recipe magazine. (remove if value is false)
- skill_book
- Whether this item is a skill book. (remove if value is false)
- map
- Whether this item is a map. (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)
- class_name
- The item's class name.
Examples
Book infobox
Book | |
|---|---|
| Book | |
| General | |
| 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
|weight=0.5
|weight_bkg=1
|unhappy_change=-40
|boredom_change=-50
|boredom_change_bkg=1
|stress_change=-40
|consumed=True
|consumed_bkg=1
|class_name=Base.Book
}}
Skill Book infobox
Metalwork for Beginners | |
|---|---|
 | |
| General | |
| Encumbrance |
0.8 |
| Total pages | 220 pages |
| Technical details | |
| Base ID | Base.BookMetalWelding1 |
{{infobox literature
|display_name=Metalwork for Beginners
|image=Book7.png
|weight=0.8
|weight_bkg=1
|skill_book=True
|page_number=220
|page_number_bkg=1
|class_name=Base.BookMetalWelding1
}}
Recipe Magazine infobox
The Herbalist | |
|---|---|
 | |
| General | |
| Encumbrance |
0.1 |
| Technical details | |
| Base ID | Base.HerbalistMag |
{{infobox literature
|display_name=The Herbalist
|image=MagazineFood.png
|weight=0.1
|weight_bkg=1
|recipe_magazine=True
|class_name=Base.HerbalistMag
|class_name_bkg=1
}}
Map infobox
March Ridge Map | |
|---|---|
 | |
| General | |
| Encumbrance |
0.1 |
| Map | True |
| Writable | True |
| Technical details | |
| Base ID | Base.MarchRidgeMap |
{{infobox literature
|display_name=March Ridge Map
|image=Map.png
|weight=0.1
|weight_bkg=1
|map=True
|writable=True
|writable_bkg=1
|class_name=Base.MarchRidgeMap
}}
Journal infobox
Journal | |
|---|---|
|
| |
| General | |
| Encumbrance |
0.1 |
| Writable | True |
| Total pages | 20 pages |
| Technical details | |
| Base ID | Base.Journal |
{{infobox literature
|display_name=Journal
|image=Notebook.png
|weight=0.1
|weight_bkg=1
|writable=True
|page_number=20
|page_number_bkg=1
|class_name=Base.Journal
}}