Guide:Wiki Maintenance: Difference between revisions
From Step Mods | Change The Game
mNo edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__[[Category:Reference]][[Category:Administration]]{{PageTitle|logo=delta|title=Step Wiki User Guide|subtitle=Standards and tips for editing the Step wiki|author=Step Modifications|forumtid=5020}} | __NOTOC__[[Category:Reference]][[Category:Administration]][[Category:How-To Guides]]{{PageTitle|logo=delta|title=Step Wiki User Guide|subtitle=Standards and tips for editing the Step wiki|author=Step Modifications|forumtid=5020}} | ||
<blockquote class="blockquote">'''Definition of a wiki:'''<br> | <blockquote class="blockquote">'''Definition of a wiki:'''<br> | ||
: "...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> | ||
Line 6: | Line 6: | ||
== Maintenance Sections == | == Maintenance Sections == | ||
Standards for mod pages | |||
= Best Practices = | = Best Practices = | ||
Line 88: | Line 88: | ||
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: | 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: | ||
# Click on the <i class="fas fa-ellipsis-h hltx"></i> icon on the navigation bar. | # Click on the <i class="fas fa-ellipsis-h hltx"></i> icon on the navigation bar. | ||
# Click {{ | # Click {{Ui|Move}} | ||
# On the form under ''New title'', select the namespace from the dropdown box (this typically matches the original namespace). | # On the form under ''New title'', select the namespace from the dropdown box (this typically matches the original namespace). | ||
# Under that within the input box, type the page name of the page. | # Under that within the input box, type the page name of the page. | ||
Line 94: | Line 94: | ||
# Within the input box under ''Reason'', provide a short explanation why the page is being moved. | # Within the input box under ''Reason'', provide a short explanation why the page is being moved. | ||
# Ensure the boxes are ticked for '''Move associated talk page''' and '''Leave a redirect behind'''. | # Ensure the boxes are ticked for '''Move associated talk page''' and '''Leave a redirect behind'''. | ||
# Click the {{ | # Click the {{Ui|Move page}} button. | ||
== Using Forms == | == Using Forms == | ||
Line 106: | Line 106: | ||
=== Writing Style === | === 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: | 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 ..."}} | ||
=== Magic Words === | === Magic Words === | ||
Line 120: | Line 120: | ||
! <nowiki>{{FULLPAGENAME}}</nowiki> | ! <nowiki>{{FULLPAGENAME}}</nowiki> | ||
| Prints the Namespace and full page Title (including all subpage levels).<br>'''Result:''' <code>Guide:DDSopt/DDSopt_INI</code> | | Prints the Namespace and full page Title (including all subpage levels).<br>'''Result:''' <code>Guide:DDSopt/DDSopt_INI</code> | ||
|- | |||
! <nowiki>{{NAMESPACE}}</nowiki> | |||
| Prints the Namespace.<br>'''Result:''' <code>Guide</code> | |||
|- | |- | ||
! <nowiki>{{PAGENAME}}</nowiki> | ! <nowiki>{{PAGENAME}}</nowiki> | ||
Line 128: | Line 131: | ||
|} | |} | ||
=== Instruction Sets === | === Instruction Sets === | ||
Follow these guidelines when writing instructions: | Follow these guidelines when writing instructions: | ||
Line 150: | 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. | ||
=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 {{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 ... | |||
* 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> | |||
* DO NOT use Template calls other than {{Fomod}} | |||
= Advanced Formatting = | = Advanced Formatting = |
Revision as of 17:58, 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
Standards for mod pages
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!
- z929669
- DoubleYou (MO & STEP Guides primarily)
- TechAngel85