Difference between revisions of "Isleward Wiki:Community Portal"

From Isleward Wiki
Jump to navigation Jump to search
(added collapse template)
 
(51 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
{{ DO NOT REMOVE - Community Portal Header }}
+
__NOTOC__
 +
{{DO_NOT_REMOVE_-_Community_Portal_Header}}
  
−
! If anyone has some time, could they document the item tag?
+
= Community Portal =
 +
Welcome to the Isleward Wiki. This page documents recommended practices to edit the wiki as well as tasks that need to be done.
  
−
== Task Queues ==
+
== Editing the Wiki ==
−
* [[Special:WhatLinksHere/File:Missing.png|Pages Missing Images]]
+
To make changes to the wiki, you must request a wiki account. Please contact moderators on the <code>#wiki</code> channel on [http://discord.isleward.com Discord] about details to create an account.
−
* [[Special:RecentChanges|Recent Changes]]
+
 
−
* [[Special:NewPages|New Pages]]
+
Note that your wiki account is not related to your in-game account in any ways.
−
* [[Special:NewFiles|New Files]]
+
 
−
* [[Isleward_Wiki:Sandbox|Sandbox]]
+
See [https://www.mediawiki.org/wiki/Help:Formatting MediaWiki Formatting Help] for the syntax used by Isleward Wiki.
−
* [[:Category:Work In Progress]]
+
 
−
* [[:Category:Stubs]]
+
== 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>{{Version 0.1.10}}</nowiki></code> (for v0.1.10), <code><nowiki>{{Version 0.1.9}}</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>{{Version Unknown}}</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> at the top of the page if the page is actively being worked on (meaning you are going to finish it soon) so no conflicting edits are made. The WIP template should "claim" a page for editing and warn others that you are working with it still. 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 (notice that the version and infobox templates are above the page title):
 +
<pre>
 +
{{Version X.Y.Z}}
 +
{{wip}} if needed
 +
{{Item/Monster Templates}}
 +
= Title =
 +
{{Quotation||In-game description}}
 +
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}}
 +
 
 +
[[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 be extracted from game assets rather than taken from screenshots.
 +
: Use <code><nowiki>[[File:Missing.png]]</nowiki></code> as placeholders for missing images.
 +
 
 +
== Formatting & Styling ==
 +
* Pages should be in sentence case ("One two three") so we can easily link to them
 +
** Pages should usually be singular
 +
* Categories should be plural
 +
* 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.
 +
* The first time the page title is written, it should be bolded.
 +
* Use <code><nowiki>{{issue|number}}</nowiki></code> to create links to Isleward's GitLab issues.
 +
 
 +
== Extensions ==
 +
* [https://www.mediawiki.org/wiki/Extension:Nuke Nuke]
 +
* [https://www.mediawiki.org/wiki/Extension:Moderation Moderation]
 +
* [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions ParserFunctions]
 +
* [https://www.mediawiki.org/wiki/Extension:Semantic_MediaWiki Semantic MediaWiki]
  
 
== Templates ==
 
== 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.
 
  
−
<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.
+
=== Infoboxes ===
 +
* [[Template:Zone infobox]]
 +
** Variant: [[Template:Dungeon infobox]]
 +
* [[Template:Faction infobox]]
 +
** See also [[Template:Faction reputation sources]] and [[Template:Reputation source]]
 +
* [[Template:Rune infobox]]
 +
** See also [[Template:Rune stats]]
 +
* [[Template:Item infobox]]
 +
* [[Template:NPC infobox]]
 +
 
 +
=== Formatting ===
 +
* [[Template:Q common]], [[Template:Q rare]], etc.
 +
* [[Template:Quotation]]
 +
 
 +
=== Math ===
 +
* [[Template:Round]] and [[Template:Roundcalc]]
 +
 
 +
=== Banners ===
 +
* [[Template:Banner]]
 +
* [[Template:Version 0.11.0]] etc.
 +
** Should be used for pages that are up to date as of Version 0.3.1. Can change version numbers to (most) historic versions for an outdated tag.
 +
* [[Template:Proposed deletion]]
 +
* [[Template:Unreleased]]
 +
* [[Template:Note]]
 +
* [[Template:Removed]]
 +
* [[Template:Stub]]
 +
* [[Template:Wip]]
 +
 
 +
=== Misc ===
 +
<nowiki>{{BadImage}}</nowiki> Used for images that are not taken directly from the game source (screenshots are bad, cut images from spritesheets instead).
 +
 
 +
(needs reworking) <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).
+
== Tasks ==
 +
Collections of various work that needs to be done.
  
−
<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.
+
* [[:Category:Needs work]]
 +
* [[Special:LonelyPages|Orphaned Pages]]
 +
* [[:Category:Stubs]]
 +
* [[:Category:Proposed deletion]]
 +
* [[:Category:Work In Progress]]
 +
* [[:Category:Bad Images]]
  
−
The item tag also needs documenting, but I'll get around to that later.
+
== Helpful Links ==
 +
* [[Special:RecentChanges|Recent Changes]]
 +
* [[Special:NewPages|New Pages]]
 +
* [[Special:NewFiles|New Files]]
 +
* [[Isleward Wiki:Sandbox|Sandbox]]

Latest revision as of 03:50, 1 November 2022

Isleward Wiki Community Portal

This is the Isleward Wiki Community Portal. You can discuss the wiki, list pages that need work/assistance, etc. here

When using this sandbox please follow these simple rules:

  • Please do not delete each other.
  • Please leave this notice and the comments at the beginning of this page intact.
  • This page must not be moved.
  • Do not add categories to this page, this includes categories added by templates like deletion templates etc..

Happy editing!

Community Portal[edit]

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

Editing the Wiki[edit]

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[edit]

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 {{Version 0.1.10}} (for v0.1.10), {{Version 0.1.9}} (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 {{Version Unknown}}, 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}} at the top of the page if the page is actively being worked on (meaning you are going to finish it soon) so no conflicting edits are made. The WIP template should "claim" a page for editing and warn others that you are working with it still. 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 (notice that the version and infobox templates are above the page title):
{{Version X.Y.Z}}
{{wip}} if needed
{{Item/Monster Templates}}
= Title =
{{Quotation||In-game description}}
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}}

[[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 be extracted from game assets rather than taken from screenshots.
Use [[File:Missing.png]] as placeholders for missing images.

Formatting & Styling[edit]

  • Pages should be in sentence case ("One two three") so we can easily link to them
    • Pages should usually be singular
  • Categories should be plural
  • 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.
  • The first time the page title is written, it should be bolded.
  • Use {{issue|number}} to create links to Isleward's GitLab issues.

Extensions[edit]

Templates[edit]

Infoboxes[edit]

Formatting[edit]

Math[edit]

Banners[edit]

Misc[edit]

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

(needs reworking) {{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).

Tasks[edit]

Collections of various work that needs to be done.

Helpful Links[edit]

Retrieved from "https://wiki.isleward.com/index.php?title=Isleward_Wiki:Community_Portal&oldid=9912"