Difference between revisions of "Wiki Editing CheatSheet"

Revision as of 13:30, 4 June 2019 (view source) Mark Bridger (talk | contribs) (→‎Text Formatting) ← Older edit		Revision as of 10:22, 5 July 2019 (view source) Mark Bridger (talk | contribs) (→‎Example) Newer edit →
Line 133:		Line 133:
	===Example===		===Example===
−	This...	+	This
−	<nowiki>{| border="1"</nowiki>	+	<nowiki>{| class="wikitable"
−	<nowiki>|'''Menu or Application'''</nowiki>	+	<nowiki>|-
−	<nowiki>|'''Search For'''</nowiki>	+	<nowiki>!|Link Type
−	<nowiki>|-</nowiki>	+	<nowiki>!|Description
−	<nowiki>|Organization, Search People</nowiki>	+	<nowiki>|-
−	<nowiki>|People: internal and external, related companies, standard and custom fields.</nowiki>	+	<nowiki>||Organization Profile
−	<nowiki>|-</nowiki>	+	<nowiki>||
−	<nowiki>|Communications, Contacts</nowiki>	+	<nowiki>This link type takes the user to their organization profile. By default, if you have permission to edit the profile you will be taken directly into edit mode. You can toggle off this setting if you want to bring everyone to the profile in view mode.
−	<nowiki>|External people only - limited search capabilities.</nowiki>	+	<nowiki>|-
−	<nowiki>|-</nowiki>	+	<nowiki>||Custom
−	<nowiki>|[[Universal Tracking Application]] > Contact Tab</nowiki>	+	<nowiki>||This link type can take the user to any page within your system, for example, to go to the dashboards, enter “/iface/dashboard.jsp”. Note, always use relative URLs to ensure links work across servers and to ensure your system functions as expected.
−	<nowiki>|Same page as the ''Search People'' page.</nowiki>	+	<nowiki>|-
−	<nowiki>|-</nowiki>	+	<nowiki>|}
−	<nowiki>|[[Universal Tracking Application]] > Company Tab</nowiki>
−	<nowiki>|Same functionality as the ''Search People'' page, but with companies.</nowiki>
−	<nowiki>|-</nowiki>
−	<nowiki>|Sales Tracking Application > Company Tab</nowiki>
−	<nowiki>|Same page as the Company tab in the [[UTA]]</nowiki>
−	<nowiki>|-</nowiki>
−	<nowiki>|Sales Tracking Application > Contacts Tab</nowiki>
−	<nowiki>|Same page as the ''Search People'' page</nowiki>
−	<nowiki>|-</nowiki>
−	<nowiki>|Sales Tracking Application > My Contacts</nowiki>
−	<nowiki>|Limited to contacts associated with companies where the current user is the owner.</nowiki>
−	<nowiki>|}</nowiki>
	...produces this...		...produces this...
−	{| border="1"	+	{| class="wikitable"
−	|'''Menu or Application'''
−	|'''Search For'''
	|-		|-
−	|Organization, Search People	+	!|Link Type
−	|People: internal and external, related companies, standard and custom fields.	+	!|Description
	|-		|-
−	|Communications, Contacts	+	||Organization Profile
−	|External people only - limited search capabilities.	+	||
−	|-	+	This link type takes the user to their organization profile. By default, if you have permission to edit the profile you will be taken directly into edit mode. You can toggle off this setting if you want to bring everyone to the profile in view mode.
−	|[[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	+	||Custom
−	|Same page as the ''Search People'' page	+	||This link type can take the user to any page within your system, for example, to go to the dashboards, enter “/iface/dashboard.jsp”. Note, always use relative URLs to ensure links work across servers and to ensure your system functions as expected.
	|-		|-
−	|Sales Tracking Application > My Contacts
−	|Limited to contacts associated with companies where the current user is the owner.
	|}		|}

---

Revision as of 10:22, 5 July 2019

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

<sup>superscript</sup>

Adding_Subscript

_subscript

#Numbered...

1. ...Series

#Numbered...
#...Series

Preformatted text

Use @@@PRE1@@@ tags.
 
In order to use word wrapping, use the following: 

@@@PRE2@@@

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]

Note: All external links are currently set to open in a new window.

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:

Image no link with caption

[[File:imgname.png|thumb|none|500px|Caption for under the image]]

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

{|	table start
|+	table caption, optional; only between table start and first table row
|-	table row, optional on first row -- wiki engine assumes the first row
!	table header cell, optional. Consecutive table header cells may be added on same line separated by double marks (!!) or start on new lines, each with its own single mark (!).
|	table data cell, required! Consecutive table data cells may be added on same line separated by double marks (||) or start on new lines, each with its own single mark (|).
|}	table end

Example

This

{| class="wikitable" <nowiki>|- <nowiki>!|Link Type <nowiki>!|Description <nowiki>|- <nowiki>||Organization Profile <nowiki>|| <nowiki>This link type takes the user to their organization profile. By default, if you have permission to edit the profile you will be taken directly into edit mode. You can toggle off this setting if you want to bring everyone to the profile in view mode. <nowiki>|- <nowiki>||Custom <nowiki>||This link type can take the user to any page within your system, for example, to go to the dashboards, enter “/iface/dashboard.jsp”. Note, always use relative URLs to ensure links work across servers and to ensure your system functions as expected. <nowiki>|- <nowiki>|} ...produces this... {| class="wikitable" |- !|Link Type !|Description |- ||Organization Profile || This link type takes the user to their organization profile. By default, if you have permission to edit the profile you will be taken directly into edit mode. You can toggle off this setting if you want to bring everyone to the profile in view mode. |- ||Custom ||This link type can take the user to any page within your system, for example, to go to the dashboards, enter “/iface/dashboard.jsp”. Note, always use relative URLs to ensure links work across servers and to ensure your system functions as expected. |- |} ===Example of Aligning Text=== This... <nowiki>{|

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

...produces this...

Item	Amount	Cost
Orange	10	7.00
Butter	1	5.00
Total		12.00

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