Difference between revisions of "Help:Item page guidelines"

From Mushpedia
Jump to: navigation, search
(Added as skeleton completed all the new alien fruit pages)
 
(31 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Caution|(Maybe) coming soon: Detailed instructions on how to populate an '''item page'''.
+
The '''item page system''' is online! Now, the menial peon labor of populating all these pages is ahead of us trusty wiki editors. Thankfully, it's not actually all that hard at all! In fact, it's so easy I could summarize it in 7 steps. And 7 is a lucky number, after all!
  
— [[Image:Kuanti.png|link=User:Ividyon|Designer]] [[User:Ividyon|<span style="color:#d47c2b; font-weight: bold; text-shadow: 1px 1px 0px #000;">ividyon</span>]] ([[User talk:Ividyon|talk]])}}
+
== Quick reference links ==
 +
Reference that will be needed when creating new item pages.
  
== Preliminary info sources ==
+
*'''[[Inventory|Inventory page]]''' (finding the icon names & copying over summaries and info)
*[[Mushpedia:Item_page_guidelines/Skeleton|Page skeleton]]
+
*'''[[Help:Item_page_guidelines/Skeleton|Item page skeleton]]'''
*[[Template:Item_Attributes/doc|Item Attributes template documentation]]
+
*'''[[Template:Item_Attributes/doc|Documentation of Template:Item Attributes fields]]'''
 +
 
 +
== How to make a new item page ==
 +
 
 +
