Wiki Editing CheatSheet

From SmartWiki
Revision as of 14:50, 8 July 2019 by Mark Bridger (talk | contribs) (Overview)

Jump to: navigation, search

Overview

This page is intended to assist editors of the SmartSimple Wiki please refer to this page before you make revisions and additions.

Follow these practices for building your Wiki page:

  • Make it brief.
  • In the overview of each article answer these 3 questions What is it? Why is it important? What will I learn in this article?
  • Add hyperlinks to other pages where SmartSimple's terminology is used.
  • Add an image of the subject(s) of the article.
  • Add a "See Also" section with related articles that may or may not have been mentioned in the text.
  • Put your page under one or more Categories.
  • Use US English for spelling.
  • Use Microsoft conventions for writing instructions (When you refer to a button, check box, or other option, use bold formatting for the name) [[1]]
Correct Select Save
Incorrect Select "save"

Note more help about the mediawiki can be found mediawiki.org

Text Formatting

Bullets

Create bullets like an unordered-list

  • Bullet 1
  • Bullet 2
* Bullet 1
* Bullet 2

Bold Text

Bold Text

'''Bold Text'''

Italicized Text

Italicized Text

''Italicized Text''

AddingSuperscript

textsuperscript

Text<sup>superscript</sup>

AddingSubscript

Textsubscript

Text<sub>subscript</sub>

#Numbered...

  1. Item
  2. Item
  3. Item
  4. Item
# Item
# Item
# Item
# Item

Preformatted text

You can have HTML or WIKI syntax appear the way you typed it by wrapping the code with an opening < and pre and > then a closing < / pre and > tag. This is used for examples of what to type into the wiki.

your code goes here

Heading Levels

Level 1 is for page name.

==level 2==
===Level 3===
====Level 4====
=====Level 5=====
======Level 6======

Tables of Contents

MediaWiki adds a table of contents at the top of the page when you have four or more headers.
To change this behavior, at the top of the page, add:

__NOTOC__ 	Hides the table of contents (TOC). 	
__FORCETOC__    Forces the table of contents to appear at its normal position (before the first header).
__TOC__ 	Places a table of contents at the word's current position (overriding __NOTOC__).

Hyperlinks

Links to Internal Pages

Link to internal page

Branding

[[Branding]]

Link to internal page with different text

Different text

[[Branding|Different text]]

Links to External Pages

Add a link to an external webpage

smartsimple.com

[https://www.smartsimple.com smartsimple.com]

Note:

  • You must specify text for the link or it will show up as a number.
  • All external links open in a new window.

Image Files

  1. Under the Global Actions, press Upload file.
  2. Press the Choose File button to select an image and press Open.
  3. Press the Upload File button


To display an image

The four disability classifications
[[File:a11y-disability.png|thumb|none|500px|The four disability classifications]]

Images are uploaded at a resolution of 800 pixels but displayed at 500px. Make sure you add a caption.


Image with internal link

The four disability classifications
[[File:a11y-disability.png|thumb|none|500px|The four disability classifications|link=Accessibility]]

Image with external link

The four disability classifications
[[File:a11y-disability.png|thumb|none|500px|The four disability classifications|link=https://www.smartsimple.com/agreements.html]]

You can upload a new version of any file by typing File: then your desired file name into the search.


Tables

Syntax

Syntax Description
{|
table start
|+
table caption, optional; only between table start and first table row
|-
table row,
!|
table header
||
table data each cell
|}
table end

Example

Sample Header Sample Header
Sample Text Sample Text
Sample Text Sample Text
{| class="wikitable"
|-
!|Sample Header
!|Sample Header
|-
||Sample Text
||Sample Text
|-
||Sample Text
||Sample Text
|-
|} 

Categories

You can categorize pages and files by adding one or more Category tags to the content text. These tags create links at the bottom of the page that take you to the list of all pages in that category, which makes it easy to browse related articles.

[[Category:Interface]]


Adding a Link to a Category Page

Interface

[[:Category:Interface|Interface]]

Templates

Anytime you repeat the same information across multiple pages use a template. For example when a page is deprecated, we display the same message across the top on each page by adding that template. This is also done for commonly used terms.

{{ DeprecatedPage }}

To find or edit a templates type template: then your desired template name into the search.

Renaming a Wiki Article

Follow these steps in order to rename an article on the Wiki without losing your original content or hyperlinks from other pages:

1. Click on the More option on the top left of the Wiki page you wish to rename. 

2. Select Move. 

3. Write your new article name in the left text box. 

4. Ensure that the Leave a redirect behind option is selected so that you will not lose continuity between hyperlinks. 

5. Click Move Page.

Moving a Wiki Article to a New Category

You can also move Wiki articles to new categories (such as making them into a Category or Template page) by using the Move function. 

1. Click on the More option on the top left of the Wiki page you wish to rename. 

2. Select Move. 

3. Select the page's new category from the right drop-down field box. 

4. Ensure that the Leave a redirect behind option is selected so that you will not lose continuity between hyperlinks. 

5. Click Move Page.

How to Add a User to Wiki:

  • On left panel, click on User manager
  • Click the green Add button
  • Add smartstaff group
  • Click ok