Contributing: Difference between revisions

From Melvor Idle
m (added template and module description)
mNo edit summary
 
(22 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{V}}
The Melvor Wiki is the official wiki of Melvor Idle, aimed at documenting every aspect of the game and aiding players in their quest through Melvor! This wiki is built by the community and '''anyone''' is able to edit. This page aims to give a brief introduction for people who want to edit the wiki, don't know how to help or need a guide on how to do stuff around the wiki.
If you want to help with the wiki, join our [https://discord.gg/MelvorIdle Discord] and direct message one of the Wiki Admins for an account.


== What to do ==
{{Main|Reference=Contributing/To-Do List}}
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 ==
A lot of the content on the Wiki is also generated via Lua functions. Please be cautious around this. If you notice a page generated by Lua, contact one of the Wiki Admins before editing the page.


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}}.
; 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" tab at the top of pages to edit their contents.
* '''Get in touch with the community!''' Join the [https://discord.gg/MelvorIdle Discord]. You can get help specifically for this wiki in the '''#wiki-discussion''' channel.


Generated content currently includes:
; How do I start?
* You will need to [{{fullurl:Special:Userlogin|type=signup}} 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.


* The [[Template:Item|Item Template]], [[Template:ArmourStats|Armour Stats Template]], and [[Template:WeaponStats|Weapon Stats Template]] on [[:Category:Items|Item]] pages
; Resources
* The [[:Category:Item Sources|Item Source Templates]] generated for each item page
<!--Rules and Style guide... We need some!-->
* The [[Template:Monster|Monster Template]] on [[:Category:Monsters|Monster]] pages
* The [[Melvor Wiki:Style Guide|style guide]] that lists the do's and don's
* 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 [[Special:RecentChanges|recent changes]] page shows a feed of recent edits to the wiki.
* The [[Template:Prayer|Prayer Template]] on [[:Category:Prayers|Prayer]] pages
* See a list of larger-scale [[Melvor Wiki:Projects|community projects]] to work on.
* 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
* An active list of [[Melvor Wiki:Tasks|tasks]] to pick and choose from.
* The [[Template:Pet|Pet Template]] on [[:Category:Pets|Pet]] pages
* [[Melvor Wiki:How to edit|How to edit]] contains information about how this wiki is edited.
* The [[Template:Upgrade|Shop Upgrade Template]] on [[:Category:Upgrades|Upgrade]] pages, with the exception of [[Shop#Miscellaneous|Misc. Upgrades]] which are maintained manually.
* [[mw:Help:Contents|MediaWiki help pages]] contain comprehensive information about wiki formatting.
* 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 [https://wiki.melvoridle.com/index.php?search=intitle%3A%2Fdata&title=Special:Search&profile=advanced&fulltext=0&ns828=1 Lua data modules] need to be updated.
; Getting started
 
There are several categories for articles needing some type of improvement:
== Templates ==
* Pages with information that require a [[:Category:Needs_Source|source]] or need [[:Category:Incomplete_Articles|more information]] to be added.
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.
* Pages that need a [[:Category:Outdated user content pages|version check and updating]], or require [[:Category:Needs Image|one or more images]] to be added.
To access the source page of a template, as for example the Menu template, simply go to the <code>Template:Menu</code> page. Because these pages are templates, they will automatically be imported when referred to, and therefore do not need the prior colon. Otherwise you'd need to prepend a colon to the page name <code><nowiki>{{:Menu}}</nowiki></code> to include its content.
* Pages that need [[:Category:Stubs|expansion]], [[:Category:Articles that need cleanup|cleanup]], or are a [[:Category:Articles_under_construction|work in progress]].
 
* A full list of article-related maintenance categories can be found [[Melvor Wiki:Maintenance|on this page]].
Templates furthermore support numeric arguments, referenced in the templates by <code><nowiki>{{{1}}}</nowiki></code>, but also named arguments, such as <code><nowiki>{{{text}}}</nowiki></code> for <code><nowiki>{{ItemIcon|Mole|text=A summon}}</nowiki></code>.
 
Some of the templates are simply wrappers for Lua modules, which will include <code><nowiki>{{#invoke:SomeModule|someFunction}}</nowiki></code>. To access the module source files, simply go to <code><nowiki>Module:SomeModule</nowiki></code>, and look for <code>someFunction</code> in there.
 
Also note that if an argument is optional, you can simply append a pipe symbol after its name (be it numeric or a named keyword argument) to default to the empty string.
 
=== 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 indicating for which version the page is written. This will look like either {{T|V}} or {{T|V|1.0}}.
* If a page is entirely populated by 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 1.0 you would add {{T|V|1.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]].
 
=== Icons ===
 
{| class=wikitable
|-
| {{T|Icon|Loot Container Stacking}}
| {{Icon|Loot Container Stacking}}
|-
| {{T|Icon|type=pet|Zarrah}}
| {{Icon|type=pet|Zarrah}}
|-
| {{T|PetIcon|Zarrah}}
| {{PetIcon|Zarrah}}
|-
| {{T|MonsterIcon|Necromancer}}
| {{MonsterIcon|Necromancer}}
|-
| {{T|ZoneIcon|Strange Cave}}
| {{ZoneIcon|Strange Cave}}
|-
| {{T|Skill|Mining|Rock extraction}}
| {{Skill|Mining|Rock extraction}}
|-
| {{T|PrayerIcon|Eagle Eye}}
| {{PrayerIcon|Eagle Eye}}
|-
| {{T|ItemIcon|Pig}}
| {{ItemIcon|Pig}}
|-
| {{T|Icon|type=spell|Wind Strike}}
| {{Icon|type=spell|Wind Strike}}
|-
| {{T|Icon|type=curse|Weakening III}}
| {{Icon|type=curse|Weakening III}}
|-
| {{T|UpgradeIcon|Golbin Crate|nolink=true}}
| {{UpgradeIcon|Golbin Crate|nolink=true}}
|-
| {{T|ItemIcon|Lucky Herb Potion}}
| {{ItemIcon|Lucky Herb Potion}}
|-
| Combat icon {{T|Icon|Melee|notext=true}}
| Combat icon {{Icon|Melee|notext=true}}
|-
| {{T|GoldPrice|price=100|text=units of currency}}
| {{GoldPrice|price=100|text=units of currency}}
|}
 
 
=== Tables ===
 
{| class=wikitable
|-
| {{T|AreaMonsters|Spider Forest}}
| {{AreaMonsters|Spider Forest}}
|-
| {{T|CombatTriangleAdjustmentTable}}
| {{CombatTriangleAdjustmentTable}}
|-
| {{T|EquipmentTableFromList|Aeris God Helmet,Aeris God Platebody,Aeris God Platelegs,Aeris God Boots,Aeris God Gloves}}
| {{EquipmentTableFromList|Aeris God Helmet,Aeris God Platebody,Aeris God Platelegs,Aeris God Boots,Aeris God Gloves}}
|}
 
== 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>
 
 
== Special wiki stuff ==
{| class=wikitable
|-
| <code><nowiki>#REDIRECT [[Currency]]</nowiki></code>
| A single line with this in a page, will redirect it to the given page
|-
| <code><nowiki>{{:Currency}}</nowiki></code>
| Includes the whole Currency page here
|-
| <code><nowiki><nowiki>something</nowiki></nowiki></code>
| Disables wiki formatting for the string inside
|-
| <code><nowiki><onlyinclude>Hello</onlyinclude></nowiki></code>
| When including the page, it will only display this text
|-
| <code><nowiki><includeonly>Hello</includeonly></nowiki></code>
| Will only include the text while transcluding it, not in the source page
|-
| <code><nowiki><noinclude>Hello</noinclude></nowiki></code>
| Removes this text when importing the page it as an include
|}


If you're unsure of anything, feel free to ask on the [https://discord.gg/MelvorIdle Discord]!


{{Menu}}
{{Menu}}

Latest revision as of 12:37, 14 June 2024

The Melvor Wiki is the official wiki of Melvor Idle, aimed at documenting every aspect of the game and aiding players in their quest through Melvor! This wiki is built by the community and anyone is able to edit. This page aims to give a brief introduction for people who want to edit the wiki, don't know how to help or need a guide on how to do stuff around the wiki.


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" tab at the top of pages to edit their contents.
  • 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
Getting started

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

If you're unsure of anything, feel free to ask on the Discord!


Melvor Idle version v1.3 (Released: 15th November 2023)
Combat:
Attack (skill).svg Attack
Strength (skill).svg Strength
Defence (skill).svg Defence
Hitpoints (skill).svg Hitpoints
Ranged (skill).svg Ranged
Magic (skill).svg Magic
Prayer (skill).svg Prayer
Slayer (skill).svg Slayer
Skills:
Woodcutting (skill).svg Woodcutting
Fishing (skill).svg Fishing
Firemaking (skill).svg Firemaking
Cooking (skill).svg Cooking
Mining (skill).svg Mining
Smithing (skill).svg Smithing
Thieving (skill).svg Thieving
Farming (skill).svg Farming
Fletching (skill).svg Fletching
Crafting (skill).svg Crafting
Runecrafting (skill).svg Runecrafting
Herblore (skill).svg Herblore
Agility (skill).svg Agility
Summoning (skill).svg Summoning
Astrology (skill).svg Astrology
Township (skill).svg Township
Cartography (skill).svg Cartography
Archaeology (skill).svg Archaeology
Alternative Magic (skill).svg Alternative Magic
Other:
Beginners Guide
Guides
Bank
Combat
Mastery
Money Making
Shop
Easter Eggs
Pets
Golbin Raid
Full Version
Throne of the Herald
Atlas of Discovery
Reference Tables: Items, Equipment, Experience Table, Upgrading Items, Combat Areas, Slayer Areas, Dungeons, Chest Loot Tables, Monsters, Monster Loot Tables
Retrieved from "https://wiki.melvoridle.com/index.php?title=Contributing&oldid=72185"