Difference between revisions of "Project Gorgon Wiki:How to help"

From Project: Gorgon Wiki
Jump to: navigation, search
(Add formatting guides navigation at bottom of page)
m (Where to Help: Added a new section about bots.)
 
(20 intermediate revisions by 4 users not shown)
Line 15: Line 15:
 
: [http://www.mediawiki.org/wiki/Help:Moving_a_page Moving a page]
 
: [http://www.mediawiki.org/wiki/Help:Moving_a_page Moving a page]
 
: [http://en.wikipedia.org/wiki/Wikipedia:Transclusion Transclusion] (ie. includes)
 
: [http://en.wikipedia.org/wiki/Wikipedia:Transclusion Transclusion] (ie. includes)
 +
: [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions Parser Functions (advanced; #if, #switch, etc)]
 
; Discussion
 
; Discussion
 
: [http://en.wikipedia.org/wiki/Help:Using_talk_pages Using talk pages]
 
: [http://en.wikipedia.org/wiki/Help:Using_talk_pages Using talk pages]
Line 20: Line 21:
 
: [http://www.mediawiki.org/wiki/Help:Magic_words Magic words]
 
: [http://www.mediawiki.org/wiki/Help:Magic_words Magic words]
 
; Extensions
 
; Extensions
: [http://semeb.com/dpldemo/index.php?title=DPL:Manual The <DPL> tag]
+
: [https://community.fandom.com/wiki/Help:DynamicPageList Overview of DPL]
 +
: [https://help.fandom.com/wiki/Extension:DPL3/Manual More Detailed Manual]
 
</div>
 
</div>
 
|-
 
|-
Line 40: Line 42:
 
|}
 
|}
  
==How do I edit?==
+
==Welcome to the Wiki==
This wiki uses the '''MediaWiki''' platform. If you are new to MediaWiki, see the Help articles on the sidebar.
+
Welcome to the Project Gorgon Wiki. If you found this page, it probably means you want to contribute.
  
Useful tools: [http://www.fraps.com/ FRAPS] (screen captures), [http://www.xnview.com/en/ XnView] (image browser), [http://capture2text.sourceforge.net/ Capture2Text] (capture text straight to the clipboard, saves typing).
+
==First Steps==
 +
1. After you create your account and login for the first time, setup your personal '''User''' and ''' User talk''' pages. Click on your username and "Talk" in the upper right corner (desktop view) to create those pages. Even if you leave them blank, their existence makes it easier for other users to contact you with questions or to request collaboration on a larger project.
  
==Talk Pages==
+
2. Please briefly read [http://www.mediawiki.org/wiki/Help:Talk_pages#Editing_conventions_on_talk_pages MediaWiki Help on Talk Pages]. '''Signatures, indents, and topics''' (headings) on '''User talk''' pages and '''Talk pages''' make it easier to see the flow of discussion and allows future editors who want to get up to date on the history of an article to quickly do so.
Please have a brief read of [http://www.mediawiki.org/wiki/Help:Talk_pages#Editing_conventions_on_talk_pages MediaWiki Help on Talk Pages]. '''Signatures, indents, and topics''' (headings) in Talk Pages make it easier to see how the discussion is going and who has last replied, not just for the person you respond to, but any future editors who want to get up to date on the history of an article.
+
* Consider '''watching''' talk pages (click the star) which you are participating in, as they will be highlighted in the [[Special:RecentChanges]]. You can also change your '''Preferences''' if you want to receive alternative notifications for watched pages.
 +
* Most users will want to place their personal '''User talk''' and '''User''' pages on their watchlist.  
  
Ideally, discussion in talk pages should generate a notification, however it does not work on this wiki yet (we'll have to ask devs to add required extensions). Consider '''watching''' talk pages (click the star) which you are participating in, as they will be highlighted in the [[Special:RecentChanges]]. Either way, structuring talk pages is very helpful.
+
3. Next, it will be helpful to familiarize yourself with some of the information to the right. This wiki uses the '''MediaWiki''' platform. If you are new to MediaWiki, some Help articles can be found on the sidebar.
  
==Formatting==
+
4. When creating pages, we would like to maintain some semblance between similar pages. You can check out the [[Project Gorgon Wiki:Formatting|formatting guidelines]] page for some advice. This page may be outdated, however a '''Article guide pages''' section contains a list of very useful templates that most new pages are built to follow. The best method is to find a similar page, and check the formatting of that page and the template the page is based on. 
Use existing pages as a guide, and for further details see the [[Project Gorgon Wiki:Formatting|formatting guidelines]] page.
+
 
 +
5. You may want to join a [[Discord]] server to communicate with other Gorgon wiki editors.
 +
* Wiki-themed channels can be found in both '''Project: Gorgon (Official)''' and '''The Gorgon's Head Discord'''
 +
* Large group editing projects are usually organized through Discord.
 +
 
 +
5. Finally, pick something to add. You can choose from one of the general categories below, or focus on contributing to anything that you would like to work on.
 +
* If you intend to make change that will impact many pages (rewriting a template, changing the layout of something), it is best to check with an experienced editor first!
 +
* Occasionally a new user will start a project, such as rewriting the ''Locations'' section of the ''Creature Template'', before realizing part of the way through that they have over 900 pages to manually change. In this situation, the user should have asked for help completing the project. Many experienced editors are willing to help!
  
 
==Where to Help==
 
==Where to Help==
 
The following areas of the wiki need the most help:
 
The following areas of the wiki need the most help:
 
+
; Creature Page Updates
; Pages that need fleshing out
+
* Style: Most Creatures require updates to follow the [[Creature Template]]. Most pages have an outdated layout for the Miscellaneous section.
: [[Oritania]] (almost empty) - [[Under the Hand]] - [[Wolf Cave]]
+
* Content: The Reported Loot sections need additional information gathered from in-game!
 
+
* Content: Images. Over 500 creatures still require quality, daytime, cropped screenshots to use in their infoboxes. You can find a list of wanted images at [[Special:WantedFiles]], or browse Anatomy category pages. Red links are usually missing images. Click the "(1 link)" next to the red link, click the page listed below, then from that page click the image link in the article to add a picture. Try to optimize pictures a little bit in Photoshop by using "Save for Web" if your version offers it. Size it down to 400 pixels wide to reduce the file size, as most articles will display a 400px thumb.
; Pages with existing but incomplete tables
+
; Missing Monsters
: [[Gems]] (complete the table)
+
* There may be missing monsters on the wiki. Usually, these are unique summons by bosses.
: [[Teleportation]] recipes
+
; NPCs
: [[Surveying]] (list of maps and what gems they lead to)
+
* Style: Many NPCs are using an outdated layout for their Training section. The proper format can be found on the [[NPC Template]] page.
 
+
* Content: Most NPCs are missing their Conversations section.
 
; Skills
 
; Skills
: Listing of the Advanced Abilities and where they drop or who teaches them (very useful)
+
* Content: Most skill pages require a few sentences to be written introducing the skill, and require elaboration of Mechanics.
: If you have high level play experience:
+
** Mechanics for [[Druid]], [[Warden]], [[Priest]], and [[Beast Forms|Beast Form]] skills need content submitted by players who are proficient in those skills.
:: ... overview of pros and cons (good abilities, bad abilities)
+
* Content: Most skill pages require an image for their infobox. This is recommended to be a quality image of something that represents the skill.
:: ... relevant equipment/desirable augments on items (consider adding an example with [[Template:ItemT]])
 
:: ... which other skills does it work well with? and why?
 
: Simple lists or tables of level up skills/rewards. <span style="color:#F00;font-size:1.5em;">*</span>
 
 
 
; Recipes
 
: Simple lists or tables of recipes. <span style="color:#F00;font-size:1.5em;">*</span>. Such lists are useful for the wiki search, even without individual pages, if a player /wiki "fried banana" ... the pages listing the recipe will show up in the results.
 
 
 
 
; Dungeons
 
; Dungeons
: Higher level dungeons are poorly documented atm:
+
* Content: Most dungeon pages require elaboration on Points of Interest.
:: Listing of foes, special foes, and harvestable nodes
+
* Content: Most dungeon pages have a sparsely populated Harvestables section.
:: Describe Points of Interest in the dungeon
+
* Content: Most dungeon pages are missing a screenshot of the in-game map, without any labels.
:: Add articles for missing bosses
+
* Content: Comments may be added to the introductory section of a dungeon page, describing why players explore the dungeon. Are they there to collect any particular loot? Is it usually because of a quest?
:: Any particular general loot , quest loot that drops here?
+
* Content: Consider adding a few screenshots to highlight the sights in a gallery tag (see [[Dungeon Template]]).
:: Consider adding a few images to highlight the sights in a gallery tag (see [[Dungeon Template]])
+
; Gameplay
 +
* Content: Pretty much all gameplay/mechanics articles should be expanded upon.
 +
; Wanted Pages
 +
* The Project Gorgon wiki automatically generates a list of pages it believes to be "wanted" at [[Special:WantedPages]]. While this list can be helpful at identifying actually missing pages, the inclusion of something on this list does not guarantee that a page is necessary.
 +
:*Items are added to the Wanted Pages list when a broken link is created on another content page. Sometimes the link is created from a misspelled word! If so, fix the spelling mistake and do not create a page for the misspelled word.
 +
:*Intentionally deleted categories can sometimes appear on this list. As an example, the Wanted Pages list includes '''Category:Halloween 2017''' as a Wanted Page. This is a category which once existed on the wiki but was consolidated into a different category years ago. It still appears on the Wanted Pages list because of how the wiki system processes subcategories.
 +
:*If you believe a page or pages included on the Wanted Pages list should actually be created, please create it if you are able to submit the proper content for that page. If a Quest appears on the Wanted Pages list and you are not proficient at adding quest pages, it would be better to leave the page in the list than to create a half-correct page!
 +
; Mark pages for Deletion
 +
* If you come across an irrelevant or duplicate page and want to have it deleted, add the code <b><nowiki>[[Category:Candidates for deletion]]</nowiki></b> to the bottom of the page. One of the wiki administrators will be notified.
 +
== Bots==
 +
The Project Gorgon Wiki uses a variety of bots to create or update certain types of pages with content provided by the developers through the public CDN repository for Project: Gorgon. Users should be aware that some of their edits may be overwritten by a bot when it is activated.
  
; High level Zones
+
'''TamiqBot'''
:: '''Sun Vale''' NPCs, foes, landmarks (during alpha some abilities may move from one vendor to another, but those edits will not be lost, just moved to other articles as the game updates)
+
:- Creates new Item pages.
 +
:- Creates Loot subcategories.
 +
:- Updates ITEM infobox on Item pages.
 +
:- May update other parts of Item pages as required.
 +
'''ExtraBot'''
 +
:- Creates or updates '''Recipes''' subpages for each Skill.
 +
:- Creates or updates '''Abilities''' subpages for each Skill.
 +
:- Creates or updates '''Stat Bonuses''' subpages for each Skill.
 +
:- Creates or updates '''Level up Rewards''' subpages for each Skill.
 +
:- Creates or updates '''Treasure Effects''' subpage for each Skill.
 +
:- Creates or updates '''Treasure Effects:By Slot''' subpages for each Skill.
 +
:- Creates or updates '''Treasure Effects:By Ability''' subpages for each Skill.
 +
:- Updates Work Orders subpage for '''Industry'''.
 +
:- Updates '''Templates''' related to icons (Template:Item icon, Template:Ability icon).
 +
:- Updates '''Synergy Levels''' page.
 +
'''AllyBot'''
 +
{{Quote|source=Additional details can be found at: [[User:Alleryn]]|
 +
Maintains:
 +
* For item pages:
 +
** Recipes using given item as ingredient and Recipes producing given item
 +
** Quests that require a given item, and Quests that reward a given item
 +
** Npcs whose Favor is affected by gifting a given item
 +
** Abilities that consume given item as ammo
 +
* [[Hardcore_Mode#List_of_Items_Usable_Only_in_Hardcore_Mode]]
 +
* [[Gourmand/Edibles]], [[Gourmand/Meals]], [[Gourmand/Snacks]], [[Gourmand/Instant-Snacks]]
 +
* [[Template:Attribute icon]] and [[Template:Attribute label]]
 +
* The Xp tables (the pages in [[:Category:Xptable]])
 +
AllyBot is on GitHub: https://github.com/alleryn/ProjectGorgonWiki-AllyBot
 +
}}
 +
'''KedochBot'''
 +
:- Creates or Updates '''Quest''' pages.
  
; Missing images
+
== Spoilers ==
: Look at [[Special:WantedFiles]]. Red links are usually missing images. Click the "(1 link)" next to the red link, click the page listed below, then from that page click the image link in the article to add a picture. Try to optimize pictures a little bit in Photoshop by using "Save for Web" (JPEG). Size it down to 300 pixels wide to reduce the file size, as most articles will display a 300px thumb. Larger images can be used in the Galleries at bottom of dungeon/zone articles.
+
Although the Project Gorgon Wiki generally displays a large '''A Note About SPOILERS !''' on the homepage warning users they may find unmarked spoilers, we do use a spoiler system. For the most part, if you are typing up a particular type of page, refer to the template for that type of content to see what goes into a spoiler. (NPCs, Dungeons, Skills, Abilities). Many spoiler tags are also used to collapse large lists.
  
; IMPORTANT
+
Outside of existing template-defined styles, is hard to provide a Yes/No list for what should or should not go in a spoiler. The location of a dungeon should not be a spoiler. If the dungeon requires a very specific method to access, that information should probably be placed in a spoiler! The [[Dark Chapel]] in Eltibule is a good example. The existence of the dungeon is not a spoiler. The puzzle-based method to access the dungeon is a spoiler. Project Gorgon is exploration based, so some spoilers might damage potential discoveries players might make. In general, record everything, but if the topic spoils a riddle, puzzle, or is something extremely hidden, it is best to spoiler tag it.
: <span style="color:#F00;font-size:1.5em;">*</span> Please be aware that Eric (lead dev) has expressed interest in feeding most abilities/recipes into the wiki at some point (probably using the "Semantic" extension and formatting tables with special templates). That  means you should probably not create any individual pages for recipes or abilities at this point during alpha. Doing so is not terribly useful as the wiki search will find them in relevant lists (NPCs, or Skills pages), and they may be overwritten when this data is fed into the wiki directly from the developer's spreadsheets/database. If you have knowledge of how to automate this kind of thing, please message [[User talk:Gorgonzola]]. The ''design'' of such tables can be discussed in the [[Skill Template]] page.
 
  
 
==Sources for the Wiki==
 
==Sources for the Wiki==
Line 100: Line 143:
 
==F.A.Q.==
 
==F.A.Q.==
 
; Q. This wiki is too light/bright/does not look like a gaming wiki!
 
; Q. This wiki is too light/bright/does not look like a gaming wiki!
: A: This is completely unimportant during the alpha. This wiki is hosted by the developers themselves, on their own domain. This means in due time, they may very well decide to revamp the general appearance to something more exciting. They obviously have more important things to do during alpha. What matters now is providing quality content and help for the players. If you prefer, consider helping out the [http://project-gorgon.wikia.com/wiki/Project_Gorgon_Wiki Project: Gorgon Wikia site] instead.
+
: A: This is completely unimportant during the alpha. This wiki is hosted by the developers themselves, on their own domain. This means in due time, they may very well decide to revamp the general appearance to something more exciting. They obviously have more important things to do during alpha. What matters now is providing quality content and help for the players.
  
 
; Q. The rich text editor is too basic/ the syntax is complicated.
 
; Q. The rich text editor is too basic/ the syntax is complicated.

Latest revision as of 12:18, 5 July 2023

MediaWiki Help
Special Pages

Welcome to the Wiki

Welcome to the Project Gorgon Wiki. If you found this page, it probably means you want to contribute.

First Steps

1. After you create your account and login for the first time, setup your personal User and User talk pages. Click on your username and "Talk" in the upper right corner (desktop view) to create those pages. Even if you leave them blank, their existence makes it easier for other users to contact you with questions or to request collaboration on a larger project.

2. Please briefly read MediaWiki Help on Talk Pages. Signatures, indents, and topics (headings) on User talk pages and Talk pages make it easier to see the flow of discussion and allows future editors who want to get up to date on the history of an article to quickly do so.

  • Consider watching talk pages (click the star) which you are participating in, as they will be highlighted in the Special:RecentChanges. You can also change your Preferences if you want to receive alternative notifications for watched pages.
  • Most users will want to place their personal User talk and User pages on their watchlist.

3. Next, it will be helpful to familiarize yourself with some of the information to the right. This wiki uses the MediaWiki platform. If you are new to MediaWiki, some Help articles can be found on the sidebar.

4. When creating pages, we would like to maintain some semblance between similar pages. You can check out the formatting guidelines page for some advice. This page may be outdated, however a Article guide pages section contains a list of very useful templates that most new pages are built to follow. The best method is to find a similar page, and check the formatting of that page and the template the page is based on.

5. You may want to join a Discord server to communicate with other Gorgon wiki editors.

  • Wiki-themed channels can be found in both Project: Gorgon (Official) and The Gorgon's Head Discord
  • Large group editing projects are usually organized through Discord.

5. Finally, pick something to add. You can choose from one of the general categories below, or focus on contributing to anything that you would like to work on.

  • If you intend to make change that will impact many pages (rewriting a template, changing the layout of something), it is best to check with an experienced editor first!
  • Occasionally a new user will start a project, such as rewriting the Locations section of the Creature Template, before realizing part of the way through that they have over 900 pages to manually change. In this situation, the user should have asked for help completing the project. Many experienced editors are willing to help!

Where to Help

The following areas of the wiki need the most help:

Creature Page Updates
  • Style: Most Creatures require updates to follow the Creature Template. Most pages have an outdated layout for the Miscellaneous section.
  • Content: The Reported Loot sections need additional information gathered from in-game!
  • Content: Images. Over 500 creatures still require quality, daytime, cropped screenshots to use in their infoboxes. You can find a list of wanted images at Special:WantedFiles, or browse Anatomy category pages. Red links are usually missing images. Click the "(1 link)" next to the red link, click the page listed below, then from that page click the image link in the article to add a picture. Try to optimize pictures a little bit in Photoshop by using "Save for Web" if your version offers it. Size it down to 400 pixels wide to reduce the file size, as most articles will display a 400px thumb.
Missing Monsters
  • There may be missing monsters on the wiki. Usually, these are unique summons by bosses.
NPCs
  • Style: Many NPCs are using an outdated layout for their Training section. The proper format can be found on the NPC Template page.
  • Content: Most NPCs are missing their Conversations section.
Skills
  • Content: Most skill pages require a few sentences to be written introducing the skill, and require elaboration of Mechanics.
  • Content: Most skill pages require an image for their infobox. This is recommended to be a quality image of something that represents the skill.
Dungeons
  • Content: Most dungeon pages require elaboration on Points of Interest.
  • Content: Most dungeon pages have a sparsely populated Harvestables section.
  • Content: Most dungeon pages are missing a screenshot of the in-game map, without any labels.
  • Content: Comments may be added to the introductory section of a dungeon page, describing why players explore the dungeon. Are they there to collect any particular loot? Is it usually because of a quest?
  • Content: Consider adding a few screenshots to highlight the sights in a gallery tag (see Dungeon Template).
Gameplay
  • Content: Pretty much all gameplay/mechanics articles should be expanded upon.
Wanted Pages
  • The Project Gorgon wiki automatically generates a list of pages it believes to be "wanted" at Special:WantedPages. While this list can be helpful at identifying actually missing pages, the inclusion of something on this list does not guarantee that a page is necessary.
  • Items are added to the Wanted Pages list when a broken link is created on another content page. Sometimes the link is created from a misspelled word! If so, fix the spelling mistake and do not create a page for the misspelled word.
  • Intentionally deleted categories can sometimes appear on this list. As an example, the Wanted Pages list includes Category:Halloween 2017 as a Wanted Page. This is a category which once existed on the wiki but was consolidated into a different category years ago. It still appears on the Wanted Pages list because of how the wiki system processes subcategories.
  • If you believe a page or pages included on the Wanted Pages list should actually be created, please create it if you are able to submit the proper content for that page. If a Quest appears on the Wanted Pages list and you are not proficient at adding quest pages, it would be better to leave the page in the list than to create a half-correct page!
Mark pages for Deletion
  • If you come across an irrelevant or duplicate page and want to have it deleted, add the code [[Category:Candidates for deletion]] to the bottom of the page. One of the wiki administrators will be notified.

Bots

The Project Gorgon Wiki uses a variety of bots to create or update certain types of pages with content provided by the developers through the public CDN repository for Project: Gorgon. Users should be aware that some of their edits may be overwritten by a bot when it is activated.

TamiqBot

- Creates new Item pages.
- Creates Loot subcategories.
- Updates ITEM infobox on Item pages.
- May update other parts of Item pages as required.

ExtraBot

- Creates or updates Recipes subpages for each Skill.
- Creates or updates Abilities subpages for each Skill.
- Creates or updates Stat Bonuses subpages for each Skill.
- Creates or updates Level up Rewards subpages for each Skill.
- Creates or updates Treasure Effects subpage for each Skill.
- Creates or updates Treasure Effects:By Slot subpages for each Skill.
- Creates or updates Treasure Effects:By Ability subpages for each Skill.
- Updates Work Orders subpage for Industry.
- Updates Templates related to icons (Template:Item icon, Template:Ability icon).
- Updates Synergy Levels page.

AllyBot

Maintains:

AllyBot is on GitHub: https://github.com/alleryn/ProjectGorgonWiki-AllyBot

— Additional details can be found at: User:Alleryn

KedochBot

- Creates or Updates Quest pages.

Spoilers

Although the Project Gorgon Wiki generally displays a large A Note About SPOILERS ! on the homepage warning users they may find unmarked spoilers, we do use a spoiler system. For the most part, if you are typing up a particular type of page, refer to the template for that type of content to see what goes into a spoiler. (NPCs, Dungeons, Skills, Abilities). Many spoiler tags are also used to collapse large lists.

Outside of existing template-defined styles, is hard to provide a Yes/No list for what should or should not go in a spoiler. The location of a dungeon should not be a spoiler. If the dungeon requires a very specific method to access, that information should probably be placed in a spoiler! The Dark Chapel in Eltibule is a good example. The existence of the dungeon is not a spoiler. The puzzle-based method to access the dungeon is a spoiler. Project Gorgon is exploration based, so some spoilers might damage potential discoveries players might make. In general, record everything, but if the topic spoils a riddle, puzzle, or is something extremely hidden, it is best to spoiler tag it.

Sources for the Wiki

Besides in-game content, a list of known sources that can be used to flesh out the wiki:

F.A.Q.

Q. This wiki is too light/bright/does not look like a gaming wiki!
A: This is completely unimportant during the alpha. This wiki is hosted by the developers themselves, on their own domain. This means in due time, they may very well decide to revamp the general appearance to something more exciting. They obviously have more important things to do during alpha. What matters now is providing quality content and help for the players.
Q. The rich text editor is too basic/ the syntax is complicated.
A: It is. Consider it a new skillset. With that said, keep in mind this is collaborative work. If you don't like formatting things, simply focus on quality content. Someone else who is more into the layout and formatting will simply go over and tidy up things.
Formatting guides
How to helpFormattingCategories