Help:Editing Guide: Difference between revisions
Wangsta thug (talk | contribs) No edit summary |
Wangsta thug (talk | contribs) No edit summary |
||
Line 16: | Line 16: | ||
== Infoboxes == | == Infoboxes == | ||
Infoboxes are the right-side boxes on certain pages with data points in them. To use Infoboxes on a page, you simply put code like the following | Infoboxes are the right-side boxes on certain pages with data points in them. To use Infoboxes on a page, you simply put code like the following | ||
< | <syntaxhighlight lang="wikitext" style="overflow: auto"> | ||
{{Infobox NPC | {{Infobox NPC | ||
| Name = Wade | | Name = Wade | ||
Line 24: | Line 24: | ||
| Room = 27496 | | Room = 27496 | ||
}} | }} | ||
</ | </syntaxhighlight> | ||
Revision as of 01:21, 10 July 2023
Purpose
The purpose of this Editing Guide is to ensure that organizational and formatting is consistent across the wiki. By ensuring the experience is consistent for all users, it reduces complexity of understanding and also makes it easier to manage the overall wiki.
Page Heirarchy
All pages should try to be as high-level as makes practical sense with proper use of Headings. This results in good organization of content and reduces the amount of clicking a user will need to experience to obtain information.
For example, there are 4 Crests in the game. In some thought processes, someone would make a page per Crest. It makes much more sense to make an overall Crests page and then individualize specific Crest information with Headers.
Page Structure
All Header 2 sections should be double paragraphed apart.
Header 3-5 sections should only have single paragraph separation.
Infoboxes
Infoboxes are the right-side boxes on certain pages with data points in them. To use Infoboxes on a page, you simply put code like the following
{{Infobox NPC
| Name = Wade
| Image = Wade.png
| Location = [[Diamond City Sanctum]]
| Level = 75
| Room = 27496
}}
Non-Player Character (NPC) Page
Every NPC Page should be the exact name of the NPC with matching grammar as well as their room number in parentheses and separated by a space. For example: "Wade (27496)"
Every NPC page should be organized in the following way:
- Category
- Infobox
- About
- Quests Starter
- Items
Category
At the beginning of every NPC page, the following text should exist to properly categorize this as an NPC: "[[Category:NPC]]".
Infobox
After the Category, the next section should be the Template: Infobox NPC. All rows for this Infobox should be completed.
Image
Every NPC should have their photo uploaded as a Thumb image. The file name of the image should be the NPC's name as spelled exactly in the game with same formatting. The Name, Description, and Caption of the image on this wiki should be the same exact name.
About
Should be a Header 2 Section.
Should have the following sentence: "(Name) is an NPC." Following that should be further explanation if they are a key NPC for the game, for example: "Wade is an NPC and the main quest giver for the Badge.".
Quests
Should be a Header 2 Section.
Any quests that this player provides should be number listed out in alphabetical order and appropriately linked to the quest(s) page.
Items
Should be a Header 2 Section.
Any items that this player provides should be number listed out in alphabetical order and appropriately linked to the quest(s) page.
Location Page
Every location page should be organized in the following way:
- Category
- Story
- Questlines
Category
At the beginning of every Location page, the following text should exist to properly categorize this as a Location: "[[Category:Location]]".
Story
Should be a Header 2 Section.
This section should contain information about when the location was added to the game as well as any story information about it.
Questlines
Should be a Header 2 Section.
This section should contain important questline information that happens in that location.
Quest Page
Every quest page should be organized in the following way:
- Category
- Story
- Pathway
Category
At the beginning of every Location page, the following text should exist to properly categorize this as a Location: "[[Category:Quest]]".
Story
Should be a Header 2 Section.
This section should contain information about when the quest was added to the game as well as any story information about it.
Pathway
Should be a Header 2 Section.
This section should contain a table with the following headers: #, Talker, Message, Conditions, and Reward. In the rows beneath that, they should be numbered in order and filled in with the NPC, Dialogue, Conditions to complete that step of the quest, and any reward(s) provides for completion of that quest step.
Mob Page
Every NPC Page should be the exact name of the Mob with matching grammar as well as the word "Mob" in parentheses and separated by a space. For example: "Mob:Junkrat"
Every Mob page should be organized in the following way:
- Category
- Infobox
- About
- Items
Category
At the beginning of every Mob page, the following text should exist to properly categorize this as a Mob: "[[Category:Mob]]".
Infobox
After the Category, the next section should be the Template: Infobox Mob. All rows for this Infobox should be completed.
Image
Every Mob should have their photo uploaded as a Thumb image. The file name of the image should be the NPC's name as spelled exactly in the game with same formatting. The Name, Description, and Caption of the image on this wiki should be the same exact name.
About
Should be a Header 2 Section.
Should have the following sentence: "(Name) is a Mob." This section should contain any other useful and relevant data.
Items
Should be a Header 2 Section.
Any items that this Mob drops or provides should be bulleted in alphabetical order and appropriately linked to the item(s) page.
Item Page
Every item page should be organized in the following way:
- Category
- Image
- About
- How to Obtain
Category
At the beginning of every item page, the following text should exist to properly categorize this as an item: "[[Category:Item]]".
Image
If an item has an image, it should be uploaded as a Thumb image. The file name of the image should be the item name as spelled exactly in the game with same formatting. The Name, Description, and Caption of the image on this wiki should be the same exact name.
About
Should be a Header 2 Section.
This section should discuss what this item is.
If any quests of which this item is necessary for should be listed under a Header 3 called "Related Quests" and in bulleted form in alphabetical order.
How to Obtain
Should be a Header 2 Section.
This section should list out, in bulleted form and alphabetical, all NPC's, mobs, quests, and/or Treasury information that drop or provide the item.