=== Skeleton page (spooky) ===
 +
{{Note|This is the '''highest priority'''! Finishing and adding detailed information can come later; what matters the most is that every page exists in its skeleton form so that we can rewrite the '''[[Inventory]]''' page and make it fancy and cool. For starters, don't bother doing anything but this!}}
 +
 
 +
Setting up a basic skeleton item page is easy as '''π''':
 +
 
 +
# Read the '''[[Template:Item_Attributes/doc|Item Attributes template documentation]]''' to understand what these fields in ''[[Template:Item Attributes]]'' mean.
 +
#*READ THE '''IMPORTANT NOTES''' THEY ARE IMPORTANT OKAY.
 +
#**THEY ARE SO IMPORTANT I WILL LIST THEM AGAIN RIGHT HERE
 +
#***'''Booleans''' are either '''yes''' or '''no'''; written in lowercase. No other values are accepted, they will break things.
 +
#***Most fields marked '''Skippable''', and many have '''default values'''. If the item doesn't deviate from these defaults, or the field does not apply to it (such as ''Weapon Damage'' for a non-weapon), '''remove the field from the list completely!''' This is '''important!'''
 +
#***If you're unsure about what to put in a field, but you know it should have ''some'' content, '''keep it in the list, but empty''' so that any following editors can easily fill it in.
 +
#****Exceptions are '''Repair Chance''' and '''Dismantle Chance'''; if you know these can be repaired/dismantled, but don't know the percentage, write down '''??%'''. This will, at least, mark the item as breakable/dismantleable.
 +
# Check out the source code of an existing, finished item page like {{Item|Anti-Grav Scooter}}, {{Item|Lenses}}, {{Item|Alien Bottle Opener}} etc.
 +
# Pick an unfinished page from the below list of items.
 +
# Paste the '''[[Help:Item_page_guidelines/Skeleton|Item page skeleton]]''' into the page.
 +
# Fill out the ''Item Attributes'' template using the following sources of information:
 +
#*The '''[[Inventory]]''' page
 +
#*If available, ''groomsh'''s screenshots
 +
#*Existing item pages
 +
#*''Mush''
 +
#*Your brain
 +
# ???
 +
# Profit!
 +
 
 +
Once you've performed steps 1-2 to your heart's content, you can continue to repeat steps 3-7 for many many items. That's '''30% less steps''' you have to take per item!!
 +
 
 +
=== In-depth information ===
 +
 
 +
Writing an item page is a lot like writing a [[Skills|Skill]] page, so a lot of information from the '''[[Help:Editing_guidelines#Skill_pages|Skill page guidelines]]''' applies here as well.
 +
 
 +
'''Head rule:''' Look at existing examples and write similar things!
  
 
== Full list of items ==
 
== Full list of items ==
 +
These are most, if not all items in ''Mush''. Each of them will need a page of its very own! A bunch have already been created, others have had screenshots inserted into them for reference (courtesy of the lovely ''groomsh''), yet others are completely empty. That's where you come in!
 +
 +
'''Categories finished so far:''' ''Gear, Exploration, Tools, Weapons''
 +
 +
Items marked ☑ have had a basic skeleton finished. Items marked ✔ have substantial amounts of content added to them.
 +
 +
'''Right now, the priority is to finish basic skeletons for every item!'''
 +
 
<div class="table">
 
<div class="table">
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Gear
 
! Gear
 
|-
 
|-
||{{Item|Alien Bottle Opener}}
+
||{{Item|Alien Bottle Opener}}
 
|-
 
|-
||{{Item|Anti-Grav Scooter}}
+
||{{Item|Anti-Grav Scooter}}
 
|-
 
|-
||{{Item|iTrakie}}
+
||{{Item|iTrakie}}
 
|-
 
|-
|{{Item|Lenses}}
+
|{{Item|Lenses}}
 
|-
 
|-
|{{Item|Oscilloscope}}
+
|{{Item|Oscilloscope}}
 
|-
 
|-
|{{Item|Plastenite Armor}}
+
|{{Item|Plastenite Armor}}
 
|-
 
|-
|{{Item|Protective Gloves}}
+
|{{Item|Protective Gloves}}
 
|-
 
|-
|{{Item|Rolling Boulder}}
+
|{{Item|Rolling Boulder}}
 
|-
 
|-
|{{Item|Sniper Helmet}}
+
|{{Item|Sniper Helmet}}
 
|-
 
|-
|{{Item|Soap}}
+
|{{Item|Soap}}
 
|-
 
|-
|{{Item|Spacesuit}}
+
|{{Item|Spacesuit}}
 
|-
 
|-
|{{Item|Stainproof Apron}}
+
|{{Item|Stainproof Apron}}
 
|-
 
|-
|{{Item|Super Soaper}}
+
|{{Item|Super Soaper}}
 
|-
 
|-
|{{Item|Tracker}}
+
|{{Item|Tracker}}
 
|-
 
|-
|{{Item|Walkie Talkie}}
+
|{{Item|Walkie Talkie}}
 
|-
 
|-
|{{Item|Adjustable Wrench}}
+
|{{Item|Adjustable Wrench}}
 
|}
 
|}
  
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Exploration
 
! Exploration
 
|-
 
|-
|{{Item|Quadrimetric Compass}}
+
|{{Item|Quadrimetric Compass}}
 
|-
 
|-
|{{Item|Rope}}
+
|{{Item|Rope}}
 
|-
 
|-
|{{Item|White Flag}}
+
|{{Item|White Flag}}
 
|-
 
|-
|{{Item|EchoLocator}}
+
|{{Item|EchoLocator}}
 
|-
 
|-
|{{Item|Drill}}
+
|{{Item|Drill}}
 
|-
 
|-
|{{Item|Babel Module}}
+
|{{Item|Babel Module}}
 
|-
 
|-
|{{Item|Thermosensor}}
+
|{{Item|Thermosensor}}
 
|}
 
|}
  
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Tools
 
! Tools
 
|-
 
|-
|{{Item|Hacker Kit}}
+
|{{Item|Hacker Kit}}
 
|-
 
|-
|{{Item|Block of Post-It Notes}}
+
|{{Item|Block of Post-It Notes}}
 
|-
 
|-
|{{Item|Extinguisher}}
+
|{{Item|Extinguisher}}
 
|-
 
|-
|{{Item|MAD Kube}}
+
|{{Item|MAD Kube}}
 
|-
 
|-
|{{Item|Microwave}}
+
|{{Item|Microwave}}
 
|-
 
|-
|{{Item|Duct Tape}}
+
|{{Item|Duct Tape}}
 
|-
 
|-
|{{Item|Superfreezer}}
+
|{{Item|Superfreezer}}
 
|-
 
