Guide:Wiki Maintenance: Difference between revisions
From Step Mods | Change The Game
mNo edit summary |
mNo edit summary |
||
Line 20: | Line 20: | ||
* <i class="fas fa-toolbox salmontx px-1"></i>{{Fc|instruction|Tools}} - Several [https://www.mediawiki.org/wiki/Help:Navigation#Toolbox standard tools] for finding information related to the current page as well as the [https://www.mediawiki.org/wiki/Help:Navigation#User_links Page information] tool. The [https://www.semantic-mediawiki.org/wiki/Help:Browsing_interfaces#Semantic_browsing Browse properties] tool is provided by [https://www.semantic-mediawiki.org/wiki/Help:User_manual Semantic Mediawiki], which is an important extension driving the functionality of this wiki. | * <i class="fas fa-toolbox salmontx px-1"></i>{{Fc|instruction|Tools}} - Several [https://www.mediawiki.org/wiki/Help:Navigation#Toolbox standard tools] for finding information related to the current page as well as the [https://www.mediawiki.org/wiki/Help:Navigation#User_links Page information] tool. The [https://www.semantic-mediawiki.org/wiki/Help:Browsing_interfaces#Semantic_browsing Browse properties] tool is provided by [https://www.semantic-mediawiki.org/wiki/Help:User_manual Semantic Mediawiki], which is an important extension driving the functionality of this wiki. | ||
* <i class="fas fa-asterisk salmontx px-1"></i> - Edit current page (if this icon is absent, the current user does not have permission to edit the page). | * <i class="fas fa-asterisk salmontx px-1"></i> - Edit current page (if this icon is absent, the current user does not have permission to edit the page). | ||
* <i class="fas fa-ellipsis-h salmontx px-1"></i> - Maintenance links within the context of the current page. Similar to <i class="fas fa-toolbox px-1"></i> | * <i class="fas fa-ellipsis-h salmontx px-1"></i> - Maintenance links within the context of the current page. Similar to <i class="fas fa-toolbox px-1"></i>Tools: | ||
** {{Fc|instruction| | ** <{{Fc|instruction|Namespace}}> - Only appears when in 'edit' mode. This links back to the page being edited. | ||
** {{Fc|instruction|Discussion}} - Link to the 'Talk' page of the current page | ** {{Fc|instruction|Discussion}} - Link to the 'Talk' page of the current page | ||
** {{Fc|instruction|History}} - Link to view the edit history for the page | ** {{Fc|instruction|History}} - Link to view the edit history for the page | ||
Line 42: | Line 42: | ||
=== Citations === | === Citations === | ||
It's expected that any information added to the wiki is | It's expected that any information added to the wiki is cited where applicable as in [[Project:About|this example]]. Citations really only apply when providing evidence or advice that is not well known or not obviously subjective or speculative. Feel free to write what ''might'' or ''might not'' be factual as long as it is obvious to the reader, but qualify (cite) what is ''intended'' to be factual. The [https://www.mediawiki.org/wiki/Extension:Cite Cite] extension is available on this wiki and makes adding inline citations and references easy. | ||
=== Describing Edits === | === Describing Edits === | ||
When editing a page, remember to add a brief descriptive comment in the summary box below the editor before saving. This summary will be logged on the Recent Changes page and helps everyone to know what exactly was added/changed. | |||
Discussions of major changes to content should occur on the page's 'Discussion' forum (if linked) or 'Talk' page. It's also appropriate to contact the page's creator/editor and/or a staff member and point them to the discussion when proposing content or stylistic changes. | |||
{{AlertSmall|text=Simple corrections to grammar do not require any special notification or mentions on the forum or Talk page.}} | |||
=== Instruction Sets === | === Instruction Sets === | ||
Follow these guidelines when writing instructions: | Follow these guidelines when writing instructions: | ||
* | * Instructing to 'tick', 'click, or 'select' any UI element - Use [[:Template:Ui]]: | ||
*: <code><nowiki>Click {{Ui|this}}, then right click {{Ui|that}}, and select {{Ui|OK}}</nowiki></code> | *: <code><nowiki>Click {{Ui|this}}, then right click {{Ui|that}}, and select {{Ui|OK}}</nowiki></code> | ||
**Click {{Ui|Edit}}, then right click {{Ui|some UI element}} ... | **Click {{Ui|Edit}}, then right click {{Ui|some UI element}} ... | ||
* When referring to messages in the UI: ''Italicize the UI message'', and do not highlight it in any other way. | * When referring to messages in the UI: ''Italicize the UI message'', and do not highlight it in any other way. | ||
* In-line headings: | * In-line headings - When the first text in a list or a paragraph is acting as a heading (see "Mod Pages" tab in this guide): | ||
*: <code><nowiki>{{Fc| | *: <code><nowiki>{{Fc|ilheading|'''InlineHeading'''}}</nowiki></code> | ||
=== Symbols === | === Symbols === | ||
Line 69: | Line 68: | ||
=== Text Size & Coloring === | === Text Size & Coloring === | ||
For readability and consistency, use the [[:Template: | For readability and consistency, use the [[:Template:Fc]] to modify font color and/or [[:Template:Fs]] to modify font size. These work well with the wiki themes. | ||
=== DO NOT === | === DO NOT === | ||
Line 77: | Line 76: | ||
*: <syntaxhighlight lang="HTML"><span class="orangetx"></span></syntaxhighlight> | *: <syntaxhighlight lang="HTML"><span class="orangetx"></span></syntaxhighlight> | ||
* DO NOT use heading tags ( <code><nowiki><h2></h2></nowiki></code> ) to make text bigger or bolder. | * DO NOT use heading tags ( <code><nowiki><h2></h2></nowiki></code> ) to make text bigger or bolder. | ||
** Instead use [https://www.mediawiki.org/wiki/Help:Formatting wiki markup] and/or the [[Template: | ** Instead use [https://www.mediawiki.org/wiki/Help:Formatting wiki markup] and/or the [[Template:Fs]]. | ||
=Mod Pages= | =Mod Pages= | ||
Edits to mod pages default to the [https://www.mediawiki.org/wiki/Extension:Page_Forms Page Forms] editor, but the wiki editor can also be accessed under the ellipse to the right of the edit asterisk on mod pages. The wiki editor should only be used by those who understand the format expected by [[Template:Mod]]. | Edits to mod pages default to the [https://www.mediawiki.org/wiki/Extension:Page_Forms Page Forms] editor, but the wiki editor can also be accessed under the ellipse to the right of the edit asterisk on mod pages. The wiki editor should only be used by those who understand the format expected by [[:Template:Mod]]. | ||
{{Alert|text=Mod page 'Recommendations' are transcluded into ModGroup tables of mod-build guides, so special conventions apply to markup and HTML syntax used on these pages.}} | {{Alert|text=Mod page 'Recommendations' are transcluded into ModGroup tables of mod-build guides, so special conventions apply to markup and HTML syntax used on these pages.}} | ||
Line 87: | Line 86: | ||
* DO NOT use wiki or HTML headings, as they will contribute to guide ToC. Instead use: | * DO NOT use wiki or HTML headings, as they will contribute to guide ToC. Instead use: | ||
*: <syntaxhighlight lang="HTML"><div class="mpheading">headingText</div></syntaxhighlight> | *: <syntaxhighlight lang="HTML"><div class="mpheading">headingText</div></syntaxhighlight> | ||
* DO NOT use Template calls other than [[Template:Fomod]]. They contribute drastically to the [https://en.wikipedia.org/wiki/Wikipedia:Template_limits wiki transclusion limit] of guide pages. | * DO NOT use Template calls other than [[:Template:Fomod]]. They contribute drastically to the [https://en.wikipedia.org/wiki/Wikipedia:Template_limits wiki transclusion limit] of guide pages. | ||
* DO NOT use <code><nowiki><pre></nowiki></code> tags to show multi-line code examples. Wiki and PHP do not play nicely together when transcuding this syntax, resulting in an error on the guide. Instead use: | * DO NOT use <code><nowiki><pre></nowiki></code> tags to show multi-line code examples. Wiki and PHP do not play nicely together when transcuding this syntax, resulting in an error on the guide. Instead use: | ||
<syntaxhighlight lang="HTML"> | <syntaxhighlight lang="HTML"> | ||
Line 138: | Line 137: | ||
=== PageTitle Template === | === PageTitle Template === | ||
The [[Template:PageTitle | The [[:Template:PageTitle]] is used to create a standardize title at the top of a page. It's recommended to be placed at the top of all non-guide pages. This creates a consistent look across the Wiki. It can be seen used for all officially curated content (such as this Guide). This template should be placed at the top of the page, directly after any listed categories. | ||
=== Table of Contents === | === Table of Contents === | ||
Most lengthier pages should include a table of contents (TOC). Step has provided a couple of templates to add with this while providing a style that is suitable for the Wiki themes. To include a TOC use one of the following templates: | Most lengthier pages should include a table of contents (TOC). Step has provided a couple of templates to add with this while providing a style that is suitable for the Wiki themes. To include a TOC use one of the following templates: | ||
* [[Template:TOC_left | * [[:Template:TOC_left]] | places TOC, floated to ''left'' side of page | ||
* [[Template:TOC_right | * [[:Template:TOC_right]] (preferred version) | places TOC, floated to ''right'' side of page | ||
The TOC templates will appear on the pages at the position the template is placed. Therefore, it's possible to have elements (such as an Alert) above the TOC. In general, this template should be placed directly after the PageTitle template or categories. | The TOC templates will appear on the pages at the position the template is placed. Therefore, it's possible to have elements (such as an Alert) above the TOC. In general, this template should be placed directly after the PageTitle template or categories. | ||
Line 223: | Line 222: | ||
== Common Templates == | == Common Templates == | ||
Some of the more common Templates that are used on the STEP wiki are: | Some of the more common Templates that are used on the STEP wiki are: | ||
* [[Template: | * [[:Template:Alert]] | creates a large, centered alert box | ||
* [[Template: | * [[:Template:AlertSmall]] | creates a small, inline alert element | ||
* [[Template:clear | * [[:Template:clear]] | used to clear floating elements | ||
* [[Template: | * [[:Template:Fc]] | used to change font color to a pre-defined color (colors work with themes) | ||
* [[Template: | * [[:Template:Fomod]] | creates a graphical representation of FOMOD instructions | ||
* [[Template: | * [[:Template:Fs]] | changes the font size. Accepts any valid CSS. | ||
* [[Template: | * [[:Template:Icon]] | places a small icon for specific uses | ||
* [[Template: | * [[:Template:Quotation]] | creates a stylized blockquote | ||
* [[Template: | * [[:Template:Sidebox]] | creates a stylized box to the side of the content | ||
* [[Template: | * [[:Template:Spoiler]] | creates an element with hidden content that reveals when a title is clicked | ||
* [[Template: | * [[:Template:TOC right]] | floats a Table of Contents to the right of the page | ||
* [[Template: | * [[:Template:Video]] | embeds a YouTube video on the page | ||
= Moderated Content = | = Moderated Content = | ||
Line 252: | Line 251: | ||
==== Guide Standard Header ==== | ==== Guide Standard Header ==== | ||
Use the [[Template: | Use the [[:Template:PageTitle]]. | ||
= Useful Links = | = Useful Links = |
Revision as of 19:40, July 1, 2021
Step Wiki User Guide
Standards and tips for editing the Step wiki
by: Step Modifications | Forum Topic
This page was created as a quick reference for Step wiki editors in maintaining THIS WIKI. More general information is linked were applicable, and links to all of the most relevant information about using Mediawiki and Semantic Mediawiki are provided under the "References" tab below. The Step Modifications wiki is intended to be community-maintained. Only community members are able to edit the wiki, so sign up to become a member. Then log onto the wiki to begin contributing.
Need Help?[edit | edit source]
For help using this wiki, to offer up suggestions, or to report problems, post on the Wiki Support forum, or private message one of us.
Primary Wiki Editors/Maintainers[edit | edit source]
Always looking for others!