Actions

Difference between revisions of "Contributing to the wiki"

From Outscape Wiki

m
m (Things you should definitely do)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Thinking about [[#How_to_help|helping out with the wiki]]? This page will get you up to speed and explain how and [[#How_to_help|where to get started]].
+
Thinking about [[#How_to_help|helping out with the wiki]]? This page will get you up to speed and explain how and where to get started. Editors are also encouraged to look through the wiki's [[Manual of Style]] for editing tips and page formatting.
  
 
__TOC__
 
__TOC__
Line 5: Line 5:
 
== Your help needed ==
 
== Your help needed ==
  
This community wiki is for Beyond Dark players and we need your help to improve it. Your contributions are not only valued, but enable us to focus more time on developing new features and making the best game possible!
+
This community wiki is for Outscape players and we need your help to improve it. Your contributions are not only valued, but enable us to focus more time on developing new features and making the best game possible!
  
While members of the Beyond Dark development team participate in maintaining this wiki, it is a community wiki, and we encourage players to get involved however they can. Contributing could be a sentence or two clarifying how something in the game works, amending stats, fixing grammar on a page, uploading an image, a new page about strategies, a gameplay guide – it's up to you :)
+
While members of the Outscape development team participate in maintaining this wiki, it is a community wiki, and we encourage players to get involved however they can. Contributing could be a sentence or two clarifying how something in the game works, amending stats, fixing grammar on a page, uploading an image, a new page about strategies, a gameplay guide – it's up to you.
  
We'd also love it if players would create some really compelling new player guides, with mini missions such as destroying a pirate fleet or colonizing a 2nd homeworld. We know early game is slow and we are working on that, but often new players don't realize there is actually a lot to do which they are overlooking. We'd be happy to see multiple starter guides in the wiki e.g. "Tim's Syntis Newbie guide".
+
We'd also love it if players would create some really compelling new [[:Category:Player Guides|player guides]], with mini missions such as destroying a pirate fleet or colonizing a second homeworld. We know early game is slow and we are working on that, but often new players don't realize there is actually a lot to do which they are overlooking. We'd be happy to see multiple starter guides in the wiki e.g. "Tim's Syntis Newbie guide".
  
 
Overall, don't be afraid to add new content. The biggest problem right now is lack of content!
 
Overall, don't be afraid to add new content. The biggest problem right now is lack of content!
  
 
== How to help ==
 
== How to help ==
 +
 +
Before pages can be edited, new editors must [[Special:CreateAccount|create and verify a Wiki account]]. An editor's Wiki account is not connected to their forum or game accounts. For ease of communication, new editors are requested to use the same user handles as they do on the forum and in-game, to help people easily find each other.
  
 
* Take a look at the pages under the following categories:
 
* Take a look at the pages under the following categories:
 +
** [[Special:WantedPages|Wanted Pages]]: pages listed here are linked to by other pages, but don't exist yet and so need to be created.
 
** [[:Category:Need starting|Need starting]]: pages in this category will be empty (possibly with a data table/image only) and in need of at least some basic details added.
 
** [[:Category:Need starting|Need starting]]: pages in this category will be empty (possibly with a data table/image only) and in need of at least some basic details added.
 
** [[:Category:Need expanding|Need expanding]]: content in this category needs expanding e.g. more points covered, a data table adding, images.
 
** [[:Category:Need expanding|Need expanding]]: content in this category needs expanding e.g. more points covered, a data table adding, images.
 
** [[:Category:Need updating|Need updating]]: content that could now be outdated or has room for improvement.
 
** [[:Category:Need updating|Need updating]]: content that could now be outdated or has room for improvement.
 
** [[:Category:Need verifying|Need verifying]]: content in this category needs to be verified for accuracy/quality and moved to [[:Category:Need updating|Need updating]] if necessary.
 
** [[:Category:Need verifying|Need verifying]]: content in this category needs to be verified for accuracy/quality and moved to [[:Category:Need updating|Need updating]] if necessary.
 +
** [[:Category:Need images|Need images]]: pages in this category could benefit from one or more new images, or updated versions of existing images.
 
* Validate [[Special:RecentChanges|recent wiki activity]] (click the diff/hist to see what changed)
 
* Validate [[Special:RecentChanges|recent wiki activity]] (click the diff/hist to see what changed)
 
* Improve existing pages.
 
* Improve existing pages.
 
* Correct grammar mistakes and inaccurate content.
 
* Correct grammar mistakes and inaccurate content.
  
=== Discussing this wiki on the forum ===
+
== Basic Editing Tips ==
 
 
The [https://forum.beyonddark.net/c/wiki Beyond Dark forum] has an area for discussing this wiki. Please post there if you need help with anything, have any suggestions for this wiki, or wish to discuss something with fellow wiki contributors.
 
 
 
== Wiki editing quick start ==
 
 
 
* [[Special:CreateAccount|Create a wiki account]] (wiki account is not connected to game accounts)
 
* Click the "Edit" page tab at the top of the page
 
* Make changes to the text
 
* Click the "Show preview" button to preview your changes before committing them
 
* Once you are satisfied with your changes, click the "Save changes" button
 
 
 
== Using the editor ==
 
 
 
This wiki uses [https://mediawiki.org MediaWiki] - the same open source software as [https://en.wikipedia.org Wikipedia] - so editing this wiki works in the same way. Anything related to editing a page not covered here, should be covered on [https://www.mediawiki.org/wiki/Help:Editing the MediaWiki Help pages].
 
 
 
=== Formatting text ===
 
 
 
To achieve anything other than plain text, special formatting must be used. Typically, this will be limited to headers, lists, links, and some basic font styling e.g. italic or bold. To find out how to format text:
 
 
 
* Visit the [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki page on formatting] for a comprehensive list of text formatting options (bold, italic, lists, headers, etc.).
 
* Click the "Edit" tab on other pages to see how they have used formatting
 
 
 
==== Headers ====
 
 
 
Headers are used to organise a page and provide structure. The wiki also uses them to automatically generate the page contents shown at the top of most pages.
 
 
 
Headers should be placed on their own line and can be used between Levels 2 and 6 (Level 1 is reserved for the page title).
 
 
 
<pre><nowiki>
 
== Level 2 ==
 
 
 
=== Level 3 ===
 
  
==== Level 4 ====
+
The basic editing tips are meant for the casual editor who plans on adding some information to the Outscape Wiki. Following these guidelines will ensure that your contribution will require little or no follow up edits.
  
===== Level 5 =====
+
#Before editing, check that your information is factual. Theories and unverified information should never be on the wiki and are best discussed on the forums.
 +
#You can start editing an article by clicking on the edit link in each section, or by clicking on the Actions --> Edit tab on the top-right of the page. Whenever possible, choose to edit a small section of a page instead of the full page. This is useful when working on long pages. If a page requires edits in multiple sections, edit each section individually.
 +
#After finishing the edit, do '''not''' click save yet. First, make sure you check your edit visually using the "Show Preview" button. Check spelling, grammar, formatting, and links to assure they are correct and working.
 +
#If you are lost in your own edit, you can click on the "Show Changes" button to see the work you have done.
 +
#Make sure to include an '''Edit Summary''' of the work you have done. It is the textbox located above the buttons. This will provide other editors with info on the work done, and helps keep the page history organized.
 +
#Tick the minor edit box if the information you have added is trivial, or edits involve minor issues such as grammar, spelling, existing link fixes, etc.
 +
#Only after going through the steps 3 to 6, should you then proceed with a save.
  
====== Level 6 ======
 
</nowiki></pre>
 
  
==== Links ====
+
Interested editors should read the [[Manual of Style]] for more information.
  
Links can be used to link to both pages and categories. The anchor text can be generated automatically or overridden. In addition to the below examples, you can [https://www.mediawiki.org/wiki/Help:Links find out more about link formatting here].
+
=== Additional Tips ===
  
<pre><nowiki>
+
*Checking the recent page history for past edits is usually a good idea. If the last edit introduced too many errors or will be difficult to correct, then it is easier to perform an "Undo" instead and start a fresh edit.
[[Mankind]] (link to the page Mankind)
+
*When performing an undo, make sure to include the reason for the reversion in the edit edit summary.
[[Mankind|View the Mankind page]] (link to the page Mankind with custom anchor text)
 
[[:Category:Mankind]] (link to the Mankind category)
 
[[:Category:Mankind|View all Mankind related content]] (link to the Mankind category with custom anchor text)
 
</nowiki></pre>
 
  
=== Images ===
+
== Discussing this wiki ==
  
To use an image on the page, it must be [[Special:Upload|uploaded to the wiki]] if it hasn't already been. Once uploaded, it can be embedded to a page using the following syntax:
+
=== Discussion and Talk Pages ===
  
<pre><nowiki>[[File:My_Image.jpg|400px]]</nowiki></pre>
+
Individual articles have Discussion pages, which can be used to discuss or leave notes for individual pages. Similarly, Wiki users have Talk pages, which can be used for editors to leave messages for one another.
  
See [https://www.mediawiki.org/wiki/Help:Images this page] for more info on using images. If another page displays content in a way that you would like to copy, you can always click the "Edit" button to take a look at the code to see how it was done.
+
Some additional guidelines for edits to User and User:Talk pages:
  
=== Data tables ===
+
*Avoid editing another User's page - this is considered very poor etiquette. Most users prefer that it is left for their own work, such as an introduction or list of things they are working on.
 +
*When making a new comment on a User:Talk page, make sure to use a section tag using "<nowiki>== A Section Tag ==</nowiki>" by adding 2 equal characters at the front and back of the section header.
 +
*If you are giving a reply, don't forget to indent it accordingly, as shown in the example below. This is done by adding a ':' colon mark for each level of indent.
 +
:''Indentation''
 +
::''Example''
 +
:::''Here''
 +
*Lastly, don't forget to '''sign''' your comments. This can be done easily by adding four tildes (<nowiki>~~~~</nowiki>) at the end of the comment.
  
Some pages contain data tables which automatically render data that we have exported to a spreadsheet. This data is updated automatically as the game config is adjusted. Pages where these data table tags can be found are fine to edit, but the data table code itself should remain untouched to avoid disabling the table.
+
=== Outscape Forum ===
  
This example is taken from the [[Banshee]] page:
+
The [https://forum.outscape.net/c/wiki Outscape forum] has an area for discussing this wiki. Please post there if you need help with anything, have any suggestions for this wiki, or wish to discuss something with fellow wiki contributors.
  
<pre><nowiki><datatable type="hull">https://spreadsheets.google.com/tq?tqx=out:csv&tq=SELECT%20A%2CB%2CC%2CD%2CE%2CF%2CG%2CH%2CI%2CJ%2CK%2CL%2CM%2CN%2CO%2CP%2CQ%2CR%2CS%2CT%2CU%2CV%2CAB%2CAC%20WHERE%20AC%20%3D%20%27Banshee%27&key=1GH0-ndSbVI2gAbzNrOjJxtyNwkOqoqyhwv9LTsFWWDM&gid=1386123040</datatable></nowiki></pre>
+
== Things you should definitely do ==
  
This example is from the [[Mankind_Hulls|Mankind Hulls]] page:
+
To make the Wiki the best it can be, editors are encouraged to follow these pointers:
  
<pre><nowiki><datatable>https://spreadsheets.google.com/tq?tqx=out:csv&tq=SELECT%20B%2CC%2CD%2CE%2CF%2CG%2CH%2CI%2CJ%2CK%2CL%2CM%2CN%2CO%2CP%2CQ%2CR%2CS%2CT%2CU%2CV%20WHERE%20AA%20%3D%201%20ORDER%20BY%20X%20ASC&key=1GH0-ndSbVI2gAbzNrOjJxtyNwkOqoqyhwv9LTsFWWDM&gid=1386123040</datatable></nowiki></pre>
+
* '''Make User and Talk pages''' - this will let other editors see who you are and make you contactable if needed.
 +
* '''Use article Discussion pages''' - to co-ordinate edits on individual articles, editors are encouraged to leave any relevant notes and requests on the Discussion pages of articles, where they can be easily seen, discussed and marked as complete when appropriate.
 +
* '''Provide Edit summaries''' - this is so other editors can more easily track and verify recent edits.
 +
* '''Know your admins''' - also called ''sysops'' in MediaWiki parlance, these are a special class of user, able to delete, restore and protect pages, as well as block vandals. A list of current admins may be found [[Special:ListUsers/sysop|here]].
 +
* '''Use proper formatting in text/links''' - this makes the Wiki more readable for both users and editors. For guidance on this, see the Manual of Style.
 +
* '''Use categories''' - these are important for organising and grouping related articles together; every article should be a member of at least one category. Every category is also a member of at least one category, ultimately leading back to the master Wiki category. The category tree may be viewed [[Special:CategoryTree|here]].
 +
* '''Keep to encyclopedic style''' - a formal and dispassionate tone should be used throughout articles, but player-written guides can (and should!) be more conversational in tone. Both Wikipedia and the MediaWiki documentation have excellent guidance on this.
  
Please [https://forum.beyonddark.net/c/wiki let us know] if there is a particular data table you would like, or have a suggestion concerning any of the existing tables.
+
== Things you should not do ==
  
== Using categories ==
+
The following lists some basic things that you should not be adding or doing on the Outscape Wiki:
  
Categories are used to organize pages:
+
* '''Deliberately inserting false information.''' This will lead to a block.
 +
* '''Advertising third-party applications.''' Spam accounts which do this will be blocked, as above. Individual links to Twitch, Discord, etc. should be posted to the forums instead.
 +
* '''Adding fan theories or conjecture.''' Such content is generally not appropriate for Wiki entries, but may be posted over at the forum.
 +
* '''Leave "To-Do" notes/info requests on a page.''' These should not be left in the bodies of articles, as they disrupt the overall flow and are not easily visible to other editors, who may be able to action these points. Editors should instead use the Discussion pages of articles for this. Info requests may also be made at the Wiki section of the forum in order to reach more players.
 +
* '''Make multiple consecutive edits to a page'''. This spams the [[Special:RecentChanges|Recent changes]] page and makes it more difficult for editors to monitor changes, especially if they are minor and incremental. Wherever possible, aim to finish your work in one or two edits by making use of the "Show Preview" function. Be sure to mark changes as minor if they do not represent significant changes to content. Always mark changes to your own User and My Talk pages as minor.
  
* Each page should belong to at least one category.
+
== Vandalism ==
* Each category should itself belong to at least one other category, except for the top-most [[:Category:Wiki|Wiki]] category.
 
  
Pages and subcategories can be added to a category by adding the following syntax to its content:
+
As Outscape remains in Alpha testing with a small potential editor base, vandalism is highly unlikely.  Any concerns over malicious editing should be brought to the attention of the wiki admins via private message.
  
<pre><nowiki>[[Category:Mankind Hulls]]</nowiki></pre>
+
== Further Reading ==
  
To add content to multiple categories, use additional tags:
+
Editors can read up on wiki etiquette here: [[Wikipedia:Wiki etiquette]]. In short, be polite and civil to other editors, and they will do the same.
  
<pre><nowiki>[[Category:Mankind Hulls]]
+
Beyond this, Wikipedia contains lots of information for the interested editor. Some of the more useful and relevant links:
[[Category:Mankind]]</nowiki></pre>
 
  
See the [[#Links|links section above]] to find out how to link to a category.
+
* [[Wikipedia:Wikipedia:How to edit a page|How to edit a page]]
 +
* [[Wikipedia:Wikipedia:When to use tables|When to use tables]]
 +
* [[Wikipedia:Help:Table|Table Help]]
 +
* [[Wikipedia:Wikipedia:Categorization|Categorization Help]]
  
 
[[Category:Contributing]]
 
[[Category:Contributing]]

Latest revision as of 19:24, 30 September 2019

Thinking about helping out with the wiki? This page will get you up to speed and explain how and where to get started. Editors are also encouraged to look through the wiki's Manual of Style for editing tips and page formatting.

Your help needed

This community wiki is for Outscape players and we need your help to improve it. Your contributions are not only valued, but enable us to focus more time on developing new features and making the best game possible!

While members of the Outscape development team participate in maintaining this wiki, it is a community wiki, and we encourage players to get involved however they can. Contributing could be a sentence or two clarifying how something in the game works, amending stats, fixing grammar on a page, uploading an image, a new page about strategies, a gameplay guide – it's up to you.

We'd also love it if players would create some really compelling new player guides, with mini missions such as destroying a pirate fleet or colonizing a second homeworld. We know early game is slow and we are working on that, but often new players don't realize there is actually a lot to do which they are overlooking. We'd be happy to see multiple starter guides in the wiki e.g. "Tim's Syntis Newbie guide".

Overall, don't be afraid to add new content. The biggest problem right now is lack of content!

How to help

Before pages can be edited, new editors must create and verify a Wiki account. An editor's Wiki account is not connected to their forum or game accounts. For ease of communication, new editors are requested to use the same user handles as they do on the forum and in-game, to help people easily find each other.

  • Take a look at the pages under the following categories:
    • Wanted Pages: pages listed here are linked to by other pages, but don't exist yet and so need to be created.
    • Need starting: pages in this category will be empty (possibly with a data table/image only) and in need of at least some basic details added.
    • Need expanding: content in this category needs expanding e.g. more points covered, a data table adding, images.
    • Need updating: content that could now be outdated or has room for improvement.
    • Need verifying: content in this category needs to be verified for accuracy/quality and moved to Need updating if necessary.
    • Need images: pages in this category could benefit from one or more new images, or updated versions of existing images.
  • Validate recent wiki activity (click the diff/hist to see what changed)
  • Improve existing pages.
  • Correct grammar mistakes and inaccurate content.

Basic Editing Tips

The basic editing tips are meant for the casual editor who plans on adding some information to the Outscape Wiki. Following these guidelines will ensure that your contribution will require little or no follow up edits.

  1. Before editing, check that your information is factual. Theories and unverified information should never be on the wiki and are best discussed on the forums.
  2. You can start editing an article by clicking on the edit link in each section, or by clicking on the Actions --> Edit tab on the top-right of the page. Whenever possible, choose to edit a small section of a page instead of the full page. This is useful when working on long pages. If a page requires edits in multiple sections, edit each section individually.
  3. After finishing the edit, do not click save yet. First, make sure you check your edit visually using the "Show Preview" button. Check spelling, grammar, formatting, and links to assure they are correct and working.
  4. If you are lost in your own edit, you can click on the "Show Changes" button to see the work you have done.
  5. Make sure to include an Edit Summary of the work you have done. It is the textbox located above the buttons. This will provide other editors with info on the work done, and helps keep the page history organized.
  6. Tick the minor edit box if the information you have added is trivial, or edits involve minor issues such as grammar, spelling, existing link fixes, etc.
  7. Only after going through the steps 3 to 6, should you then proceed with a save.


Interested editors should read the Manual of Style for more information.

Additional Tips

  • Checking the recent page history for past edits is usually a good idea. If the last edit introduced too many errors or will be difficult to correct, then it is easier to perform an "Undo" instead and start a fresh edit.
  • When performing an undo, make sure to include the reason for the reversion in the edit edit summary.

Discussing this wiki

Discussion and Talk Pages

Individual articles have Discussion pages, which can be used to discuss or leave notes for individual pages. Similarly, Wiki users have Talk pages, which can be used for editors to leave messages for one another.

Some additional guidelines for edits to User and User:Talk pages:

  • Avoid editing another User's page - this is considered very poor etiquette. Most users prefer that it is left for their own work, such as an introduction or list of things they are working on.
  • When making a new comment on a User:Talk page, make sure to use a section tag using "== A Section Tag ==" by adding 2 equal characters at the front and back of the section header.
  • If you are giving a reply, don't forget to indent it accordingly, as shown in the example below. This is done by adding a ':' colon mark for each level of indent.
Indentation
Example
Here
  • Lastly, don't forget to sign your comments. This can be done easily by adding four tildes (~~~~) at the end of the comment.

Outscape Forum

The Outscape forum has an area for discussing this wiki. Please post there if you need help with anything, have any suggestions for this wiki, or wish to discuss something with fellow wiki contributors.

Things you should definitely do

To make the Wiki the best it can be, editors are encouraged to follow these pointers:

  • Make User and Talk pages - this will let other editors see who you are and make you contactable if needed.
  • Use article Discussion pages - to co-ordinate edits on individual articles, editors are encouraged to leave any relevant notes and requests on the Discussion pages of articles, where they can be easily seen, discussed and marked as complete when appropriate.
  • Provide Edit summaries - this is so other editors can more easily track and verify recent edits.
  • Know your admins - also called sysops in MediaWiki parlance, these are a special class of user, able to delete, restore and protect pages, as well as block vandals. A list of current admins may be found here.
  • Use proper formatting in text/links - this makes the Wiki more readable for both users and editors. For guidance on this, see the Manual of Style.
  • Use categories - these are important for organising and grouping related articles together; every article should be a member of at least one category. Every category is also a member of at least one category, ultimately leading back to the master Wiki category. The category tree may be viewed here.
  • Keep to encyclopedic style - a formal and dispassionate tone should be used throughout articles, but player-written guides can (and should!) be more conversational in tone. Both Wikipedia and the MediaWiki documentation have excellent guidance on this.

Things you should not do

The following lists some basic things that you should not be adding or doing on the Outscape Wiki:

  • Deliberately inserting false information. This will lead to a block.
  • Advertising third-party applications. Spam accounts which do this will be blocked, as above. Individual links to Twitch, Discord, etc. should be posted to the forums instead.
  • Adding fan theories or conjecture. Such content is generally not appropriate for Wiki entries, but may be posted over at the forum.
  • Leave "To-Do" notes/info requests on a page. These should not be left in the bodies of articles, as they disrupt the overall flow and are not easily visible to other editors, who may be able to action these points. Editors should instead use the Discussion pages of articles for this. Info requests may also be made at the Wiki section of the forum in order to reach more players.
  • Make multiple consecutive edits to a page. This spams the Recent changes page and makes it more difficult for editors to monitor changes, especially if they are minor and incremental. Wherever possible, aim to finish your work in one or two edits by making use of the "Show Preview" function. Be sure to mark changes as minor if they do not represent significant changes to content. Always mark changes to your own User and My Talk pages as minor.

Vandalism

As Outscape remains in Alpha testing with a small potential editor base, vandalism is highly unlikely. Any concerns over malicious editing should be brought to the attention of the wiki admins via private message.

Further Reading

Editors can read up on wiki etiquette here: Wikipedia:Wiki etiquette. In short, be polite and civil to other editors, and they will do the same.

Beyond this, Wikipedia contains lots of information for the interested editor. Some of the more useful and relevant links: