Revision as of 17:59, 14 November 2018

Community Portal

Welcome to Isleward Wiki. This page documents recommended practices to edit the wiki as well as tasks that need to be done.

Bots

Use {{bots}} to indicate to bots (probably only the one operated by notme) to edit, and use {{nobots}} to disable bots, like on this page.

Template:Nobots

Editing the Wiki

To make changes to the wiki, you must request a wiki account. Please contact moderators on the #wiki channel on Discord about details to create an account.

Note that your wiki account is not related to your in-game account in any ways.

See MediaWiki Formatting Help for the syntax used by Isleward Wiki.

Guidelines

Player Guides: The wiki should provide facts about Isleward that are verifiable by others. Guides based on player experience should be marked with {{{OB}}} (opinion-based) so they are distinguished from other information. Guides that are specific to an article (e.g. how to defeat a boss) should have its own section in the page, while guides that are pages on their own should be in Category:Guides.
Game Version: Each page should be tagged with the predefined template {{Version0110}} (for v0.1.10), {{Version019}} (for v0.1.9), etc to indicate the game version the content refers to. This makes it clear for readers to know if they are reading up-to-date information. The version template should go below the header of the page and before the main content starts. For contents with undetermined version, use {{VersionUnknown}}, and use {{Unreleased}} for unreleased contents.
Stubs and Work-in-progress: Add the template {{stub}} at the end of a page if it only contains a few sentences and needs to be expanded. Use {{wip}} if the page is actively being worked on, meaning you are going to finish it soon. If you are no longer working on a page but it is incomplete, mark it with stub instead.
Article Structure: If possible, adhere to the following structure for a page on the wiki:

= Title =
{{VersionXXX}}
{{Blockquote|In-game description}}
{{Item/Monster Templates}}
A brief description of the subject.

== Subsection 1 ==
The detailed description on a particular aspect of the subject.

== Subsection 2 ==
...

== Subsection N ==
...

== Guides ==
{{OB}}
Add how-to, tutorials, tips and tricks here.

== History ==
A list of changes to the subject in previous game revisions.

== See Also ==
Links to related articles.

{{stub}} or {{wip}}
[[Category:XXX]]

Categories: Add pages to appropriate categories whenever applicable. Category names should be plural, and a redirect should be made from the non-categorized page, e.g. Consumable → Category:Consumables. The category page itself should be added to Category:Compendium.
Images: Sprites should have transparent backgrounds, and preferably extracted from game assets rather than taken from screenshots.; Use [[File:Missing.png]] as placeholders for missing images.

Formatting & Styling

Insert spaces between the header title text: use = This = rather than =That=.
Tables should use class="wikitable". Insert spaces around cell contents so it is easier to read.
Use proper punctuation.
When referencing keys or in-game text, wrap it with <code></code>. For example: press I to open the inventory; then right click on an item and select drop.
Abbreviations should be fully spelled out in the first occurrence in an article with a link to the subject.
Use {{issue|number}} to create links to Isleward's GitLab issue.

Extensions

This wiki has two extensions.

Templates

Templates that need documentation: item, rune

{{collapse|content|channel}} will create a [Toggle] button that, when clicked, hides or reveals the content of the collapsible section. content is the wiki content that should appear after clicking [Toggle], and channel is an ID of sorts (for example, 1, 2, or 3) that toggle together (if multiple toggles are on the same channel, they will collapse and reveal together).

{{monster}} will create a preformatted table (for example, the monster info table in the Crab page) with data on the monster. It uses named parameters to get the needed data. The parameters are monstername, filename, level, attack, mana, armor, drops, and location. If you put the monster tag at the beginning of the page it will also automatically make a header with the monster's name. All the fields are basically just text that gets copied into the table, but the only different one is the filename, defaulting to missing.png, that is displayed in the table with the proper image.

{{ReqBlockUserSpam}} Use for users that need to be blocked because of spam. Can also use Marked For Deletion

{{Marked For Deletion}} Mark a page for deletion. The item tag also needs documenting, but I'll get around to that later.

