Melvor Idle:Contributing: Difference between revisions

From Melvor Idle
(→‎Icons: Refer to Template:Icon for comprehensive documentation)
(→‎Getting started: Add number of pages in each category)
 
(28 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{V}}
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/MelvorIdle Discord] and direct message one of the Wiki Admins for an account.


== What to do ==
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!
{{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" 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 {{DiscordLink}}. 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 '''[[Special:CreateAccount|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 Idle:Style Guide|style guide]] that lists the do's and don'ts
* 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 Idle: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 Idle:Tasks|tasks]] to pick and choose from.
* The [[Template:Pet|Pet Template]] on [[:Category:Pets|Pet]] pages
* [[Melvor Idle: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're unsure of anything, feel free to ask for [[Melvor Idle:User_Help|help]]!'''


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:
* 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.


== Templates ==
===What to do===
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.
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.
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.


Templates furthermore support numeric arguments, referenced in the templates by <code><nowiki>{{{1}}}</nowiki></code>, but also named arguments.
===What not to do===
An example of this would be <code><nowiki>{{{text}}}</nowiki></code> for <code><nowiki>{{ItemIcon|Mole|text=A summon}}</nowiki></code>.
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.
 
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.
 
=== Referencing other pages ===
{{Main|Reference=Contributing}}
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.
 
Usage: <code><nowiki>{{Main|Reference=Contributing}}</nowiki></code>
 
{{HasGuide|page=Contributing}}
If there is a guide for a page you're working on somewhere else, you should probably refer to it using the [[Template:HasGuide|Guide Template]]. This adds a formatted link to the guide on the page.
 
Usage: <code><nowiki>{{HasGuide|page=Contributing}}</nowiki></code>
 
{{HasMMG|page=Contributing}}
If you've maken a moneymaking guide, consider adding a reference to it on its main page with the [[Template:HasMMG|Moneymaking guide template]]. The template adds a formatted link to the guide.
 
Usage: <code><nowiki>{{HasMMG|page=Contributing}}</nowiki></code>
 
=== Icons ===
There are a number of icon templates which allow contributors to easily add icon formatting to links and inline with text, some examples are provided below.
 
For a comprehensive list of all icon templates and documentation of parameters these functions use, see [[Template:Icon]].
{| 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|Icon|type=aurora|Fury III}}
| {{Icon|type=aurora|Fury 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|GP|1000.25}}
| {{GP|1000.25}}
|-
| {{T|SC|1337}}
| {{SC|1337}}
|-
| {{T|RC|42069}}
| {{RC|42069}}
|}
 
=== 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}}
|-
| <code><nowiki>{{Obstacles/Recommended</nowiki><br /><nowiki>
|obs11 = Rope Climb</nowiki><br /><nowiki>
|obs31 = Pit Jump</nowiki><br /><nowiki>
|obs41 = Coal Stones</nowiki><br /><nowiki>
|obs51 = Rooftop Run</nowiki><br /><nowiki>
|obs52 = Tree Climb</nowiki><br /><nowiki>
}}</nowiki></code>
| {{Obstacles/Recommended
|obs11 = Rope Climb
|obs31 = Pit Jump
|obs41 = Coal Stones
|obs51 = Rooftop Run
|obs52 = Tree Climb
}}
|-
| <code><nowiki>{{Equipment/Recommended</nowiki><br /><nowiki>
|obs11 = Rope Climb</nowiki><br /><nowiki>
|helm1 = Glacia God Helmet</nowiki><br /><nowiki>
|helm2 = Ancient Wizard Hat</nowiki><br /><nowiki>
|neck1 = Fury of the Elemental Zodiacs</nowiki><br /><nowiki>
|neck2 = Elite Amulet of Magic</nowiki><br /><nowiki>
|cape1 = Skull Cape</nowiki><br /><nowiki>
|body1 = Glacia God Platebody</nowiki><br /><nowiki>
|legs# = Glacia God Platelegs</nowiki><br /><nowiki>
|familiar11 = Ent</nowiki><br /><nowiki>
|familiar21 = Wolf</nowiki><br /><nowiki>
|familiar22 = Leprechaun</nowiki><br /><nowiki>
}}</code></nowiki>
| {{Equipment/Recommended
|obs11 = Rope Climb
|helm1 = Glacia God Helmet
|helm2 = Ancient Wizard Hat
|neck1 = Fury of the Elemental Zodiacs
|neck2 = Elite Amulet of Magic
|cape1 = Skull Cape
|body1 = Glacia God Platebody
|legs# = Glacia God Platelegs
|familiar11 = Ent
|familiar21 = Wolf
|familiar22 = Leprechaun
}}
|}
 
== 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
|}




{{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.


Melvor Idle version v1.3.1 (Released: 30th October 2024)
Error creating thumbnail: File missing
Combat:
Error creating thumbnail: File missing
Attack •
Error creating thumbnail: File missing
Strength •
Error creating thumbnail: File missing
Defence •
Error creating thumbnail: File missing
Hitpoints •
Error creating thumbnail: File missing
Ranged •
Error creating thumbnail: File missing
Magic •
Error creating thumbnail: File missing
Prayer •
Error creating thumbnail: File missing
Slayer •
Error creating thumbnail: File missing
Corruption
Skills:
Error creating thumbnail: File missing
Farming •
Error creating thumbnail: File missing
Township •
Error creating thumbnail: File missing
Woodcutting •
Error creating thumbnail: File missing
Fishing •
Error creating thumbnail: File missing
Firemaking •
Error creating thumbnail: File missing
Cooking •
Error creating thumbnail: File missing
Mining •
Error creating thumbnail: File missing
Smithing •
Error creating thumbnail: File missing
Thieving •
Error creating thumbnail: File missing
Fletching •
Error creating thumbnail: File missing
Crafting •
Error creating thumbnail: File missing
Runecrafting •
Error creating thumbnail: File missing
Herblore •
Error creating thumbnail: File missing
Agility •
Error creating thumbnail: File missing
Summoning •
Error creating thumbnail: File missing
Astrology •
Error creating thumbnail: File missing
Alternative Magic •
Error creating thumbnail: File missing
Cartography •
Error creating thumbnail: File missing
Archaeology •
Error creating thumbnail: File missing
Harvesting
Other:
Error creating thumbnail: File missing
Beginners Guide • Guides •
Error creating thumbnail: File missing
Bank •
Error creating thumbnail: File missing
Combat •
Error creating thumbnail: File missing
Mastery •
Error creating thumbnail: File missing
Money Making •
Error creating thumbnail: File missing
Shop • Easter Eggs • Pets •
Error creating thumbnail: File missing
Golbin Raid •
Error creating thumbnail: File missing
Full Version • Throne of the Herald • Atlas of Discovery •
Error creating thumbnail: File missing
Into the Abyss
Reference Tables: Items, Equipment, Experience Table, Upgrading Items, Combat Areas, Slayer Areas, Dungeons, Strongholds, The Abyss, Monsters
Retrieved from "https://testwiki.melvoridle.com/index.php?title=Melvor_Idle:Contributing&oldid=77121"