|-
|{{Item|Alien Holographic TV}}
+
|{{Item|Alien Holographic TV}}
 
|-
 
|-
|{{Item|Tabulatrix}}
+
|{{Item|Tabulatrix}}
 
|}
 
|}
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Weapons
 
! Weapons
 
|-
 
|-
|{{Item|Knife}}
+
|{{Item|Knife}}
 
|-
 
|-
|{{Item|Blaster}}
+
|{{Item|Blaster}}
 
|-
 
|-
|{{Item|Natamy Rifle}}
+
|{{Item|Natamy Rifle}}
 
|-
 
|-
|{{Item|Lizaro Jungle}}
+
|{{Item|Lizaro Jungle}}
 
|-
 
|-
|{{Item|Old Faithful}}
+
|{{Item|Old Faithful}}
 
|-
 
|-
|{{Item|Rocket Launcher}}
+
|{{Item|Rocket Launcher}}
 
|-
 
|-
|{{Item|Grenade}}
+
|{{Item|Grenade}}
 
|}
 
|}
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Instruments
 
! Instruments
 
|-
 
|-
|{{Item|Water Stick}}
+
|{{Item|Camera}}
 
|-
 
|-
|{{Item|Magellan Liquid Map}}
+
|{{Item|Water Stick}}
 
|-
 
|-
|{{Item|Invertebrate Shell}}
+
|{{Item|Magellan Liquid Map}}
 
|-
 
|-
|{{Item|Mush Genome Disk}}
+
|{{Item|Invertebrate Shell}}
 
|-
 
|-
|{{Item|Printed Circuit Jelly}}
+
|{{Item|Mush Genome Disk}}
 
|-
 
|-
|{{Item|Star Map Piece}}
+
|{{Item|Printed Circuit Jelly}}
 
|-
 
|-
|{{Item|Myco Alarm}}
+
|{{Item|Star Map Piece}}
 
|-
 
|-
|{{Item|Mush Sample}}
+
|{{Item|Myco Alarm}} ☑
 +
|-
 +
|{{Item|Mush Sample}}
 
|}
 
|}
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Components
 
! Components
 
|-
 
|-
|{{Item|Metal Scraps}}
+
|{{Item|Scrap Metal}}
 
|-
 
|-
|{{Item|Thick Tube}}
+
|{{Item|Thick Tube}}
 
|-
 
|-
|{{Item|Plastic Scraps}}
+
|{{Item|Plastic Scraps}}
 
|-
 
|-
|{{Item|Old T-Shirt}}
+
|{{Item|Old T-Shirt}}
 
|}
 
|}
 
</div>
 
</div>
 
<div class="table">
 
<div class="table">
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Miscellaneous
 
! Miscellaneous
 
|-
 
|-
|{{Item|Camera}}
+
|{{Item|Space Capsule}}
 
|-
 
|-
|{{Item|Space Capsule}}
+
|{{Item|Fuel Capsule}}
 
|-
 
|-
|{{Item|Fuel Capsule}}
+
|{{Item|Oxygen Capsule}}
 
|-
 
|-
|{{Item|Oxygen Capsule}}
+
|{{Item|HydroPot}}
 
|-
 
|-
|{{Item|HydroPot}}
+
|{{Item|Drone}}
 
|-
 
|-
|{{Item|Drone}}
+
|{{Item|Schrödinger}}
 
|-
 
|-
|{{Item|Schrödinger}}
+
|{{Item|Survival Kit}}
 
|-
 
|-
|{{Item|Survival Kit}}
+
|{{Item|Lunchbox}}
 
|-
 
|-
|{{Item|Lunchbox}}
+
|{{Item|Coffee Thermos}}
 
|-
 
|-
|{{Item|Coffee Thermos}}
+
|{{Item|Swedish Sofa}}
 
|-
 
|-
|{{Item|Swedish Sofa}}
+
|{{Item|Blueprint}}
|-
+
|{{Item|Blueprint}}
+
 
|}
 
|}
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Health
 
! Health
 
|-
 
|-
|{{Item|Bandage}}
+
|{{Item|Bandage}}
 
|-
 