{{PTNTBD}} Deprecated, use Marked For Deletion instead. (Note: I'll run a script and switch these (if any) to MFD --Punknoodles (talk) 14:44, 17 April 2018 (UTC))

{{Version0110}} Should be used for pages that are up to date as of Version 0110.

{{Version019}} Should be used for pages that are up to date as of Version 019.

{{Version018}} Should be used for pages that are up to date as of Version 018.

{{Unreleased}} This template should be used for unimplemented content.

{{BadImage}} Used for images that are not taken directly from the game source (screenshots are bad, cut images from spritesheets instead).

Task Queues

Choose one and work on the pages in the category.

@@ Line 1: / Line 1: @@
-{{ DO NOT REMOVE - Community Portal Header }}
+__NOTOC__
+= Community Portal =
+Welcome to Isleward Wiki. This page documents recommended practices to edit the wiki as well as tasks that need to be done.
-! If anyone has some time, could they document the item tag?
+= Bots =
+Use <code><nowiki>{{bots}}</nowiki></code> to indicate to bots (probably only the one operated by notme) to edit, and use <code><nowiki>{{nobots}}</nowiki></code> to disable bots, like on this page.
-== Task Queues ==
+{{nobots}}
-* [[Special:WhatLinksHere/File:Missing.png|Pages Missing Images]]
-* [[Special:RecentChanges|Recent Changes]]
+== Editing the Wiki ==
-* [[Special:NewPages|New Pages]]
+To make changes to the wiki, you must request a wiki account. Please contact moderators on the <code>#wiki</code> channel on [https://discord.gg/gnsn7ZP Discord] about details to create an account.
-* [[Special:NewFiles|New Files]]
-* [[Isleward_Wiki:Sandbox|Sandbox]]
+Note that your wiki account is not related to your in-game account in any ways.
-* [[:Category:Work In Progress]]
-* [[:Category:Stubs]]
+See [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki Formatting Help] for the syntax used by Isleward Wiki.
+== Guidelines ==
+; Player Guides
+: The wiki should provide facts about Isleward that are verifiable by others. Guides based on player experience should be marked with <code><nowiki>{{{OB}}}</nowiki></code> (opinion-based) so they are distinguished from other information. Guides that are specific to an article (e.g. how to defeat a boss) should have its own section in the page, while guides that are pages on their own should be in [[:Category:Guides]].
+; Game Version
+: Each page should be tagged with the predefined template <code><nowiki>{{Version0110}}</nowiki></code> (for v0.1.10), <code><nowiki>{{Version019}}</nowiki></code> (for v0.1.9), etc to indicate the game version the content refers to. This makes it clear for readers to know if they are reading up-to-date information. The version template should go below the header of the page and before the main content starts. For contents with undetermined version, use <code><nowiki>{{VersionUnknown}}</nowiki></code>, and use <code><nowiki>{{Unreleased}}</nowiki></code> for unreleased contents.
+; Stubs and Work-in-progress
+: Add the template <code><nowiki>{{stub}}</nowiki></code> at the end of a page if it only contains a few sentences and needs to be expanded. Use <code><nowiki>{{wip}}</nowiki></code> if the page is actively being worked on, meaning you are going to finish it soon. If you are no longer working on a page but it is incomplete, mark it with stub instead.
+; Article Structure
+: If possible, adhere to the following structure for a page on the wiki:
+<pre>
+= Title =
+{{VersionXXX}}
+{{Blockquote|In-game description}}
+{{Item/Monster Templates}}
+A brief description of the subject.
+== Subsection 1 ==
+The detailed description on a particular aspect of the subject.
+== Subsection 2 ==
+...
+== Subsection N ==
+...
+== Guides ==
+{{OB}}
+Add how-to, tutorials, tips and tricks here.
+== History ==
+A list of changes to the subject in previous game revisions.
+== See Also ==
+Links to related articles.
+{{stub}} or {{wip}}
+[[Category:XXX]]
+</pre>
+; Categories
+: Add pages to appropriate [[Special:Categories|categories]] whenever applicable. Category names should be plural, and a redirect should be made from the non-categorized page, e.g. [[Consumable]] → [[:Category:Consumables]]. The category page itself should be added to [[:Category:Compendium]].
+; Images
+: Sprites should have transparent backgrounds, and preferably extracted from game assets rather than taken from screenshots.
+: Use <code><nowiki>[[File:Missing.png]]</nowiki></code> as placeholders for missing images.
+== Formatting & Styling ==
+* Insert spaces between the header title text: use <code><nowiki>= This =</nowiki></code> rather than <code><nowiki>=That=</nowiki></code>.
+* Tables should use <code><nowiki>class="wikitable"</nowiki></code>. Insert spaces around cell contents so it is easier to read.
+* Use proper punctuation.
+* When referencing keys or in-game text, wrap it with <code><nowiki><code></code></nowiki></code>. For example: press <code>I</code> to open the inventory; then right click on an item and select <code>drop</code>.
+* Abbreviations should be fully spelled out in the first occurrence in an article with a link to the subject.
+* Use <code><nowiki>{{issue|number}}</nowiki></code> to create links to Isleward's GitLab issue.
+== Extensions ==
+This wiki has two extensions.
+* [https://www.mediawiki.org/wiki/Extension:Nuke Nuke]
+* [https://www.mediawiki.org/wiki/Extension:Moderation Moderation]
 == Templates ==
-<nowiki>{{wip}}</nowiki> will tag that page as a Work-In-Progress and a stub. Use WIP if you plan on working on the page more. If the page is incomplete but you have no plans to continue it, tag it as below.
+'''Templates that need documentation: item, rune'''
-<nowiki>{{stub}}</nowiki> will tag that page as a stub. This means that the page is short or lacking information, but unlike WIP it means no one is currently planning on improving it.
+<nowiki>{{collapse|content|channel}}</nowiki> will create a [Toggle] button that, when clicked, hides or reveals the <code>content</code> of the collapsible section. <code>content</code> is the wiki content that should appear after clicking [Toggle], and <code>channel</code> is an ID of sorts (for example, <code>1</code>, <code>2</code>, or <code>3</code>) that toggle together (if multiple toggles are on the same channel, they will collapse and reveal together).
 <nowiki>{{monster}}</nowiki> will create a preformatted table (for example, the monster info table in the [[Crab]] page) with data on the monster. It uses named parameters to get the needed data. The parameters are <code>monstername</code>, <code>filename</code>, <code>level</code>, <code>attack</code>, <code>mana</code>, <code>armor</code>, <code>drops</code>, and <code>location</code>. If you put the monster tag at the beginning of the page it will also automatically make a header with the monster's name. All the fields are basically just text that gets copied into the table, but the only different one is the <code>filename</code>, defaulting to <code>missing.png</code>, that is displayed in the table with the proper image.
+<nowiki>{{ReqBlockUserSpam}}</nowiki> Use for users that need to be blocked because of spam. Can also use Marked For Deletion
+<nowiki>{{Marked For Deletion}}</nowiki> Mark a page for deletion.
 The item tag also needs documenting, but I'll get around to that later.
+<nowiki>{{PTNTBD}}</nowiki> Deprecated, use Marked For Deletion instead. (Note: I'll run a script and switch these (if any) to MFD --[[User:Punknoodles|Punknoodles]] ([[User talk:Punknoodles|talk]]) 14:44, 17 April 2018 (UTC))
+<nowiki>{{Version0110}}</nowiki> Should be used for pages that are up to date as of Version 0110.
+<nowiki>{{Version019}}</nowiki> Should be used for pages that are up to date as of Version 019.
+<nowiki>{{Version018}}</nowiki> Should be used for pages that are up to date as of Version 018.
+<nowiki>{{Unreleased}}</nowiki> This template should be used for unimplemented content.
+<nowiki>{{BadImage}}</nowiki> Used for images that are not taken directly from the game source (screenshots are bad, cut images from spritesheets instead).
+== Task Queues ==
+Choose one and work on the pages in the category.
+* [[Special:WhatLinksHere/File:Missing.png|Pages Missing Images]]
+* [[Special:LonelyPages|Orphaned Pages]]
+* [[:Category:Dead End]]
+* [[:Category:Pages that need to be deleted]]
+* [[:Category:Work In Progress]]
+* [[:Category:Stubs]]
+* [[:Category:Spam]]
+== Helpful Links ==
+* [[Special:RecentChanges|Recent Changes]]
+* [[Special:NewPages|New Pages]]
+* [[Special:NewFiles|New Files]]
+* [[Isleward_Wiki:Sandbox|Sandbox]]
+* [[:Category:Blocked users|Blocked users/bots]]

Difference between revisions of "Isleward Wiki:Community Portal"