Melvor Idle:Contributing

From Melvor Idle
Revision as of 00:34, 14 March 2021 by Falterfire (talk | contribs) (I don't think this page needs a version)

If you want to help with the wiki, join our Discord and message Malcs (aka MrFrux)#6454 or Falterfire#7778 for an account.

Bot

We're working on a bot which will fill out the wiki automatically from the game's code. Its next version will generate improved item sources sections for item pages.

What to do

If you want to help but don't know what you can do, here are a couple of things you can do: Contributing/To-Do List

What not to do

As a result of the bot generating much of the content on the wiki from the game's source code, please do not manually edit the content generated by it. This will disrupt the automatic version flagging when new versions of the game are released, and can potentially decrease the overall accuracy of information on the wiki and style consistency.

If you wish to add information on pages with generated content, please edit the text above the placement of the template. For example, Crown of Rhaelyx.

Generated content currently includes:

If you do find an issue with the accuracy of information in any of these templates, it is possible that the internal game data is flawed, or there has been a recent hotfix (hidden update without a version number change) to the game code and the bot needs to run an update to the pages.

Templates

We use a number of templates on the wiki for various purposes. Such as the {{Menu}} template for the menu at the bottom of the page.

Versioning

We have created a system of templates to mark which pages are up to date. At the top of every page there should be a template for which version the page is written. This will look like either {{V}}, {{V0.18.0}} or {{V|0.18.0}}.

  • If a page is entirely populated by either the bot or Lua powered templates then simply add {{V}} to the top of the page.
  • If a page contains a decent amount of user-written text that has the potential to change with each version, then the version number should be specified. For example, if a page is written for version 0.18.0 you would add {{V|0.18.0}} to the top of the page.

Each page should have a version attached to it. Every version can be found in the Versions Category. One of the main tasks is to make sure that pages are up to date.

You can view the versioning system in action on the top right corner of this page.

Main article

If you have a bit of text in a page but have more text explaining that concept on another page, it might be a good idea to use the Main Template. This template adds a formatted link to the main article to the page. It can be seen in action on the Beginners Guide.

Tables with Sticky Headers

Some of the tables on the wiki have headers which are "sticky", that is they will remain at the top of a table as the user scrolls down. See Equipment for an example of this. In order to implement this on your tables first add the class "stickyHeader" to the start of the table. E.g:

{| class="wikitable sortable"

would become:

{| class="wikitable sortable stickyHeader"

Before you start your first row of headers you then add |- class="headerRow-0" before it.

If you have a second row of headers you must add |- class="headerRow-1" before it.

As an example:

Can be generated with the following wikitext

{| class="wikitable sortable stickyHeader"
|- class="headerRow-0"
! First Column 1
! Second Column 1
! Third Column 1
|- class="headerRow-1"
! First Column 2
! Second Column 2
! Third Column 2
|-
| 1
| 2
| 3
|}