Guide:Wiki Maintenance: Difference between revisions
From Step Mods | Change The Game
TechAngel85 (talk | contribs) |
TechAngel85 (talk | contribs) No edit summary |
||
Line 38: | Line 38: | ||
=== 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. | ||
= Page Management = | = Page Management = | ||
Line 139: | Line 91: | ||
=== Using Forms === | === Using Forms === | ||
Placeholder. | Placeholder. | ||
= Formatting Basics = | |||
This will hold the dos, donts and good habits with formatting but be focus on where to look for the info.<br /> | |||
Like the cheatsheet... | |||
== General Formatting Tips == | |||
=== 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 ..."}} | |||
== Specific Formatting Situations == | |||
=== 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 === | |||
Search for HTML symbols and use a code like "#8594;" with an ampersand "&" in front of it to produce "→" | |||
==== Font Awesome ==== | |||
The Step 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. | |||
=== 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 [https://www.w3schools.com/css/css_text.asp like such] | |||
= Wiki Templates = | |||
== Templates Explained == | |||
Templates can be found from the top "Tools" menu at ''Special Pages'' → ''Templates''<br /> | |||
[[Special:Templates|Here is a direct link]] | |||
Some of the more common Templates that are used on the STEP wiki are: | |||
{{alert|type=notice|text=The code for this is: <code><nowiki>{{alert|type=notice|text=text for the notice</nowiki></code>}} | |||
{{alert|type=warning|text=The code for this is: <code><nowiki>{{alert|type=warning|text=text for the warning</nowiki></code>}} | |||
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 [https://stepmodifications.org/wiki/Guide:Mod_Organizer Mod Organizer wiki]: | |||
<pre>{{#switchtablink:Profiles|Profiles}}</pre> | |||
YouTube videos can also be linked to with code like this: | |||
<pre>{{Video|j4ZQpzf_iAE|Mod Organizer: Introduction (by Gopher)|Gopher Explains Mod Organizer}}</pre> | |||
Here the Template name, '''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. | |||
= Moderated Content = | = Moderated Content = |
Revision as of 20:43, June 17, 2021
Wiki Maintenance 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