Guide:Wiki Maintenance: Difference between revisions
From Step Mods | Change The Game
mNo edit summary |
mNo edit summary |
||
Line 5: | Line 5: | ||
The Step Modifications wiki is intended to be a community-driven project; although, most contributions to date have originated from only a handful of contributors. Our goal is to make it easy for all community members to contribute by helping us maintain existing content and developing new content. We created this reference to help our userbase get more comfortable working within a wiki environment. | The Step Modifications wiki is intended to be a community-driven project; although, most contributions to date have originated from only a handful of contributors. Our goal is to make it easy for all community members to contribute by helping us maintain existing content and developing new content. We created this reference to help our userbase get more comfortable working within a wiki environment. | ||
== Maintenance | == Step Wiki Maintenance == | ||
<br> | <br> | ||
= | = Finding Info = | ||
* The '''search bar''' is located at the right side of the navigation bar and can be useful for finding pages. | * The '''search bar''' is located at the right side of the navigation bar and can be useful for finding pages. | ||
* From the navigation bar at top, click on {{ui|Navigation}} and click {{ui|Recent Changes}}. This gives a list of the most recent edits on the Wiki. This is often the most convenient way to find a project of interest (and to see who may be fiddling around). | * From the navigation bar at top, click on {{ui|Navigation}} and click {{ui|Recent Changes}}. This gives a list of the most recent edits on the Wiki. This is often the most convenient way to find a project of interest (and to see who may be fiddling around). | ||
* Editing and other general preferences can be set by user ... click on the <i class="fas fa-user hltx p-1"></i> icon in the navigation bar and click {{ui|Preferences}}. | * Editing and other general preferences can be set by user ... click on the <i class="fas fa-user hltx p-1"></i> icon in the navigation bar and click {{ui|Preferences}}. | ||
= Editing & Markup = | |||
* To style text, DO NOT use inline styling like: | |||
*: <syntaxhighlight lang="HTML"><span style="color: #ff0"></span></syntaxhighlight> | |||
*: Instead use [https://www.w3schools.com/bootstrap4/bootstrap_ref_all_classes.asp Bootstrap] and custom CSS classes (see [[Project:SiteColorPallet|the site color pallet]] for the available classes): | |||
*: <syntaxhighlight lang="HTML"><span class="orangetx"></span></syntaxhighlight> | |||
* Please don't use header tags ( <code><nowiki><h2></h2></nowiki></code> ) to make text bigger or bolder. | * Please don't use header 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:Fs|Fs]] template. Header tags are for...''headers''. | ** Instead use [https://www.mediawiki.org/wiki/Help:Formatting wiki markup] and/or the [[Template:Fs|Fs]] template. Header tags are for...''headers''. | ||
Line 19: | Line 24: | ||
** Simple corrections to grammar do not require any special notification or mentions on the forum or Talk page. | ** Simple corrections to grammar do not require any special notification or mentions on the forum or Talk page. | ||
=Mod Pages= | |||
* | Edits to mod pages default to the 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.}} | |||
When adding/editing Mod Recommendations ... | |||
* Keep it basic and limit ALL markup code to only what is necessary. | |||
* DO NOT use wiki or HTML headings, as they will contribute to guide ToC, which is horrific. Instead use: | |||
*: <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 <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"> | |||
<div class="mpcode"> | |||
My mult-iline | |||
code | |||
snippet</div> | |||
</syntaxhighlight> | |||
== User Namespace == | == User Namespace == | ||
Line 76: | Line 95: | ||
=== Edit a Page === | === Edit a Page === | ||
Editing an existing page easy. Simply navigate to the page and click the <i class="fas fa-asterisk hltx p-1"></i> button on the wiki navigation bar. | Editing an existing page easy. Simply navigate to the page and click the <i class="fas fa-asterisk hltx p-1"></i> button on the wiki navigation bar. | ||
It's expected that any information added to the wiki is clearly cited, where applicable, as many users do not appreciate unverifiable speculation, unless it is plainly stated as such. That is to say, feel free to write what ''might'' or ''might not'' be factual, but qualify what is ''intended'' to be factual with verifiable information by posting a link where appropriate. However, we want to facilitate community contributions to the wiki, so we encourage all users to get involved. The [https://www.mediawiki.org/wiki/Extension:Cite Cite] extension is available on this wiki and makes adding inline citations and references easy. | |||
* More to come ... | |||
=== Delete a Page === | === Delete a Page === | ||
Line 170: | Line 192: | ||
* The standard "wikitable" class has been customized to work with our site and is preferred. | * The standard "wikitable" class has been customized to work with our site and is preferred. | ||
* Users can utilize [https://www.w3schools.com/bootstrap4/bootstrap_ref_all_classes.asp Bootstrap's classes] to help with custom formatting, as needed. | * Users can utilize [https://www.w3schools.com/bootstrap4/bootstrap_ref_all_classes.asp Bootstrap's classes] to help with custom formatting, as needed. | ||
= Wiki Templates = | = Wiki Templates = |
Revision as of 13:26, July 1, 2021
Step Wiki User Guide
Standards and tips for editing the Step wiki
by: Step Modifications | Forum Topic
Definition of a wiki:
- "...a website or database developed collaboratively that allows users to add, delete, or revise content by using a web browser."
The Step Modifications wiki is intended to be a community-driven project; although, most contributions to date have originated from only a handful of contributors. Our goal is to make it easy for all community members to contribute by helping us maintain existing content and developing new content. We created this reference to help our userbase get more comfortable working within a wiki environment.
Step Wiki Maintenance[edit | edit source]
Need Help?[edit | edit source]
Private message one of these guys if you need some sort of help with The Wiki.
Primary Wiki Editors/Maintainers[edit | edit source]
Always looking for others!
- z929669
- DoubleYou (MO & STEP Guides primarily)
- TechAngel85