Guide:Wiki Maintenance: Difference between revisions
From Step Mods | Change The Game
mNo edit summary |
mNo edit summary |
||
Line 8: | Line 8: | ||
<br> | <br> | ||
= Best | = Best Practice = | ||
== General == | == General == | ||
* 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. | ||
Line 99: | Line 99: | ||
Placeholder. | Placeholder. | ||
= Formatting | = Formatting = | ||
== General Formatting Tips == | == General Formatting Tips == | ||
This will hold the do's, don'ts and good habits with formatting but be focused on where to look for the info.<br> | This will hold the do's, don'ts and good habits with formatting but be focused on where to look for the info.<br> | ||
Line 152: | Line 152: | ||
=== Text Size & Coloring === | === Text Size & Coloring === | ||
For readability and consistency, use the [[:Template:Fc|Fc]] to modify font color and/or [[:Template:Fs|Fs]] to modify font size. These work well with the wiki themes. | For readability and consistency, use the [[:Template:Fc|Fc]] to modify font color and/or [[:Template:Fs|Fs]] to modify font size. These work well with the wiki themes. | ||
= Advanced = | |||
== Inline Styling == | |||
Custom, inline styling using HTML and CSS is not recommended, but not restricted either. Users should keep in mind that the Wiki uses themes. Step has taken great care to ensure the styling on the Wiki is clean, consistent across all themes, and up-to-date with modern standards. This is seen in the responsive design of the wiki, so users can enjoy the Wiki wherever they are and on whatever device they may have. This also creates a consistent look across the Wiki, regardless of theme used. The use of inline styling can easily break Step's intended design, therefore, users are asked to limit using it to a last resort option. If any user finds they are consistently using inline styling for a specific reason, we ask that they contact a member of staff (see bottom of the page) to inquire about changes being made globally. | |||
=== HTML === | |||
Inline HTML is perfectly fine to use. Users should keep in mind that HTML is restricted and parsed by the Wiki. This means the Wiki will automatically remove HTML that is not found on their [https://meta.wikimedia.org/wiki/Help:HTML_in_wikitext permitted list]. It's always preferable to use [https://www.mediawiki.org/wiki/Help:Formatting wiki markup]. | |||
=== CSS === | |||
As mentioned, inline styling is available, but should be used as a last resort. With that said, if customization is necessary, the Wiki is mostly compatible with Bootstrap 4. Users should use [https://www.w3schools.com/bootstrap4/bootstrap_ref_all_classes.asp Bootstrap's list of classes] as a first reference for any necessary inline styling deviation ''before'' moving on to completely custom edits. | |||
== HeaderTabs == | |||
Use of [https://www.mediawiki.org/wiki/Extension:Header_Tabs HeaderTabs] should be limited and the majority of content should use the TOC method. HeaderTabs are still great for some applicable content, however, they should be used sparingly. An example of HeaderTabs is use on this page to display the content within these tabbed sections. | |||
== Tables == | |||
Wiki tables are flexible enough to provide simple data sets or complex data sheets. Once their format is understood, tables should only be used for displaying ''data''. When creating structural code on custom pages, HTML is preferred. For a complete table reference, see the [https://www.mediawiki.org/wiki/Help:Tables MediaWiki documentation]. | |||
* 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. | |||
=Mod Pages= | =Mod Pages= | ||
Line 158: | Line 176: | ||
When adding/editing Mod Recommendations ... | 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 in , as they will contribute to guide ToC, which is horrific. Instead use: | * DO NOT use wiki or HTML headings in , as they will contribute to guide ToC, which is horrific. Instead use: | ||
*: <syntaxhighlight><div class="h5 mt-4">ALL CAPS HEADING</div></syntaxhighlight> | *: <syntaxhighlight><div class="h5 mt-4">ALL CAPS HEADING</div></syntaxhighlight> | ||
Line 170: | Line 189: | ||
* To style text, DO NOT use inline styling like <syntaxhighlight><span style=""></span></syntaxhighlight>. Instead use Bootstrap and custom CSS classes: | * To style text, DO NOT use inline styling like <syntaxhighlight><span style=""></span></syntaxhighlight>. Instead use Bootstrap and custom CSS classes: | ||
<syntaxhighlight><span class="orangetx"></span></syntaxhighlight> | <syntaxhighlight><span class="orangetx"></span></syntaxhighlight> | ||
= Wiki Templates = | = Wiki Templates = |
Revision as of 19:48, June 30, 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.
Maintenance Sections[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