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
Category	category
Encumbrance	weight
Skills learned	recipes
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=
<!--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.

name_colour

The background colour for the display name. Codes can be found at Template:Infobox nc.

name_text_colour

The text colour for the display name. Codes can be found at Template:Infobox nc.

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
|name_colour=Literature
|name_text_colour=Literature
|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
|name_colour=Literature
|name_text_colour=Literature
|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
|name_colour=Literature
|name_text_colour=Literature
|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
|name_colour=Literature
|name_text_colour=Literature
|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
|name_colour=Literature
|name_text_colour=Literature
|image=Notebook.png
|category=Literature
|weight=0.1
|writable=True
|page_number=20
|class_name=Base.Journal
}}