Guide:Wiki Maintenance

From Step Modifications | Change The Game
Revision as of 19:16, July 2, 2021 by Z929669 (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Delta c.png

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. We are seeking contributors to assist us in updating our deprecated guides.

[edit]

Navigation & Tools[edit]

  • Forum - Link to the Step forum
  • Gamespaces - Links to game-specific home pages
  • Game Guides - Links to official mod-build guides
  • Navigation - Links to important reference pages ... and others:
    • Entry Page - The Step wiki "Main Page"
    • Step Portal - Entryway for mod and guide maintenance
    • Game Tree - Reveals the Game Category Tree for an overview of all supported games with links to each
    • Guide Tree - Reveals the Guide Category Tree for an overview of all guides with links to each
    • Recent Changes - View the most recent edits on the wiki.
    • Random Page - Ummm ...
    • Help - General Mediawiki reference
    • Contact Us - Links to Step's contact information
    • Search - Links to Special:Search, where one can refine search parameters
  • Tools - Several standard tools for finding information related to the current page as well as the Page information tool. The Browse properties tool is provided by Semantic Mediawiki, which is an important extension driving the functionality of this wiki.
  • - Edit current page (if this icon is absent, the current user does not have permission to edit the page).
  • - Maintenance links within the context of the current page. Similar to Tools:
    • <Namespace> - Only appears when in 'edit' mode. This links back to the page being edited.
    • Discussion - Link to the 'Talk' page of the current page
    • History - Link to view the edit history for the page
    • Delete - Link to delete the page (if current user has permission to do so)
    • Move - Link to move (rename) the page (if current user has permission to do so)
    • Protect - Link to protect the page by restricting who can edit (if current user has permission to do so)
    • Watch / Unwatch - Enables current user to keep tabs on edits to the page via Special:Watchlist
    • Refresh - Link to refresh (soft edit) the current page (if current user has permission to do so)
  • - Several User-specific tools
  • Search - Quick search for finding pages. Use tools under Special:SpecialPages#Lists_of_pages for more focused searches.

Writing Style[edit]

When writing content outside of the user-space, the third-person writing style should be used. Other writing styles are acceptable, depending upon the particular context of the article; however, any factual content created to serve as an informative article (e.g., guides and references) should be written in the third person. This is more clear and professional and not as prone to degenerating into a mess of first-second person reversions. Any content existing outside the user-space that is not written in the third person should be corrected accordingly. Examples:

  • First person: "I first must click on the 'edit' button ..."
  • Second person: "You first must click on the 'edit' button ..."
  • Third person: "First, click on the 'edit' button ..."
    NOTE: This is redundant and overly wordy. Please be succinct and avoid adding the obvious:
    "First, users should click on the 'edit' button ..."

Citations[edit]

It's expected that any information added to the wiki is cited where applicable as in 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 Cite extension is available on this wiki and makes adding inline citations and references easy.

Describing Edits[edit]

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.

Info-Logo.png
      Notice:
Simple corrections to grammar do not require any special notification or mentions on the forum or Talk page.

Internal Links[edit]

By definition, internal wiki links point to another page on the wiki. If the link is blue, the page exists. If a link is red-orange (referred to generally as "red links"), the page has not been created. Feel free to click on red links to create their corresponding pages by adding something relevant and saving. Wanted Pages is a special page that houses a list of red-link pages that have been referenced from other pages.

PageTitle Template[edit]

For articles that will potentially be linked from elsewhere, Template:PageTitle is used to create a standard title at the top of the page. This template must be called at the beginning of the first line in the editor to avoid creating a block of white space before the title (exception: "behavior switches" can be added before this template call). This creates a consistent 'header' for all articles on the wiki.

Table of Contents[edit]

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:

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.

Instruction Sets[edit]

Follow these guidelines when writing instructions:

  • Instructing to 'tick', 'click, or 'select' any UI element - Use Template:Ui:
    Click {{Ui|this}}, then right click {{Ui|that}}, and select {{Ui|OK}} Click [this], then right click [that], and select [OK]
  • When referring to messages in the UI: Italicize the UI message, and do not highlight it in any other way.
  • Inline headings - When the first text in a list or a paragraph is acting as a heading (see "Top Menu" tab in this guide):
    {{Fc|ilheading|InlineHeading}} InlineHeading

Symbols[edit]

Special characters and symbols can be displayed using character codes as demonstrated here with the copyright symbol. Unicode is not supported.

  • Hex code - &#xa9; ©
  • HTML code - &#169; ©
  • HTML entity - &copy; ©
  • Font Awesome - <i class="far fa-copyright"></i>

Corlor Formats[edit]

To maintain optimal compatibility across site themes, use Template:Fc to modify font color (see Template:Fs to modify font size). Likewise, custom CSS classes are available for coloring text, backgrounds, and borders. See the Step Wiki User Guide for details about using these classes.

DO NOT[edit]

  • DO NOT use inline styling like the following:
    <span style="color: #ff0"></span>
    Instead use Bootstrap and custom CSS classes (see the site color pallet for the available classes):
    <span class="orangetx"></span>
  • DO NOT use heading tags ( <h2></h2> ) to make text bigger or bolder.

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.

Info-Logo.png Notice:
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 don't get fancy. The primary purpose of these pages is NOT to be pretty bur rather to convey info on guides.
  • DO NOT use wiki or HTML headings, as they will contribute to guide ToC. Instead use:
    <div class="mpheading">headingText</div>
  • DO NOT use Template calls other than Template:Fomod. They contribute drastically to the wiki transclusion limit of guide pages.
  • DO NOT use <pre> 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:
<p class="mpcode">My mult-iline
code
snippet
</p>

User Namespace[edit]

The simplest way to get started on the Wiki is to begin by playing around under the User namespace: ../wiki/User:Username

Registered members can do just about anything they want within their User namespace, as long as it's in accordance with the guidelines dictated within the Community Citizenship Guide. Please ...

... avoid editing another members's User pages without permission, because doing so is a breach of etiquette. This does not apply to User_talk pages where it is expected that others will leave comments.
... edit their User page adding some information about themselves for others ... even a link to another website or their forum profile is a good start.

Creating Pages[edit]

Creating a new page on a wiki is not immediately intuitive to the novice wiki editor; however, it's very simple once the method is understood. Regardless of where on the Wiki a new page is being created, the method is the same. Navigate to any URL by typing in any string after https://stepmodifications.org/wiki/ and hitting the Enter key. If the page does not exist, a message will appear that includes an option to "create this page". To create a new page on the wiki in the User namespace:

  1. In the URL type https://stepmodifications.org/wiki/User:YourUserName
  2. Hit Enter to load the page.
  3. To create the page, either click the "create this page" link in the displayed text or click the icon on the navigation bar. Note that to save, there must be content in the editor box.

Edit/Delete/Move/Rename[edit]

Delete a Page[edit]

From time to time maintenance warrants the removal of pages, however, this shouldn't be a routine task. Users should be aware deleted content is not actually "deleted", but rather "archived". Thus, deleted pages can be restored. Pages are only truly deleted when old archives are purged during maintenance (performed a couple times a year...maybe). To delete pages:

  1. Click on the icon on the navigation bar.
  2. Click [Delete]
  3. One the page that loads, select a reason for deletion.
  4. Enter additional information, if applicable.
  5. Click the [Delete page] button.

Move/Rename a Page[edit]

Moving and renaming a page is the same process. This is because you can only rename a page by moving. Whenever pages are moved, a redirect should always be created. The redirect allows any links linking to the old page to be redirected to the new page, seamlessly. To move/rename a page:

  1. Click on the icon on the navigation bar.
  2. Click [Move]
  3. On the form under New title, select the namespace from the dropdown box (this typically matches the original namespace).
  4. Under that within the input box, type the page name of the page.
    This box is where users can rename the content, if desired. Either type the same page name or provide a new one.
  5. Within the input box under Reason, provide a short explanation why the page is being moved.
  6. Ensure the boxes are ticked for Move associated talk page and Leave a redirect behind.
  7. Click the [Move page] button.

Categories[edit]

Categories are used to topically associate wiki pages. They also provide a simple means to navigate and view associated pages. Simply scroll to the bottom of any page and follow the category links to view more pages within that same category. Assigning a page to a category is as simple as adding [[Category:<CatName>]] when editing the page. Categories can be referenced on a page without adding that page to the referenced category by adding a colon to the beginning of the code as such: [[:Category:<CatName>]]. Users are asked to:

  • Read about how to use categories.
  • Assign pages to the proper existing categories.
  • Avoid creating new categories --leave that to the site admin. Just let one of the administrators know.
  • Place the category code at the TOP of the page for consistency and to make it easy for other users to find.

Using Forms[edit]

Placeholder.

General Formatting Tips[edit]

This will hold the do's, don'ts and good habits with formatting but be focused on where to look for the info.
Like the cheat-sheet...

Magic Words[edit]

Magic words are special 'text strings' that are used by the wiki software to return values or functions. A full description of them can be found on the MediaWiki website.

Common Magic Words[edit]
__NOTOC__ Hides the table of contents (TOC).
{{FULLPAGENAME}} Prints the Namespace and full page Title (including all subpage levels).
Result: Guide:DDSopt/DDSopt_INI
{{NAMESPACE}} Prints the Namespace.
Result: Guide
{{PAGENAME}} Prints the full page Title (including all subpage levels) without the namespace.
Result: DDSopt/DDSopt_INI
{{SUBPAGENAME}} Prints the subpage Title of the current page. If not a subpage, defaults to {{PAGENAME}} behavior.
Result: DDSopt_INI

Inline Styling[edit]

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

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 permitted list. It's always preferable to use wiki markup.

CSS[edit]

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 Bootstrap's list of classes as a first reference for any necessary inline styling deviation before moving on to completely custom edits.

HeaderTabs[edit]

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

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 MediaWiki documentation.

  • The standard "wikitable" class has been customized to work with our site and is preferred.
  • Users can utilize Bootstrap's classes to help with custom formatting, as needed.

Templates Explained[edit]

Templates are standard wiki pages whose content is designed to be transcluded (embedded) inside other pages. Step utilizes templates for creating standardized elements (alert boxes, galleries, side boxes, spoilers, table of contents, etc.), which are used across the wiki for all content. Templates are also used for creating some of our framework and guide structure. Since they are essential for our guides and basic website elements, templates have restricted editing rights; only certain staff groups can edit these pages. However, all users can utilize the templates for their content and are encouraged to do so where appropriate.

Templates can be found from the navigation "Tools" menu by clicking: Special Pages scroll down to Page Forms heading Templates

Common Templates[edit]

Some of the more common Templates that are used on the STEP wiki are:

Moderated Content Overview[edit]

The Wiki has many pages of content that are considered "Moderated Content". This simply means they are either watched more closely than other or restricted via user groups. Below are the different types of Moderated Content user will find on the Wiki.

Namespaces[edit]

There are several namespaces on the Wiki that are restricted to specific user groups. These include:

  • Project
  • STEP
  • Template

Guides[edit]

The Wiki is home to many guides that are considered official Step content. Such guides are considered "Moderated Content". Since they should all have the same general look and feel, Step exerts a level of control over this content. Any major changes to these guides should be posted to their topics on the Forums.

Following are some basic standards for guides...

Guide Standard Header[edit]

Use the Template:PageTitle.

Need Help?[edit]

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]

Always looking for others!

Recently-Active Contributors[edit]
https://stepmodifications.org/wiki/Special:ActiveUsers