Difference between revisions of "Isleward Wiki:Community Portal"
(Add guidelines) |
|||
| Line 55: | Line 55: | ||
* 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>. | * 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. | * 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. |
== Templates == | == Templates == | ||
| + | {{wip}} | ||
| + | |||
<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>{{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). | ||
| Line 66: | Line 68: | ||
<nowiki>{{PTNTBD}}</nowiki> Stands for pages that need to be deleted. When using this this template make sure to a Reason. | <nowiki>{{PTNTBD}}</nowiki> Stands for pages that need to be deleted. When using this this template make sure to a Reason. | ||
The item tag also needs documenting, but I'll get around to that later. | The item tag also needs documenting, but I'll get around to that later. | ||
| − | |||
| − | |||
== Task Queues == | == Task Queues == | ||
Revision as of 04:48, 26 March 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.
Editing the Wiki
To make changes to the wiki, you must register an account. Note that this account is not related to your in-game account.
See MediaWiki Formatting Help for the syntax used by Isleward Wiki.
If you have any questions regarding wiki, feel free to ask in the #wiki channel on Discord.
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 missing details and is being worked on. - Article Structure
- If possible, adhere to the following structure for a page on the wiki:
= Title =
{{VersionXXX}}
{{Item/Monster Templates}}
A brief description of the subject.
== Subsection 1 ==
The detailed description on a particular aspect of the subject.
== Subsection 2 ==
...
== Guides ==
{{OB}}
Add how-to, tutorials, tips and tricks here.
== See Also ==
Links to related articles.
== History ==
A list of changes to the subject in old game revisions.
{{stub}} or {{wip}}
- Categories
- Add pages to appropriate categories whenever applicable.
- Images
- Sprites should have transparent backgrounds, and preferably extracted from game assets rather than taking 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: pressIto open the inventory; then right click on an item and selectdrop. - 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.
Templates
WIP: This article is a work in progress, meaning that it is being worked on but is unfinished. You can help by editing it.
{{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.
{{PTNTBD}} Stands for pages that need to be deleted. When using this this template make sure to a Reason. The item tag also needs documenting, but I'll get around to that later.