|-
|{{Item|Medikit}}
+
|{{Item|Medikit}}
 
|-
 
|-
|{{Item|Jar of Alien Oil}}
+
|{{Item|Jar of Alien Oil}}
 
|-
 
|-
|{{Item|Retro-Fungal Serum}}
+
|{{Item|Retro-Fungal Serum}}
 
|-
 
|-
|{{Item|Spore Sucker}}
+
|{{Item|Spore Sucker}}
 
|}
 
|}
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Consumables
 
! Consumables
 
|-
 
|-
|{{Item|Anabolic}}
+
|{{Item|Anabolic}}
 
|-
 
|-
|{{Item|Coffee}}
+
|{{Item|Coffee}}
 
|-
 
|-
|{{Item|Organic Waste}}
+
|{{Item|Organic Waste}}
 
|-
 
|-
|{{Item|Standard Ration}}
+
|{{Item|Standard Ration}}
 
|-
 
|-
|{{Item|Cooked Ration}}
+
|{{Item|Cooked Ration}}
 
|-
 
|-
|{{Item|Alien Steak}}
+
|{{Item|Alien Steak}}
 
|-
 
|-
|{{Item|Lombrick Bar}}
+
|{{Item|Lombrick Bar}}
 
|-
 
|-
|{{Item|SuperVitamin Bar}}
+
|{{Item|SuperVitamin Bar}}
 
|-
 
|-
 
|{{Item|Space Potato}}
 
|{{Item|Space Potato}}
Line 196: Line 239:
 
|{{Item|Proactive Puffed Rice}}
 
|{{Item|Proactive Puffed Rice}}
 
|}
 
|}
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Trees
 
! Trees
 
|-
 
|-
Line 211: Line 254:
 
|{{Item|Precatus}}
 
|{{Item|Precatus}}
 
|-
 
|-
|{{Item|}}
+
|{{Item|Buttalien}}
 
|-
 
|-
|{{Item|Fragilane}}
+
|{{Item|Platacia}}
 
|-
 
|-
 
|{{Item|Tubiliscus}}
 
|{{Item|Tubiliscus}}
 
|-
 
|-
|{{Item|}}
+
|{{Item|Graapshoot}}
 
|-
 
|-
 
|{{Item|Fiboniccus}}
 
|{{Item|Fiboniccus}}
Line 228: Line 271:
 
|}
 
|}
  
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Fruit
 
! Fruit
 
|-
 
|-
|{{Item|Banana}}
+
|{{Item|Banana}}
 
|-
 
|-
|{{Item|Creepnut}}
+
|{{Item|Creepnut}}
 
|-
 
|-
|{{Item|Meztine}}
+
|{{Item|Meztine}}
 
|-
 
|-
|{{Item|Guntiflop}}
+
|{{Item|Guntiflop}}
 
|-
 
|-
|{{Item|Ploshmina}}
+
|{{Item|Ploshmina}}
 
|-
 
|-
|{{Item|Precati}}
+
|{{Item|Precati}}
 
|-
 
|-
|{{Item|Bottine}}
+
|{{Item|Bottine}}
 
|-
 
|-
|{{Item|Platacia}}
+
|{{Item|Fragilane}}
 
|-
 
|-
|{{Item|Anemole}}
+
|{{Item|Anemole}}
 
|-
 
|-
|{{Item|Peniraft}}
+
|{{Item|Peniraft}}
 
|-
 
|-
|{{Item|Kubinus}}
+
|{{Item|Kubinus}}
 
|-
 
|-
|{{Item|Caleboot}}
+
|{{Item|Caleboot}}
 
|-
 
|-
|{{Item|Filandra}}
+
|{{Item|Filandra}}
 
|-
 
|-
|{{Item|Jumpkin}}
+
|{{Item|Jumpkin}}
 
|}
 
|}
  
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Written things
 
! Written things
 
|-
 
|-
 
|{{Item|Post-it}}
 
|{{Item|Post-it}}
 
|-
 
|-
|{{Item|Mage Book}}
+
|{{Item|Mage Book}}
 
|-
 
|-
|Mush Research Review?
+
|{{Item|Mush Research Review}} ✔
 
