Template:Infobox literature/doc: Difference between revisions
mNo edit summary |
m (Remove lines)) |
||
(12 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{Delete|Unused}} | |||
{{Documentation subpage}} | |||
This infobox is used to create an infobox in an article about food items. | This infobox is used to create an infobox in an article about food items. | ||
Line 8: | Line 9: | ||
All parameters are optional – those you do not populate with data will not show up in the infobox when the article is saved. | 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'''.'' | ''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 | ||
| | |name =display_name | ||
|image=image.png | |image=image.png | ||
|image_width=200px | |image_width=200px | ||
Line 28: | Line 29: | ||
|alternate_name5=alternate_name3 | |alternate_name5=alternate_name3 | ||
|alternate_link5= | |alternate_link5= | ||
|alternate_image6=image.png{{!}}32px | |||
|alternate_name6=alternate_name6 | |||
|alternate_link6= | |||
|alternate_image7=image.png{{!}}32px | |||
|alternate_name7=alternate_name7 | |||
|alternate_link7= | |||
|alternate_image8=image.png{{!}}32px | |||
|alternate_name8=alternate_name8 | |||
|alternate_link8= | |||
|alternate_image9=image.png{{!}}32px | |||
|alternate_name9=alternate_name9 | |||
|alternate_link9= | |||
|alternate_image10=image.png{{!}}32px | |||
|alternate_name10=alternate_name10 | |||
|alternate_link10= | |||
|alternate_image11=image.png{{!}}32px | |||
|alternate_name11=alternate_name11 | |||
|alternate_link11= | |||
|alternate_image12=image.png{{!}}32px | |||
|alternate_name12=alternate_name12 | |||
|alternate_link12= | |||
|alternate_image13=image.png{{!}}32px | |||
|alternate_name13=alternate_name13 | |||
|alternate_link13= | |||
|alternate_image14=image.png{{!}}32px | |||
|alternate_name14=alternate_name14 | |||
|alternate_link14= | |||
|alternate_image15=image.png{{!}}32px | |||
|alternate_name15=alternate_name15 | |||
|alternate_link15= | |||
|alternate_image16=image.png{{!}}32px | |||
|alternate_name16=alternate_name16 | |||
|alternate_link16= | |||
<!--GENERAL--> | <!--GENERAL--> | ||
|category=category | |category=category | ||
Line 35: | Line 69: | ||
|writable=writable | |writable=writable | ||
|page_number=page_number | |page_number=page_number | ||
|vol_number=vol_number | |||
<!--EFFECT--> | <!--EFFECT--> | ||
|unhappy_change=unhappy_change | |unhappy_change=unhappy_change | ||
Line 41: | Line 76: | ||
|recipes=recipes | |recipes=recipes | ||
<!--TECHNICAL DETAILS--> | <!--TECHNICAL DETAILS--> | ||
| | |item_id =class_name | ||
}} | }} | ||
<pre> | <pre> | ||
{{ | {{Infobox literature | ||
| | |name = | ||
|image= | |image= | ||
|image_width= | |image_width= | ||
Line 63: | Line 98: | ||
|alternate_name5= | |alternate_name5= | ||
|alternate_link5= | |alternate_link5= | ||
|alternate_image6= | |||
|alternate_name6= | |||
|alternate_link6= | |||
|alternate_image7= | |||
|alternate_name7= | |||
|alternate_link7= | |||
|alternate_image8= | |||
|alternate_name8= | |||
|alternate_link8= | |||
|alternate_image9= | |||
|alternate_name9= | |||
|alternate_link9= | |||
|alternate_image10= | |||
|alternate_name10= | |||
|alternate_link10= | |||
|alternate_image11= | |||
|alternate_name11= | |||
|alternate_link11= | |||
|alternate_image12= | |||
|alternate_name12= | |||
|alternate_link12= | |||
|alternate_image13= | |||
|alternate_name13= | |||
|alternate_link13= | |||
|alternate_image14= | |||
|alternate_name14= | |||
|alternate_link14= | |||
|alternate_image15= | |||
|alternate_name15= | |||
|alternate_link15= | |||
|alternate_image16= | |||
|alternate_name16= | |||
|alternate_link16= | |||
<!--GENERAL--> | <!--GENERAL--> | ||
|category= | |category= | ||
Line 70: | Line 138: | ||
|writable= | |writable= | ||
|page_number= | |page_number= | ||
|vol_number= | |||
<!--EFFECT--> | <!--EFFECT--> | ||
|unhappy_change= | |unhappy_change= | ||
Line 76: | Line 145: | ||
|recipes= | |recipes= | ||
<!--TECHNICAL DETAILS--> | <!--TECHNICAL DETAILS--> | ||
| | |item_id = | ||
}}</pre> | }} | ||
</pre> | |||
==Parameters== | ==Parameters== | ||
Line 84: | Line 154: | ||
;name_colour: The background colour for the display name. Codes can be found at [[Template:Infobox nc]]. | ;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]]. | ;name_text_colour: The text colour for the display name. Codes can be found at [[Template:Infobox nc]]. | ||
;image: | ;image: Image of the model. | ||
;image_width: Width of the image model. ''Default: 128px'' | |||
;alternate_image: An alternate image displayed at 32px. Can be an empty, packaged, open or any other variant. | ;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_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=== | ===General=== | ||
;weight: The base weight of the item. | ;weight: The base weight of the item. | ||
Line 96: | Line 168: | ||
;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)'' | ||
;vol_number: The number of volumes in this series. ''(remove if value is empty)'' | |||
===Effect=== | ===Effect=== | ||
;unhappy_change: The value of unhappiness that is changed from using/consuming this item. ''(remove if value is empty)'' | ;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)'' | ;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)'' | ;stress_change: The value of stress that is changed from using/consuming this item. ''(remove if value is empty)'' | ||
===Technical details=== | ===Technical details=== | ||
;class_name: The item's class name. | ;class_name: The item's class name. | ||
Line 105: | Line 180: | ||
==Examples== | ==Examples== | ||
'''[[Book]] infobox''' | '''[[Book]] infobox''' | ||
{{ | {{Infobox literature | ||
| | |name =Book | ||
|image=Book.png | |||
|image= | |||
|category=Literature | |category=Literature | ||
|weight=0.5 | |weight=0.5 | ||
Line 116: | Line 189: | ||
|boredom_change=-50 | |boredom_change=-50 | ||
|stress_change=-40 | |stress_change=-40 | ||
| | |item_id =Base.Book | ||
}}<pre>{{ | }} | ||
| | <pre>{{Infobox literature | ||
|name =Book | |||
|image=Book.png | |||
|image= | |||
|category=Literature | |category=Literature | ||
|weight=0.5 | |weight=0.5 | ||
Line 128: | Line 200: | ||
|boredom_change=-50 | |boredom_change=-50 | ||
|stress_change=-40 | |stress_change=-40 | ||
| | |item_id =Base.Book | ||
}}</pre> | }}</pre> | ||
{{ | {{Clear}} | ||
'''[[Skill Books|Skill Book]] infobox''' | '''[[Skill Books|Skill Book]] infobox''' | ||
{{ | {{Infobox literature | ||
| | |name =Metalwork for Beginners | ||
|image=Book7.png | |image=Book7.png | ||
|category= | |category=Literature | ||
|weight=0.8 | |weight=0.8 | ||
|skill_trained=[[Metalworking]] | |skill_trained=[[Metalworking]] | ||
|page_number=220 | |page_number=220 | ||
| | |item_id =Base.BookMetalWelding1 | ||
}}<pre> | }} | ||
{{ | <pre> | ||
| | {{Infobox literature | ||
|name =Metalwork for Beginners | |||
|image=Book7.png | |image=Book7.png | ||
|category=literature | |category=literature | ||
Line 153: | Line 222: | ||
|skill_trained=[[Metalworking]] | |skill_trained=[[Metalworking]] | ||
|page_number=220 | |page_number=220 | ||
| | |item_id =Base.BookMetalWelding1 | ||
}}</pre> | }} | ||
{{ | </pre> | ||
{{Clear}} | |||
'''[[ | '''[[The Farming Magazine]] infobox''' | ||
{{ | {{Infobox literature | ||
| | |name =The Farming Magazine | ||
| | |image=Model Magazine.png | ||
| | |image_width=200px | ||
| | |alternate_image=MagazineFish.png | ||
|alternate_name=The Farming Magazine | |||
|alternate_link= | |||
<!--GENERAL--> | |||
|category=Literature | |category=Literature | ||
|weight=0.1 | |weight=0.1 | ||
|recipes= | |consumed=False | ||
| | |vol_number=1 | ||
}}<pre> | <!--EFFECT--> | ||
{{ | |recipes=Make [[Mildew Spray|Mildew Cure]]<br>Make [[Insecticide Spray|Flies Cure]] | ||
| | <!--TECHNICAL DETAILS--> | ||
| | |item_id =Base.FarmingMag1 | ||
| | }} | ||
| | <pre>{{Infobox literature | ||
|name =The Farming Magazine | |||
|image=Model Magazine.png | |||
|image_width=200px | |||
|alternate_image=MagazineFish.png | |||
|alternate_name=The Farming Magazine | |||
|alternate_link= | |||
<!--GENERAL--> | |||
|category=Literature | |category=Literature | ||
|weight=0.1 | |weight=0.1 | ||
|recipes= | |consumed=False | ||
| | |vol_number=1 | ||
<!--EFFECT--> | |||
|recipes=Make [[Mildew Spray|Mildew Cure]]<br>Make [[Insecticide Spray|Flies Cure]] | |||
<!--TECHNICAL DETAILS--> | |||
|item_id =Base.FarmingMag1 | |||
}}</pre> | }}</pre> | ||
{{ | {{Clear}} | ||
'''[[ | '''[[Map]] infobox''' | ||
{{ | {{Infobox literature | ||
| | |name =March Ridge Map | ||
|image=Map.png | |image=Map.png | ||
|category=Item | |category=Item | ||
|weight=0.1 | |weight=0.1 | ||
|writable=True | |writable=True | ||
| | |item_id =Base.MarchRidgeMap | ||
}}<pre> | }} | ||
{{ | <pre> | ||
| | {{Infobox literature | ||
|name =March Ridge Map | |||
|image=Map.png | |image=Map.png | ||
|category=Item | |category=Item | ||
|weight=0.1 | |weight=0.1 | ||
|writable=True | |writable=True | ||
| | |item_id =Base.MarchRidgeMap | ||
}}</pre> | }} | ||
{{ | </pre> | ||
{{Clear}} | |||
'''[[Journal]] infobox''' | '''[[Journal]] infobox''' | ||
{{ | {{Infobox literature | ||
| | |name =Journal | ||
|image=Notebook.png | |image=Notebook.png | ||
|category=Literature | |category=Literature | ||
Line 213: | Line 293: | ||
|writable=True | |writable=True | ||
|page_number=20 | |page_number=20 | ||
| | |item_id =Base.Journal | ||
}}<pre> | }} | ||
{{ | <pre> | ||
| | {{Infobox literature | ||
|name =Journal | |||
|image=Notebook.png | |image=Notebook.png | ||
|category=Literature | |category=Literature | ||
Line 224: | Line 303: | ||
|writable=True | |writable=True | ||
|page_number=20 | |page_number=20 | ||
| | |item_id =Base.Journal | ||
}}</pre> | }}</pre> | ||
{{ | {{Clear}} |
Latest revision as of 07:29, 15 April 2024
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 | ||||||||
Total volumes | vol_number volumes | ||||||||
Effect | |||||||||
Unhappiness | unhappy_change | ||||||||
Boredom | boredom_change | ||||||||
Stress | stress_change | ||||||||
Technical details | |||||||||
Base ID | Item IDs |
{{Infobox literature |name = |image= |image_width= |alternate_image= |alternate_name= |alternate_link= |alternate_image2= |alternate_name2= |alternate_link2= |alternate_image3= |alternate_name3= |alternate_link3= |alternate_image4= |alternate_name4= |alternate_link4= |alternate_image5= |alternate_name5= |alternate_link5= |alternate_image6= |alternate_name6= |alternate_link6= |alternate_image7= |alternate_name7= |alternate_link7= |alternate_image8= |alternate_name8= |alternate_link8= |alternate_image9= |alternate_name9= |alternate_link9= |alternate_image10= |alternate_name10= |alternate_link10= |alternate_image11= |alternate_name11= |alternate_link11= |alternate_image12= |alternate_name12= |alternate_link12= |alternate_image13= |alternate_name13= |alternate_link13= |alternate_image14= |alternate_name14= |alternate_link14= |alternate_image15= |alternate_name15= |alternate_link15= |alternate_image16= |alternate_name16= |alternate_link16= <!--GENERAL--> |category= |weight= |map= |consumed= |writable= |page_number= |vol_number= <!--EFFECT--> |unhappy_change= |boredom_change= |stress_change= |recipes= <!--TECHNICAL DETAILS--> |item_id = }}
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
- Image of the model.
- image_width
- Width of the image model. Default: 128px
- 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)
- vol_number
- The number of volumes in this series. (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 | |
---|---|
General | |
Category | Literature |
Encumbrance | 0.5 |
Consumed | True |
Effect | |
Unhappiness | -40 |
Boredom | -50 |
Stress | -40 |
Technical details | |
Base ID | Item IDs |
{{Infobox literature |name =Book |image=Book.png |category=Literature |weight=0.5 |consumed=True |unhappy_change=-40 |boredom_change=-50 |stress_change=-40 |item_id =Base.Book }}
Skill Book infobox
Metalwork for Beginners | |
---|---|
General | |
Category | Literature |
Encumbrance | 0.8 |
Total pages | 220 pages |
Technical details | |
Base ID | Item IDs |
{{Infobox literature |name =Metalwork for Beginners |image=Book7.png |category=literature |weight=0.8 |skill_trained=[[Metalworking]] |page_number=220 |item_id =Base.BookMetalWelding1 }}
The Farming Magazine infobox
The Farming Magazine | ||
---|---|---|
| ||
General | ||
Category | Literature | |
Encumbrance | 0.1 | |
Skills learned |
Make Mildew Cure Make Flies Cure | |
Consumed | False | |
Total volumes | 1 volume | |
Technical details | ||
Base ID | Item IDs |
{{Infobox literature |name =The Farming Magazine |image=Model Magazine.png |image_width=200px |alternate_image=MagazineFish.png |alternate_name=The Farming Magazine |alternate_link= <!--GENERAL--> |category=Literature |weight=0.1 |consumed=False |vol_number=1 <!--EFFECT--> |recipes=Make [[Mildew Spray|Mildew Cure]]<br>Make [[Insecticide Spray|Flies Cure]] <!--TECHNICAL DETAILS--> |item_id =Base.FarmingMag1 }}
Map infobox
March Ridge Map | |
---|---|
General | |
Category | Item |
Encumbrance | 0.1 |
Writable | True |
Technical details | |
Base ID | Item IDs |
{{Infobox literature |name =March Ridge Map |image=Map.png |category=Item |weight=0.1 |writable=True |item_id =Base.MarchRidgeMap }}
Journal infobox
Journal | |
---|---|
General | |
Category | Literature |
Encumbrance | 0.1 |
Writable | True |
Total pages | 20 pages |
Technical details | |
Base ID | Item IDs |
{{Infobox literature |name =Journal |image=Notebook.png |category=Literature |weight=0.1 |writable=True |page_number=20 |item_id =Base.Journal }}