Guide:The STEP Wiki

From STEP Modding Wiki
Revision as of 04:02, November 11, 2020 by Z929669 (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Contents

The STEPwiki editing guide for editors -- by S.T.E.P. Team

GUIDE FORUM THREAD


Weapon.png Under Construction:
This page is incomplete but all info is relevant!

Introduction

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.

Wiki Usage Tips

  • The wiki search bar is located at the bottom right of the browser window; however, can be found in the Wiki drop-down menu at the top of the page as well. Use this to find just about anything quickly.
  • From the Header bar at top, select[WIKI] >[RECENT CHANGES] to get a look at the most recent activity 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 general preferences can be set by user ... click on your username at top-right in the header bar.

Userspace

The simplest way to get started on The Wiki is to begin by playing around under the userspace: wiki.step-project.com/User:Username

This is the user's "main page" or "entry-way" into the user's personal sandbox. Each user can do just about anything they want within their userspace, as long as it's in accordance with the guidelines dictated within the Community Citizenship Guide. Users are asked to...

...avoid editing another user's page without permission (not applicable to wiki administrators), it is a breach of etiquette to do so.
...edit the page and add some information about themselves for others ... even a link to another website or their forum profile is a good start.

Creating a Page within the Userspace

To create you own page that is in your Userspace:

  1. Make sure that you are logged into The Wiki by looking at the top-right hand corner of the page.
  2. In the URL type https://wiki.step-project.com/User:<username>/<subpage>
    • In the <username> field type YOUR user name
    • In the <subpage> field type the title of the page.
    • Then hit enter.
  3. On the new page, in the top-right hand corner of the page click on the [PAGE TOOLS] button and select[CREATE].
    • To save, there must be content in the editor box.
    • Some writers have found that typing "Hi" or == Introduction == is good enough to get things moving.

The Wiki - Best Practices

General Edits

  • Please don't use heading code to make text bigger or bolder. Instead use wiki markup and/or the Fs template. Headings are for ... headings
  • When editing a page, be sure to fill in the summary box below the editor box with what changes what were made before saving. This summary will be logged on the Recent Changes page and helps everyone to know what exactly was added/changed with a given edit.
  • More to come ...

Discussions of major changes to content should occur on the page's 'Discussion' forum. 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. Simple corrections to grammar do not require any special notification or mentions on the forum or Talk page.

It is 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.

Writing Style

When writing content outside of the userspace, 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 that exist outside userspaces, and is also 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 ..."

Categories

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.

Instruction Sets

Follow these guidelines when writing instructions:

  • When instructing a user to 'click' or 'select' any UI element: use the Ui template, as in the following example:
    • Click {{ui|Edit}}, then right click {{ui|some UI element}} ...
    • Click[Edit], then right click[some UI element] ...
  • When referring to messages in the UI: Italicize the UI message, and do not highlight it in any other way.
  • In-line headings: If you have several bullets or paragraphs in a row which each refer to a certain topic, you may use bold, peach-colored formatting to highlight the topic of each bullet or paragraph, as in the following example:
    • {{fc|#e6b693|'''First Topic Name.'''}} This paragraph explains the first topic. Other paragraphs will have their own in-line headers and explanations.
    • First Topic Name. This paragraph explains the first topic. Other paragraphs will have their own in-line headers and explanations.
    • Working Example

Text Coloring

For readability and consistency, use the fc template with one of the following color codes when applicable (see the template page for more info):

  • #9eb8ee (blue-ish) - Text relating to additions, enhancements, or confirmations.
  • #78c888 (green-ish) - Text relating to fixes, or functional/relevant things.
  • #ff7878 (red-ish) - Text relating to removals, or non-functional/irrelevant things.
  • #c0c840 (yellow-ish) - Text relating to issues or unknowns.
  • #f09800 (orange-ish) - Text relating to changes/modifications.
  • #e6b69e (peach-ish) - The important part of instruction text, or highlight an in-line header.
  • #ddd (white-ish) - Generally important text (not an in-line header or instruction-related).

Formatting Basics

This will hold the dos, donts and good habits with formatting but be focus on where to look for the info.
Like the cheatsheet...

Symbols

Search for HTML symbols and use a code like "#8594;" with an ampersand "&" in front of it to produce "→"

Inline HTML and CSS

I believe that is what the span style tag is. This will give some common usages that are on step but will will guide the user to a link for what styles are valid like such

Using Templates

Templates can be found in [TOOLBOX] → [SPECIAL PAGES] → [Templates]
Here is a direct link

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

Info-Logo.png Notice:
The code for this is: {{alert|type=notice|text=text for the notice}}
Warning-Logo.png Warning:
The code for this is: {{alert|type=warning|text=text for the warning}}

Some are used for links, either to other pages in the current wiki or to outside pages. The following is a link to a chapter in the current document that also has a 'tabbed' header, such as the Mod Organizer wiki:

{{#switchtablink:Profiles|Profiles}}

YouTube videos can also be linked to with code like this:

{{Video|j4ZQpzf_iAE|Mod Organizer: Introduction (by Gopher)|Gopher Explains Mod Organizer}}

Here the magic word Video is read as https://www.youtube.com/watch?v= and j4ZQpzf_iAE, the YouTube address for that specific video, is appended to the YouTube code to provide a valid address. Clicking that link will display a popup window of that video file.

Page Management

How to create, delete, edit and manage a wiki page...

A wiki is simply an integrated assemblage of pages containing information that usually links to other wiki pages. Every internal wiki link points to another page. If the link is blue, the page exists, and if it is orange, the page is referenced, but has not been created. Feel free to click on orange links and create the page by adding something relevant and saving.

  • Wanted Pages is a special page that houses a list of links that have been created within content, however, the linked pages not not exist.

Deleting a Page

X

Use of HeaderTabs

Use of HeaderTabs should be limited and the majority of content should use the TOC method. HeaderTabs are still great some applicable content, however, they should be used sparingly.

Warning-Logo.png      Warning:
Don't use [PAGE TOOLS] → [EDIT EXTERNAL] That feature is deprecated in MediaWiki and requires a lot of user configuration to function correctly.

Magic Words

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

X

Using Forms

Placeholder.

Moderated Content

Guides

This wiki has many, and they should all have the same general look and feel. Following are some basics ...

Guide Standard Header

Our guides (aside from the main STEP Guide) maintain a consistent look in part by following a specified formula. Please use the following format (placed just after TRANSCLUSIONS & CATEGORIES header format):

<!-- ########### STANDARD GUIDES HEADER FORMAT ############ -->
''Brief guide description here -- by Author(s) here''

[<forum thread URL> '''GUIDE FORUM THREAD''']
----
Add any relevant Notification Templates here
<br />

<!-- ######### END standard guide header format ########## -->

References

Wiki Resources

Mediawiki

Home Page - Entry point to lots of relevant info, including reference and help as well as latest development and news
Help - MediaWiki's Help directory
Cheat Sheet - List of the most commonly used mediawiki markup
Tables - Wikitext syntax for tables
Magic Words - Behavior switches and variables
Parser Functions - Functions meant to provide more advanced logic

Semantic Mediawiki

Semantic Mediawiki - Documentation about Semantic MediaWiki ()see lower portion of middle frame).
Semantic Forms - Documentation about Semantic Forms, which provide a form-based interface for maintaining relevant SMW pages and content.
Semantic Forms Inputs - An extension for Semantic Forms

The Step Modifications Wiki

(top bar) TOOLBOX > SPECIAL PAGES - Links to all kinds of information about The Wiki.
(top bar) WIKI > RECENT CHANGES - Links to all of the most recent edits on The Wiki.
Software used on this wiki - Software and versions with links to documentation.

HTML and CSS Resources

CSS Resource - Not all info on this page is relevant but it contains various keywords that can be used
HTML Resource - Not all info on this page is relevant but it contains various keywords that can be used

Need Help?

Private message one of these guys if you need some sort of help with The Wiki.

Primary Wiki Editors/Maintainers

Always looking for others!

Recently active wiki editors