Guide:Wiki Maintenance: Difference between revisions
From Step Mods | Change The Game
mNo edit summary |
mNo edit summary |
||
Line 3: | Line 3: | ||
: "...a website or database developed collaboratively that allows users to add, delete, or revise content by using a web browser."</blockquote> | : "...a website or database developed collaboratively that allows users to add, delete, or revise content by using a web browser."</blockquote> | ||
The Step Modifications wiki is intended to be | The Step Modifications wiki is intended to be community-maintained. Only community members are able to edit the wiki. To become a member, register on the Step forums using the "Sign Up" button at the upper right of the [https://stepmodifications.org/forum forum home]. 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. | ||
== Step Wiki Maintenance == | == Step Wiki Maintenance == | ||
Line 14: | Line 14: | ||
= Editing & Markup = | = Editing & Markup = | ||
* | === Writing Style === | ||
When writing content outside of the userspace, the [https://en.wikipedia.org/wiki/Grammatical_person 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: | |||
* {{Fc|red|First person: "I first must click on the 'edit' button ..."}} | |||
* {{Fc|red|Second person: "You first must click on the 'edit' button ..."}} | |||
* {{Fc|green|Third person: "First, click on the 'edit' button ..."}} | |||
=== 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. | |||
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 ... | |||
=== 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. | |||
** Simple corrections to grammar do not require any special notification or mentions on the forum or Talk page. | |||
=== Instruction Sets === | |||
Follow these guidelines when writing instructions: | |||
* When instructing a user to 'click' or 'select' any UI element: use the [[:Template:Ui|Ui]] template, as in the following example: | |||
**<code><nowiki>Click {{ui|Edit}}, then right click {{ui|some UI element}} ...</nowiki></code> | |||
**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. | |||
* 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: | |||
**<code><nowiki>{{fc|important|'''First Topic Name.'''}} This paragraph explains the first topic. Other paragraphs will have their own in-line headers and explanations.</nowiki></code> | |||
**{{fc|important|'''First Topic Name.'''}} This paragraph explains the first topic. Other paragraphs will have their own in-line headers and explanations. | |||
**[https://stepmodifications.org/wiki/Guide:DDSopt#Main_Menu_Setting_Descriptions Working Example] | |||
=== Symbols === | |||
Basic symbols can be displayed by inserting its hex code into the text. Users can [https://www.toptal.com/designers/htmlarrows/symbols/ search for symbols] and use its hex code to produce the symbol on the page, | |||
: like so: → | |||
==== Font Awesome ==== | |||
The Wiki supports [https://fontawesome.com/ Font Awesome] and users can [https://fontawesome.com/v5.15/how-to-use/on-the-web/referencing-icons/basic-use insert any of the free icons] from this ''awesome'' source directly into the wiki page, | |||
: like so: <i class="fas fa-long-arrow-alt-right"></i> | |||
=== 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. | |||
=== DO NOT === | |||
* DO NOT use inline styling like the following: | |||
*: <syntaxhighlight lang="HTML"><span style="color: #ff0"></span></syntaxhighlight> | *: <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): | *: 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> | *: <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. | ||
** Instead use [https://www.mediawiki.org/wiki/Help:Formatting wiki markup] and/or the [[Template:Fs|Fs]] template | ** Instead use [https://www.mediawiki.org/wiki/Help:Formatting wiki markup] and/or the [[Template:Fs|Fs]] template. | ||
=Mod Pages= | =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]]. | 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.}} | ||
When adding/editing Mod Recommendations ... | {{Fc|instruction|When adding/editing Mod Recommendations ...}} | ||
* Keep it basic and | * 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 | * 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. | ||
Line 93: | Line 130: | ||
== Edit/Delete/Move/Rename == | == Edit/Delete/Move/Rename == | ||
=== Delete a Page === | === Delete a Page === | ||
Line 125: | Line 157: | ||
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> | ||
Like the cheat-sheet... | Like the cheat-sheet... | ||
=== Magic Words === | === Magic Words === | ||
Line 152: | Line 178: | ||
| Prints the subpage Title of the current page. If not a subpage, defaults to <nowiki>{{PAGENAME}}</nowiki> behavior.<br>'''Result:''' <code>DDSopt_INI</code> | | Prints the subpage Title of the current page. If not a subpage, defaults to <nowiki>{{PAGENAME}}</nowiki> behavior.<br>'''Result:''' <code>DDSopt_INI</code> | ||
|} | |} | ||
= Advanced = | = Advanced = |
Revision as of 14:52, 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 community-maintained. Only community members are able to edit the wiki. To become a member, register on the Step forums using the "Sign Up" button at the upper right of the forum home. 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.
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