Melvor Idle:Contributing: Difference between revisions

From Melvor Idle
m (formatting fix)
(→‎Getting started: Add number of pages in each category)
 
(45 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{V|0.18.2}}
This wiki is entirely built by the community and anyone is able to edit. Editing the Wiki requires an account. If you wish to assist us, please take the time to register to enable editing.


If you want to help with the wiki, join our [https://discord.gg/KNakXTh Discord] and message Malcs (aka MrFrux)#6454 for an account.
If you want to discuss anything regarding the wiki, join our {{DiscordLink}} and head to the '''#wiki-discussion''' channel. Or head to the [[Melvor Idle:User Help|User Help]] page and ask away!


== Bot ==
===New to wiki editing?===
{{Main|Reference=Bot}}
* '''Be bold!''' If you see something that needs improvement, don't be afraid to edit it. Wikis are built off of changes made by readers like yourself. If you see something you think could be improved, '''improve it!''' Just click the "Edit" button at the top of any page to edit its contents. You can also start editing from a specific subheading (ie. [[Fishing#Fishing Areas]]) by using the "Edit" buttons there.
We're working on a [[Bot|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.
* '''Get in touch with the community!''' Join the {{DiscordLink}}. You can get help specifically for this wiki in the '''#wiki-discussion''' channel.


== What to do ==
===How do I start?===
{{Main|Reference=Contributing/To-Do List}}
* You will need to '''[[Special:CreateAccount|create an account]]''' before you're able to edit pages.
If you want to help but don't know what you can do, here are a couple of things you can do:
* '''Don't be afraid to edit!''' If you make a mistake, you or someone else can easily fix it – so take the initiative and make a change if you think it's useful.
{{:Contributing/To-Do List}}
** Tip: ''when editing, you can also use the "Show preview" button to check how the page will look before you save it!''
== What not to do ==
* '''Create an article!''' If you don't find what you're looking for, remember that the Melvor Wiki is made up of articles contributed by its users, it might just be that no one has written about that topic yet.
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, {{ItemIcon|Crown of Rhaelyx|ext=png}}.
===Resources===
<!--Rules and Style guide... We need some!-->
* The [[Melvor Idle:Style Guide|style guide]] that lists the do's and don'ts
* The [[Special:RecentChanges|recent changes]] page shows a feed of recent edits to the wiki.
* See a list of larger-scale [[Melvor Idle:Projects|community projects]] to work on.
* An active list of [[Melvor Idle:Tasks|tasks]] to pick and choose from.
* [[Melvor Idle:How to edit|How to edit]] contains information about how this wiki is edited.
* [[mw:Help:Contents|MediaWiki help pages]] contain comprehensive information about wiki formatting.
* '''If you're unsure of anything, feel free to ask for [[Melvor Idle:User_Help|help]]!'''


Generated content currently includes:
===Getting started===
There are several categories for articles needing some type of improvement:
* Pages with information that require a [[:Category:Needs_Source|source]] ({{PAGESINCAT:Needs Source}}) or need [[:Category:Incomplete_Articles|more information]] ({{PAGESINCAT:Incomplete Articles}}) to be added.
* Pages that need a [[:Category:Outdated user content pages|version check and updating]] ({{PAGESINCAT:Outdated user content pages}}), or require [[:Category:Needs Image|one or more images]] ({{PAGESINCAT:Needs Image}}) to be added.
* Pages that need [[:Category:Stubs|expansion]] ({{PAGESINCAT:Stubs}}), [[:Category:Articles that need cleanup|cleanup]] ({{PAGESINCAT:Articles that need cleanup}}), or are a [[:Category:Articles_under_construction|work in progress]] ({{PAGESINCAT:Articles_under_construction}}).
* A full list of article-related maintenance categories can be found on the [[Melvor Idle:Maintenance|Maintenance]] page.


* The [[Template:Item|Item Template]], [[Template:ArmourStats|Armour Stats Template]], and [[Template:WeaponStats|Weapon Stats Template]] on [[:Category:Items|Item]] pages
===What to do===
* The [[:Category:Item Sources|Item Source Templates]] generated for each item page
If you want to help but don't know what you can do, our [[Melvor Idle:Contributing/To-Do List|To-Do List]] has things you can do.
* The [[Template:Monster|Monster Template]] on [[:Category:Monsters|Monster]] pages
* The [[Template:Dungeon|Dungeon Template]], [[Template:SlayerArea|Slayer Area Template]], and [[Template:CombatArea|Combat Area Template]] on [[:Category:Dungeons|Dungeon]], [[:Category:Slayer Areas|Slayer Area]], and [[:Category:Combat Areas|Combat Area]] pages respectively
* The [[Template:Prayer|Prayer Template]] on [[:Category:Prayers|Prayer]] pages
* The [[Template:Spell|Spell Template]], [[Template:Aurora|Aurora Template]], [[Template:Curse|Curse Template]], [[Template:AncientMagick|Ancient Magick Template]], and [[Template:AltMagic|Alt. Magic Template]] on [[:Category:Spells|Spell]] pages
* The [[Template:Pet|Pet Template]] on [[:Category:Pets|Pet]] pages
* The [[Template:Upgrade|Shop Upgrade Template]] on [[:Category:Upgrades|Upgrade]] pages, with the exception of [[Shop#Miscellaneous|Misc. Upgrades]] which are maintained manually.
* All [[:Category:Tables|Table Templates]]


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.
===What not to do===
A lot of content on the Wiki is generated via Lua functions. Please be cautious around this, and see the [[Melvor Idle:Style Guide|style guide]] for more information.


== Templates ==
We use a number of templates on the wiki for various purposes. Such as the <nowiki>{{Menu}}</nowiki> 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 {{T|V}}, {{T|V0.18.0}} or {{T|V|0.18.0}}.
* If a page is entirely populated by either the [[Bot|bot]] or Lua powered templates then simply add {{T|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 {{T|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 [[:Category:Versions|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 [[Template:Main|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:
<code>{| class="wikitable sortable"</code>
would become:
<code>{| class="wikitable sortable stickyHeader"</code>
Before you start your first row of headers you then add <code>|- class="headerRow-0"</code> before it.
If you have a second row of headers you must add <code>|- class="headerRow-1"</code> before it.
As an example:
{| 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
|}
Can be generated with the following wikitext
<pre>{| 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
|}
</pre>


{{Menu}}
{{Menu}}

Latest revision as of 05:13, 6 July 2024

This wiki is entirely built by the community and anyone is able to edit. Editing the Wiki requires an account. If you wish to assist us, please take the time to register to enable editing.

If you want to discuss anything regarding the wiki, join our discord and head to the #wiki-discussion channel. Or head to the User Help page and ask away!

New to wiki editing?

  • Be bold! If you see something that needs improvement, don't be afraid to edit it. Wikis are built off of changes made by readers like yourself. If you see something you think could be improved, improve it! Just click the "Edit" button at the top of any page to edit its contents. You can also start editing from a specific subheading (ie. Fishing#Fishing Areas) by using the "Edit" buttons there.
  • Get in touch with the community! Join the discord. You can get help specifically for this wiki in the #wiki-discussion channel.

How do I start?

  • You will need to create an account before you're able to edit pages.
  • Don't be afraid to edit! If you make a mistake, you or someone else can easily fix it – so take the initiative and make a change if you think it's useful.
    • Tip: when editing, you can also use the "Show preview" button to check how the page will look before you save it!
  • Create an article! If you don't find what you're looking for, remember that the Melvor Wiki is made up of articles contributed by its users, it might just be that no one has written about that topic yet.

Resources

  • The style guide that lists the do's and don'ts
  • The recent changes page shows a feed of recent edits to the wiki.
  • See a list of larger-scale community projects to work on.
  • An active list of tasks to pick and choose from.
  • How to edit contains information about how this wiki is edited.
  • MediaWiki help pages contain comprehensive information about wiki formatting.
  • If you're unsure of anything, feel free to ask for help!

Getting started

There are several categories for articles needing some type of improvement:

What to do

If you want to help but don't know what you can do, our To-Do List has things you can do.

What not to do

A lot of content on the Wiki is generated via Lua functions. Please be cautious around this, and see the style guide for more information.