|-
 
|-
|Captain book on the bridge?
+
|{{Item|Commander's Manual}} ✔
 
|-
 
|-
|The List?
+
|{{Item|THE List}}
 
|-
 
|-
|Xyloph list?
+
|{{Item|Xyloph List}}
 
|-
 
|-
|Other documents?
+
|Anything else?
 
|}
 
|}
  
{|class="table-cell" style="text-align: center;"
+
{|class="table-cell"
 
! Pills
 
! Pills
 
|-
 
|-
|Twinoid
+
|{{Item|Twinoid}}
 +
|-
 +
|{{Item|Bacta}}
 +
|-
 +
|{{Item|Eufurylate}}
 +
|-
 +
|{{Item|Soma}}
 +
|-
 +
|{{Item|Xenox}}
 +
|-
 +
|{{Item|Puuquf}}
 +
|-
 +
|{{Item|Pymp}}
 
|-
 
|-
|Bacta
+
|{{Item|Rosebud}}
 
|-
 
|-
|Eufurylate
+
|{{Item|Betapropyl}}
 
|-
 
|-
|Soma
+
|{{Item|Newke}}
 
|-
 
|-
|Xenox
+
|{{Item|Spyce}}
 
|-
 
|-
|more?
+
|{{Item|Pinq}}
 
|}
 
|}
 
</div>
 
</div>

Latest revision as of 10:24, 26 May 2019

The item page system is online! Now, the menial peon labor of populating all these pages is ahead of us trusty wiki editors. Thankfully, it's not actually all that hard at all! In fact, it's so easy I could summarize it in 7 steps. And 7 is a lucky number, after all!

Quick reference links

Reference that will be needed when creating new item pages.

How to make a new item page

Skeleton page (spooky)

Icon Note: This is the highest priority! Finishing and adding detailed information can come later; what matters the most is that every page exists in its skeleton form so that we can rewrite the Inventory page and make it fancy and cool. For starters, don't bother doing anything but this!

Setting up a basic skeleton item page is easy as π:

  1. Read the Item Attributes template documentation to understand what these fields in Template:Item Attributes mean.
    • READ THE IMPORTANT NOTES THEY ARE IMPORTANT OKAY.
      • THEY ARE SO IMPORTANT I WILL LIST THEM AGAIN RIGHT HERE
        • Booleans are either yes or no; written in lowercase. No other values are accepted, they will break things.
        • Most fields marked Skippable, and many have default values. If the item doesn't deviate from these defaults, or the field does not apply to it (such as Weapon Damage for a non-weapon), remove the field from the list completely! This is important!
        • If you're unsure about what to put in a field, but you know it should have some content, keep it in the list, but empty so that any following editors can easily fill it in.
          • Exceptions are Repair Chance and Dismantle Chance; if you know these can be repaired/dismantled, but don't know the percentage, write down ??%. This will, at least, mark the item as breakable/dismantleable.
  2. Check out the source code of an existing, finished item page like Icon Anti-Grav Scooter, Icon Lenses, Icon Alien Bottle Opener etc.
  3. Pick an unfinished page from the below list of items.
  4. Paste the Item page skeleton into the page.
  5. Fill out the Item Attributes template using the following sources of information:
    • The Inventory page
    • If available, groomsh's screenshots
    • Existing item pages
    • Mush
    • Your brain
  6.  ???
  7. Profit!

Once you've performed steps 1-2 to your heart's content, you can continue to repeat steps 3-7 for many many items. That's 30% less steps you have to take per item!!

In-depth information

Writing an item page is a lot like writing a Skill page, so a lot of information from the Skill page guidelines applies here as well.

Head rule: Look at existing examples and write similar things!

Full list of items

These are most, if not all items in Mush. Each of them will need a page of its very own! A bunch have already been created, others have had screenshots inserted into them for reference (courtesy of the lovely groomsh), yet others are completely empty. That's where you come in!

Categories finished so far: Gear, Exploration, Tools, Weapons

Items marked ☑ have had a basic skeleton finished. Items marked ✔ have substantial amounts of content added to them.

Right now, the priority is to finish basic skeletons for every item!