Guide:Wiki Maintenance: Difference between revisions
m (→Creating Pages) |
mNo edit summary |
||
Line 114: | Line 114: | ||
= Page Management = | = Page Management = | ||
== Creating Pages == | === Creating Pages === | ||
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 <code>https://stepmodifications.org/wiki/</code> and hitting the <kbd>Enter</kbd> 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: | 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 <code>https://stepmodifications.org/wiki/</code> and hitting the <kbd>Enter</kbd> 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: | ||
# In the URL type <code><nowiki>https://stepmodifications.org/wiki/User:YourUserName</nowiki></code> | # In the URL type <code><nowiki>https://stepmodifications.org/wiki/User:YourUserName</nowiki></code> | ||
Line 120: | Line 120: | ||
# To create the page, either click the "create this page" link in the displayed text or click the <i class="fas fa-asterisk hltx p-1"></i> icon on the navigation bar. Note that to save, there must be content in the editor box. | # To create the page, either click the "create this page" link in the displayed text or click the <i class="fas fa-asterisk hltx p-1"></i> icon on the navigation bar. Note that to save, there must be content in the editor box. | ||
== Edit/Delete/Move/Rename == | === Edit/Delete/Move/Rename === | ||
=== Delete a Page === | ==== Delete a Page ==== | ||
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: | 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: | ||
# 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. | ||
Line 129: | Line 129: | ||
# Click the {{ui|Delete page}} button. | # Click the {{ui|Delete page}} button. | ||
=== Move/Rename a Page === | ==== 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: | 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. | ||
Line 140: | Line 140: | ||
# Click the {{Ui|Move page}} button. | # Click the {{Ui|Move page}} button. | ||
==== Categories ==== | |||
=== 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 <code>[[Category:<CatName>]]</code> 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: <code>[[:Category:<CatName>]]</code>. Users are asked to: | 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 <code>[[Category:<CatName>]]</code> 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: <code>[[:Category:<CatName>]]</code>. Users are asked to: | ||
* Read about [https://www.mediawiki.org/wiki/Help:Categories how to use categories]. | * Read about [https://www.mediawiki.org/wiki/Help:Categories how to use categories]. | ||
Line 148: | Line 147: | ||
* Place the category code at the TOP of the page for consistency and to make it easy for other users to find. | * Place the category code at the TOP of the page for consistency and to make it easy for other users to find. | ||
== Using Forms == | === Using Forms === | ||
Placeholder. | Placeholder. | ||
= Formatting = | = Formatting = | ||
== General Formatting Tips == | === General Formatting Tips === | ||
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 ==== | ||
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 [https://www.mediawiki.org/wiki/Help:Magic_words MediaWiki website.] | 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 [https://www.mediawiki.org/wiki/Help:Magic_words MediaWiki website.] | ||
==== Common Magic Words ==== | ====== Common Magic Words ====== | ||
: {| class="wikitable" | : {| class="wikitable" | ||
! <nowiki>__NOTOC__</nowiki> | ! <nowiki>__NOTOC__</nowiki> | ||
Line 178: | Line 177: | ||
= Advanced = | = Advanced = | ||
== Inline Styling == | === Inline Styling === | ||
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. | 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 === | ==== HTML ==== | ||
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 [https://meta.wikimedia.org/wiki/Help:HTML_in_wikitext permitted list]. It's always preferable to use [https://www.mediawiki.org/wiki/Help:Formatting wiki markup]. | 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 [https://meta.wikimedia.org/wiki/Help:HTML_in_wikitext permitted list]. It's always preferable to use [https://www.mediawiki.org/wiki/Help:Formatting wiki markup]. | ||
=== CSS === | ==== CSS ==== | ||
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 [https://www.w3schools.com/bootstrap4/bootstrap_ref_all_classes.asp Bootstrap's list of classes] as a first reference for any necessary inline styling deviation ''before'' moving on to completely custom edits. | 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 [https://www.w3schools.com/bootstrap4/bootstrap_ref_all_classes.asp Bootstrap's list of classes] as a first reference for any necessary inline styling deviation ''before'' moving on to completely custom edits. | ||
== HeaderTabs == | === HeaderTabs === | ||
Use of [https://www.mediawiki.org/wiki/Extension:Header_Tabs 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. | Use of [https://www.mediawiki.org/wiki/Extension:Header_Tabs 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 == | === Tables === | ||
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 [https://www.mediawiki.org/wiki/Help:Tables MediaWiki documentation]. | 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 [https://www.mediawiki.org/wiki/Help:Tables MediaWiki documentation]. | ||
* The standard "wikitable" class has been customized to work with our site and is preferred. | * The standard "wikitable" class has been customized to work with our site and is preferred. | ||
Line 196: | Line 195: | ||
= Wiki Templates = | = Wiki Templates = | ||
== Templates Explained == | === Templates Explained === | ||
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 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. | ||
Line 217: | Line 216: | ||
= Moderated Content = | = Moderated Content = | ||
== Moderated Content Overview == | === Moderated Content Overview === | ||
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. | 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 === | ==== Namespaces ==== | ||
There are several namespaces on the Wiki that are restricted to specific user groups. These include: | There are several namespaces on the Wiki that are restricted to specific user groups. These include: | ||
* Project | * Project | ||
Line 226: | Line 225: | ||
* Template | * Template | ||
=== Guides === | ==== Guides ==== | ||
The Wiki is home to many [[:Category:Guides|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. | The Wiki is home to many [[:Category:Guides|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... | Following are some basic standards for guides... | ||
==== Guide Standard Header ==== | ====== Guide Standard Header ====== | ||
Use the [[:Template:PageTitle]]. | Use the [[:Template:PageTitle]]. | ||
Line 262: | Line 261: | ||
<headertabs /> | <headertabs /> | ||
== Need Help? == | === Need Help? === | ||
For help using this wiki, to offer up suggestions, or to report problems, post on the [https://stepmodifications.org/forum/forum/15-wiki-support/ Wiki Support forum], or private message one of us. | For help using this wiki, to offer up suggestions, or to report problems, post on the [https://stepmodifications.org/forum/forum/15-wiki-support/ Wiki Support forum], or private message one of us. | ||
Revision as of 19:16, July 2, 2021
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.
Need Help?
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
Always looking for others!