Difference between revisions of "Wiki Editing CheatSheet"

Revision as of 10:14, 4 December 2014

This page is intended to assist editors of the SmartSimple Wiki make revisions and additions.

Remember these basic best practices for building your Wiki page:

• Make it brief.
• 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.

Text Formatting

* Bulleted Text

* Bulleted Text

Bold Text

'''Bold Text'''

Italicized Text

''Italicized Text''

Adding^Superscript

^superscript

Adding_Subscript

_subscript

#Numbered...

1. ...Series

#Numbered...
#...Series

Preformatted text

Use <pre></pre> tags.
 
In order to use word wrapping, use the following: 

<pre style="white-space: pre-wrap; 
 white-space: -moz-pre-wrap; 
 white-space: -pre-wrap; 
 white-space: -o-pre-wrap; 
 word-wrap: break-word;">
 This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer.
 </pre>

For more info, go to MediaWiki Help: Formatting

Heading Levels

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

• Level 1 is the Page Name.
• An article with four or more headings automatically creates a table of contents.

For more info, go to MediaWiki Help: Formatting

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__).

For more info, go to MediaWiki Manual: Table of contents or MediaWiki Help: Magic words

Hyperlinks

Links to Internal Pages

To add a link to Main Page:

[[Main Page]]

To add a link to Main Page which displays as different text:

[[Main Page|different text]]

Links to External Pages

To add a link to www.smartsimple.com

http://www.smartsimple.com

To add a link to www.smartsimple.com with a different label

[http://www.smartsimple.com different label]

For more info, go to MediaWiki Help: Links

Image Files

1. Under the toolbox, click Upload file.
2. Upload the image.
3. On the page you wish to display the image: enter this format:

[[File:example.jpg|link=|caption|50px]]

• link= removes the link to the image file. If you want the image to link to a page, add link=Page Name without brackets.
• caption is optional.
• You can specify the width in pixels of the image by adding an argument such as 50px.

Image linked to external link

[[File:Who-is-using-btn.png|330px|link=http://www.smartsimple.com/collaborators-online.html]]

Image linked to internal link

[[File:thumbnail-blue-white.jpg|400px|link=Blue and White]]

For more info, go to MediaWiki Help: Images

Tables

Syntax

Example

This...

{| border="1"
|'''Menu or Application'''
|'''Search For'''
|-
|Organization, Search People
|People: internal and external, related companies, standard and custom fields.
|-
|Communications, Contacts
|External people only - limited search capabilities.
|-
|[[Universal Tracking Application]] > Contact Tab
|Same page as the ''Search People'' page.
|-
|[[Universal Tracking Application]] > Company Tab
|Same functionality as the ''Search People'' page, but with companies.
|-
|Sales Tracking Application > Company Tab
|Same page as the Company tab in the [[UTA]]
|-
|Sales Tracking Application > Contacts Tab
|Same page as the ''Search People'' page
|-
|Sales Tracking Application > My Contacts
|Limited to contacts associated with companies where the current user is the owner.
|}

...produces this...

Example of Aligning Text

This...

{|
! align="left"| Item
! Amount
! Cost
|-
|Orange
|10
|7.00
|-
|Butter
|1
|5.00
|-
!Total
|
|12.00
|}

...produces this...

For more info, go to MediaWiki Help: Tables

Categories

Adding a Category to a Page

[[Category:Help]]

Adding a Category to a Page with a Different Label

[[Category:Help|Help category]]

Adding a Link to a Category Page

[[:Category:Help|Help category]]

For more info, go to MediaWiki Help: Categories

Templates

Pages that start with the phrase "Template:" can be used in a similar fashion to SmartSimple's System Variables. They can contain blocks of text, such as commonly used terms, Wiki tables and uploaded images. You should use templates if a term, table or image will be repeated across multiple pages. The template can be referenced by surrounding the template name (minus the leading "Template:" string) with {{double brackets}}.

Example Templates

• {{UTA}} - returns
• {{GUA}} - returns Global User Administrator
• {{LUA}} - returns Local User Administrator
• {{XML}} - returns XML custom field
• {{ROSV}} - returns Read Only – System Variables
• {{WPV}} - returns Web Page View
• {{l1}} - returns Level 1
• {{l2}} - returns Level 2
• {{CopyIcon}} - returns

How to Add a User to Wiki:

• On left panel, click on Special pages
• Under Login / create account, click on Create account
• Fill in details and send random password
• On left panel, click on Special pages again
• Under Users and rights, click on User rights management
• Type in username, click on Edit user groups
• Add administrator, bureaucrat and smartstaff groups, click on Save user groups