38
edits
(→Versioning: updated template types, grammar) |
m (Removed obstacle argument provided to Equipment/Recommended template) |
||
(20 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
If you want to help with the wiki, join our [https://discord.gg/ | {{V}} | ||
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 == | == What to do == | ||
Line 10: | Line 7: | ||
{{:Contributing/To-Do List}} | {{:Contributing/To-Do List}} | ||
== What not to do == | == 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 | 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}}. | ||
Generated content currently includes: | Generated content currently includes: | ||
Line 23: | Line 20: | ||
* 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: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:Pet|Pet Template]] on [[:Category:Pets|Pet]] pages | ||
* The [[Template:Upgrade|Shop Upgrade Template]] on [[:Category:Upgrades|Upgrade]] pages | * The [[Template:Upgrade|Shop Upgrade Template]] on [[:Category:Upgrades|Upgrade]] pages | ||
* All [[:Category:Tables|Table Templates]] | * 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 | 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. | ||
== Templates == | == 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. | 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. | ||
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. | |||
An example of this would be <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 === | === 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| | 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 | * 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 | * 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. | 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. | You can view the versioning system in action on the top right corner of this page. | ||
=== | === Referencing other pages === | ||
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. | {{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 made 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|Icon|Princess|type=thieving}} | |||
| {{Icon|Princess|type=thieving}} | |||
|- | |||
| {{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> | |||
|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> | |||
|legs1 = Glacia God Platelegs</nowiki><br /><nowiki> | |||
|familiar11 = Ent</nowiki><br /><nowiki> | |||
|familiar21 = Wolf</nowiki><br /><nowiki> | |||
|familiar22 = Leprechaun</nowiki><br /><nowiki> | |||
}}</nowiki></code> | |||
| {{Equipment/Recommended | |||
|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 | |||
|legs1 = Glacia God Platelegs | |||
|familiar11 = Ent | |||
|familiar21 = Wolf | |||
|familiar22 = Leprechaun | |||
}} | |||
|} | |||
== Tables with Sticky Headers == | == Tables with Sticky Headers == | ||
Line 86: | Line 220: | ||
|} | |} | ||
</pre> | </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 | |||
|- | |||
| <code><nowiki>[[Contributing]]</nowiki></code> | |||
| Links to another page on the wiki | |||
|- | |||
| <code><nowiki>[[Contributing|Want to help write the wiki?]]</nowiki></code> | |||
| [[Contributing|Want to help write the wiki?]] | |||
|} | |||
{{Menu}} | {{Menu}} |
edits