Difference between revisions of "Wiki Editing CheatSheet"

From SmartWiki
Jump to: navigation, search
(→‎Example)
(→‎Links to External Pages)
 
(59 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
This page is intended to assist editors of the SmartSimple Wiki please refer to this page before you make revisions and additions.
+
=Overview=
 +
SmartSimple’s Wiki is a repository of knowledge targeted at system Administrators intended to help make learning and configuring easier. This page will provide guidance for anyone who is contributing to the wiki. Following established standards will improve the user experience of this Wiki. All new articles should follow the template found in google drive > shared drives > Wiki project or look at the below. For statistics you can look at the dashboards and https://wiki.smartsimple.com/wiki/Special:SpecialPages
  
−
'''Follow these practices for building your Wiki page:'''
+
==Wiki article structure==
 +
All wiki articles should follow this format:
  
−
* [http://www.bartleby.com/141/strunk5.html Make it brief.]
+
===Overview===
−
* Add [[Wiki_Editing_CheatSheet#Hyperlinks|hyperlinks]] to other pages where SmartSimple's terminology is used.
+
Answer the following questions
−
* Add an [[Wiki_Editing_CheatSheet#Image_Files|image]] of the subject(s) of the article.
 
−
* Add a "[[Arcadia_-_Level_1_Summary_(matrix)_Settings#See_Also|See Also]]" section with related articles that may or may not have been mentioned in the text.
 
−
* Put your page under one or more [[Wiki_Editing_CheatSheet#Categories|Categories]].
 
  
−
More help can be found [https://www.mediawiki.org/wiki/Help:Contents mediawiki.org]
+
# What is this article about? Example: The Login page allows a user to gain access to your SmartSimple System. The user will authenticate on this page, typically by entering a username and password.
 +
# Why is this important? Example: The login page is used to: Authenticate the user, Switch languages, Direct people to a signup page, Ask the user to accept the use of cookies, enforce agreement of your systems privacy and security policies, and Reset your password.
 +
# What will the reader learn from this article? Example: This article will show you how to setup and modify login pages within your system.
 +
# Is there anything odd or important that should be noted? Example: Note: You will need global administrator access to setup or edit login pages. You will also need to create a separate login page for each language you want to support.
  
 +
===Configuration – Essentials===
 +
Break out all the tasks the majority of users will do and explain how to do them in the minimal steps possible. Use a numbered list for the tasks and keep them below 15 steps. If it is more than 15 steps to do something, break the task into multiple headers.
  
−
----
+
===Configuration - Advanced===
 +
Break out all other tasks not listed in the essentials section. This section is meant for tasks that are particularly difficult, not commonly used or tricky/cumbersome.
 +
 
 +
===Settings Explained===
 +
List all the settings used by this page/feature, what the setting does and if not self evident why you would use it. This should be presented in a table format. In time this may be replaced by an in system help.
 +
 
 +
===Category===
 +
Make sure every article has a category. This way it is easy to find all related pages. Ideally all articles should be in one of the categories found on the home page https://wiki.smartsimple.com/wiki/Main_Page. This way anyone entering the wiki for the first time can find all the good articles. If an article falls into more than one category that is ok.
 +
 
 +
===Other considerations===
 +
* Use US English for spelling.
 +
* Use [https://docs.microsoft.com/en-us/style-guide/procedures-instructions/formatting-text-in-instructions Microsoft conventions] for writing instructions (When you refer to a button, check box, or other option, use bold formatting for the name)
 +
 
 +
{| class="wikitable"
 +
|-
 +
||Correct
 +
||Select '''Save'''
 +
|-
 +
||Incorrect Select
 +
||"save"
 +
|}
 +
 
 +
Note more help about the mediawiki can be found [https://www.mediawiki.org/wiki/Help:Contents mediawiki.org]
  
 
==Text Formatting==
 
==Text Formatting==
Line 57: Line 83:
  
 
===Preformatted text===
 
===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.
+
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 code examples of what to type into the wiki. The pre stands for preformatted text. This will preserve the formatting of the text you entered (example tab, double spaces, new lines). Currently you cannot add code that has a closing tag < / > inside a pre as the slash will close the pre. We have tried other syntax such as nowiki and code but they all seem to exhibit the same issues after you save, edit then save again. The pre tag is not to be used for emphasis or notes.
  
−
<pre>your code goes here</pre>
+
<pre>your code goes here
 +
double space  double space
 +
tab tab tab
 +
</pre>
  
 
==Heading Levels==
 
==Heading Levels==
Line 93: Line 122:
  
 
<pre>[[Branding|Different text]]</pre>
 
<pre>[[Branding|Different text]]</pre>
 +
 +
Link to a heading on the same page
 +
 +
[[#Heading Levels|Heading Levels]]
 +
 +
<pre>[[#Heading Levels|Heading Levels]]</pre>
  
 
===Links to External Pages===
 
===Links to External Pages===
Line 100: Line 135:
  
 
<pre>[https://www.smartsimple.com smartsimple.com]</pre>
 
<pre>[https://www.smartsimple.com smartsimple.com]</pre>
 +
  
 
Note:
 
Note:
Line 105: Line 141:
 
* You must specify text for the link or it will show up as a number.
 
* You must specify text for the link or it will show up as a number.
 
* All external links open in a new window.
 
* All external links open in a new window.
 +
 +
===Email Links===
 +
 +
[mailto:sales@smartsimple.com sales@smartsimple.com]
 +
 +
<pre>[mailto:sales@smartsimple.com sales@smartsimple.com]</pre>
  
 
==Image Files==
 
==Image Files==
Line 110: Line 152:
 
# Press the '''Choose File''' button to select an image and press '''Open'''.
 
# Press the '''Choose File''' button to select an image and press '''Open'''.
 
# Press the '''Upload File''' button
 
# Press the '''Upload File''' button
 +
 +
Note:
 +
When adding screenshots, they should be approximately 1280 pixels wide and displayed at 800 pixels wide.
 +
When naming images, it is suggested to use the ticket number dash year dash number. That way it is easy to identify the related enhancement ticket and to see if the screenshot is out of date.
  
  
 
To display an image
 
To display an image
−
[[File:a11y-disability.png|thumb|none|500px|The four disability classifications]]
+
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|800px|The four disability classifications]]
  
−
<pre>[[File:a11y-disability.png|thumb|none|500px|The four disability classifications]]</pre>
+
<pre>[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|800px|The four disability classifications]]</pre>
  
−
Images are uploaded at a resolution of 800 pixels but displayed at 500px.
+
Images are uploaded at a resolution of 1280 pixels but displayed at 800px.
 
Make sure you add a caption.
 
Make sure you add a caption.
 +
  
 
Image with internal link
 
Image with internal link
−
[[File:a11y-disability.png|thumb|none|link=Accessibility|500px|The four disability classifications]]
+
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=Accessibility|800px|The four disability classifications]]
  
−
<pre>[[File:a11y-disability.png|thumb|none|500px|The four disability classifications|link=Accessibility]]</pre>
+
<pre>[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=Accessibility|800px|The four disability classifications]]</pre>
  
 
Image with external link
 
Image with external link
−
[[File:a11y-disability.png|thumb|none|link=https://www.smartsimple.com/agreements.html|500px|The four disability classifications]]
+
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=https://www.smartsimple.com/agreements.html|800px|The four disability classifications]]
  
−
<pre>[[File:a11y-disability.png|thumb|none|500px|The four disability classifications|link=https://www.smartsimple.com/agreements.html]]</pre>
+
<pre>[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=https://www.smartsimple.com/agreements.html|800px|The four disability classifications]]</pre>
 +
 
 +
You can upload a new version of any file by typing '''File:''' then your desired file name into the search.
 +
 
 +
==Other Files==
 +
You can also upload files such as a zip file by entering the following and if it does not exist click on the link to upload the file:
 +
 
 +
[[File:website-portal-sample-images.zip]]
 +
 
 +
<pre>[[File:website-portal-sample-images.zip]]</pre>
  
 
==Tables==
 
==Tables==
Line 163: Line 219:
  
 
===Example===
 
===Example===
−
 
−
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
Line 192: Line 246:
  
 
==Categories==
 
==Categories==
−
===Adding a Category to a Page===
+
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.
−
<nowiki>[[Category:Help]]</nowiki>
+
 
 +
<pre>[[Category:Interface]]</pre>
  
−
===Adding a Category to a Page with a Different Label===
 
−
<nowiki>[[Category:Help|Help category]]</nowiki>
 
  
 
===Adding a Link to a Category Page===
 
===Adding a Link to a Category Page===
−
<nowiki>[[:Category:Help|Help category]]</nowiki>
+
[[:Category:Interface|Interface]]
  
−
For more info, go to [http://www.mediawiki.org/wiki/Help:Categories MediaWiki Help: Categories]
+
<pre>[[:Category:Interface|Interface]]</pre>
  
 
==Templates==
 
==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 <nowiki>{{double brackets}}</nowiki>.
+
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.
 +
 
 +
<pre>{{ DeprecatedPage }}</pre>
 +
 
 +
To find or edit a templates type '''template:''' then your desired template name into the search.
 +
 
 +
When you edit a template at the bottom of the page you can see a list of pages that are using that template. Make sure you remove the template from those pages before you delete a template.
 +
 
 +
==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. 
  
−
===Example Templates===
+
2. Select '''Move. '''
−
* <nowiki>{{UTA}}</nowiki> - returns {{UTA}}
+
 
−
* <nowiki>{{GUA}}</nowiki> - returns {{GUA}}
+
3. Select the page's new category from the right drop-down field box. 
−
* <nowiki>{{LUA}}</nowiki> - returns {{LUA}}
+
 
−
* <nowiki>{{XML}}</nowiki> - returns {{XML}}
+
4. Ensure that the '''Leave a redirect behind '''option is selected so that you will not lose continuity between hyperlinks. 
−
* <nowiki>{{ROSV}}</nowiki> - returns {{ROSV}}
+
 
−
* <nowiki>{{WPV}}</nowiki> - returns {{WPV}}
+
5. Click '''Move Page.'''
−
* <nowiki>{{l1}}</nowiki> - returns {{l1}}
+
 
−
* <nowiki>{{l2}}</nowiki> - returns {{l2}}
+
==How to Add a User to the Wiki:==
−
* <nowiki>{{CopyIcon}}</nowiki> - returns {{CopyIcon}}
+
* On left panel, click on '''User Manager'''.
 +
* Click the green Add button.
 +
* Add '''smartstaff''' group.
 +
* Click '''OK'''.
 +
 
 +
==Deleting Articles==
 +
# Before you delete an article use the tool in the left navigation called '''what links here'''.
 +
# Once you have removed the links go to the '''More''' menu top right and select delete.
 +
# Make sure you delete all pages no longer required.
 +
# Delete the category the pages are grouped in if that is no longer needed.
 +
# Do a Search top right to make sure the content is not found on other pages.
 +
 
 +
==Finding Broken Links==
 +
When articles are deprecated or deleted, or the name is changed, it may result in broken links. You can see a list of broken links by going to https://wiki.smartsimple.com/index.php?title=Special:BrokenRedirects
  
−
==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''
 
  
  
 
[[Category:SmartSimple]]
 
[[Category:SmartSimple]]
 +
 +
[[aitranscriptgpttest]]

Latest revision as of 14:23, 18 January 2024

Overview

SmartSimple’s Wiki is a repository of knowledge targeted at system Administrators intended to help make learning and configuring easier. This page will provide guidance for anyone who is contributing to the wiki. Following established standards will improve the user experience of this Wiki. All new articles should follow the template found in google drive > shared drives > Wiki project or look at the below. For statistics you can look at the dashboards and https://wiki.smartsimple.com/wiki/Special:SpecialPages

Wiki article structure

All wiki articles should follow this format:

Overview

Answer the following questions

  1. What is this article about? Example: The Login page allows a user to gain access to your SmartSimple System. The user will authenticate on this page, typically by entering a username and password.
  2. Why is this important? Example: The login page is used to: Authenticate the user, Switch languages, Direct people to a signup page, Ask the user to accept the use of cookies, enforce agreement of your systems privacy and security policies, and Reset your password.
  3. What will the reader learn from this article? Example: This article will show you how to setup and modify login pages within your system.
  4. Is there anything odd or important that should be noted? Example: Note: You will need global administrator access to setup or edit login pages. You will also need to create a separate login page for each language you want to support.

Configuration – Essentials

Break out all the tasks the majority of users will do and explain how to do them in the minimal steps possible. Use a numbered list for the tasks and keep them below 15 steps. If it is more than 15 steps to do something, break the task into multiple headers.

Configuration - Advanced

Break out all other tasks not listed in the essentials section. This section is meant for tasks that are particularly difficult, not commonly used or tricky/cumbersome.

Settings Explained

List all the settings used by this page/feature, what the setting does and if not self evident why you would use it. This should be presented in a table format. In time this may be replaced by an in system help.

Category

Make sure every article has a category. This way it is easy to find all related pages. Ideally all articles should be in one of the categories found on the home page https://wiki.smartsimple.com/wiki/Main_Page. This way anyone entering the wiki for the first time can find all the good articles. If an article falls into more than one category that is ok.

Other considerations

  • 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)
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 code examples of what to type into the wiki. The pre stands for preformatted text. This will preserve the formatting of the text you entered (example tab, double spaces, new lines). Currently you cannot add code that has a closing tag < / > inside a pre as the slash will close the pre. We have tried other syntax such as nowiki and code but they all seem to exhibit the same issues after you save, edit then save again. The pre tag is not to be used for emphasis or notes. 

your code goes here
double space  double space
tab 	tab	tab

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]]

Link to a heading on the same page

Heading Levels 

[[#Heading Levels|Heading Levels]]

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.

Email Links

sales@smartsimple.com 

[mailto:sales@smartsimple.com sales@smartsimple.com]

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

Note: When adding screenshots, they should be approximately 1280 pixels wide and displayed at 800 pixels wide. When naming images, it is suggested to use the ticket number dash year dash number. That way it is easy to identify the related enhancement ticket and to see if the screenshot is out of date.


To display an image

four images of disabilities
The four disability classifications
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|800px|The four disability classifications]]

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


Image with internal link

four images of disabilities
The four disability classifications
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=Accessibility|800px|The four disability classifications]]

Image with external link

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

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

Other Files

You can also upload files such as a zip file by entering the following and if it does not exist click on the link to upload the file:

File:Website-portal-sample-images.zip 

[[File:website-portal-sample-images.zip]]

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.

When you edit a template at the bottom of the page you can see a list of pages that are using that template. Make sure you remove the template from those pages before you delete a template.

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 the Wiki:

  • On left panel, click on User Manager.
  • Click the green Add button.
  • Add smartstaff group.
  • Click OK.

Deleting Articles

  1. Before you delete an article use the tool in the left navigation called what links here.
  2. Once you have removed the links go to the More menu top right and select delete.
  3. Make sure you delete all pages no longer required.
  4. Delete the category the pages are grouped in if that is no longer needed.
  5. Do a Search top right to make sure the content is not found on other pages.

Finding Broken Links

When articles are deprecated or deleted, or the name is changed, it may result in broken links. You can see a list of broken links by going to https://wiki.smartsimple.com/index.php?title=Special:BrokenRedirectsaitranscriptgpttest

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Wiki_Editing_CheatSheet&oldid=42169’