Changes

Jump to: navigation, search

Wiki Editing CheatSheet

1,247 bytes added, 18 January
Links to External Pages
=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 intended contributing to assist editors the wiki. Following established standards will improve the user experience of this Wiki. All new articles should follow the SmartSimple template found in google drive > shared drives > Wiki make revisions project or look at the below. For statistics you can look at the dashboards and additionshttps://wiki.smartsimple.com/wiki/Special:SpecialPages
'''Remember these basic best practices for building your ==Wiki page:'''* [http://www.bartleby.com/141/strunk5.html Make it brief.] * Add [[Wiki_Editing_CheatSheet#Hyperlinks|hyperlinks]] to other pages where SmartSimple's terminology is used. * Add an [[Wiki_Editing_CheatSheet#Image_Files|image]] of the subject(s) of the article.structure==* Add a "[[Arcadia_-_Level_1_Summary_(matrix)_Settings#See_Also|See Also]]" section with related All wiki articles that may or may not have been mentioned in the text. * Put your page under one or more [[Wiki_Editing_CheatSheet#Categories|Categories]].should follow this format:
===Overview===Answer the following questions # 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==
===Bullets===
Create bullets like an unordered-list
===* Bulleted Text===Bullet 1* Bullet 2
<pre>* Bulleted TextBullet 1* Bullet 2</pre>
==='''Bold Text'''===
'''Bold Text'''
<nowikipre>'''Bold Text'''</nowikipre>
===''Italicized Text''===
''Italicized Text''
<nowikipre>''Italicized Text''</nowikipre>
===Adding<sup>Superscript</sup>===
text<nowikisup>superscript</sup> <pre>Text<sup>superscript</sup></nowikipre>
===Adding<sub>Subscript</sub>===
Text<nowikisub>subscript</sub> <pre>Text<sub>subscript</sub></nowikipre>
===#Numbered...===
#...SeriesItem# Item# Item# Item
<nowikipre>#Numbered...</nowiki>Item# Item# Item <nowiki>#...SeriesItem</nowikipre>
===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.
Use <nowiki><pre></pre></nowiki> tags.<br> In order to use word wrapping, use the following: <br> <nowiki><pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; your code goes here white-double space: -pre-wrap; white-double space: -o-pre-wrap; word-wrap: break-word;">tab tab tab This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer. </pre></nowiki> For more info, go to [http://www.mediawiki.org/wiki/Help:Formatting MediaWiki Help: Formatting]
==Heading Levels==
<nowiki>== Level 2 ===== Level 3 ======= Level 4 ========= Level 5 =========== Level 6 ======</nowiki> *Level 1 is the Page Name.*An article with four or more headings automatically creates a [[Wiki_Editing_CheatSheet#Tables_of_Contents|table of contents]]for page name.
For more info, go to [http:<pre>==level 2=====Level 3=======Level 4=========Level 5===========Level 6======<//www.mediawiki.org/wiki/Help:Formatting MediaWiki Help: Formatting]pre>
==Tables of Contents==
MediaWiki adds a table of contents at the top of the page when you have four or more [[Wiki_Editing_CheatSheet#Heading_Levels|headers]].<br/>
To change this behavior, at the top of the page, add:
<nowiki>__NOTOC__</nowiki> Hides the table of contents (TOC).
<nowiki>__FORCETOC__</nowiki> Forces the table of contents to appear at its normal position (before the first header).
<nowiki>__TOC__</nowiki> Places a table of contents at the word's current position (overriding <nowiki>__NOTOC__</nowiki>).
For more info, go <pre>__NOTOC__ Hides the table of contents (TOC). __FORCETOC__ Forces the table of contents to [http://wwwappear at its normal position (before the first header).mediawiki.org/wiki/Manual:Table_of_contents MediaWiki Manual: Table __TOC__ Places a table of contents] or [http://www.mediawikiat the word's current position (overriding <nowiki>__NOTOC__).org</wikinowiki></Help:Magic_words MediaWiki Help: Magic words]pre>
==Hyperlinks==
===Links to Internal Pages===
Link to internal page
===Links [[Branding]] <pre>[[Branding]]</pre> Link to Internal Pages===internal page with different text [[Branding|Different text]]To add a link to '''Main Page''': <nowikipre>[[Main PageBranding|Different text]]</nowikipreLink to a heading on the same page [[#Heading Levels|Heading Levels]]
To add a link to '''Main Page''' which displays as ''different text'': <nowikipre>[[Main Page#Heading Levels|</nowiki>''different text''<nowiki>Heading Levels]]</nowikipre>
===Links to External Pages===
To add Add a link to www.smartsimple.com <nowiki>http://www.smartsimple.com</nowiki>an external webpage
To add a link to www.smartsimple.com with a ''different label'' <nowiki>[httphttps://www.smartsimple.com</nowiki> ''different label''<nowiki>smartsimple.com]</nowiki>
<pre>[https://www.smartsimple.com smartsimple.com]</pre>
<pre style="white-space: pre-wrap;
white-space: -moz-pre-wrap;
white-space: -pre-wrap;
white-space: -o-pre-wrap;
word-wrap: break-word;">Note: All external links are currently set to open in a new window.</pre><!--Chin can change this if necessary (apparently using syntax from https://www.mediawiki.org/wiki/Manual:$wgExternalLinkTarget)-->
Note:
For more info, go to * 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=== [httpmailto://wwwsales@smartsimple.mediawikicom sales@smartsimple.org/wiki/Helpcom] <pre>[mailto:Links MediaWiki Help: Linkssales@smartsimple.com sales@smartsimple.com]</pre>
==Image Files==
# Under the '''toolboxGlobal Actions''', click press '''Upload file'''.# Upload Press the '''Choose File''' button to select an imageand press '''Open'''.# On 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 page you wish 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 the an image[[File: enter this formata11y-disability.png|thumb|none|alt=four images of disabilities|800px|The four disability classifications]] <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 1280 pixels but displayed at 800px.Make sure you add a caption.
===Image no link with caption===
<nowiki>[[File:imgname.png|thumb|none|500px|Caption for under the image]]</nowiki>
===Image linked to external with internal link=== <nowiki>[[File:Who-is-usinga11y-btndisability.png|330pxthumb|none|alt=four images of disabilities|link=http://www.smartsimple.com/collaborators-online.htmlAccessibility|800px|The four disability classifications]]</nowiki>
===Image linked to internal link=== <nowikipre>[[File:thumbnaila11y-blue-whitedisability.jpgpng|thumb|none|400pxalt=four images of disabilities|link=Blue and WhiteAccessibility|800px|The four disability classifications]]</nowikipre>
For more info, go to Image with external link[http[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=https://www.mediawikismartsimple.orgcom/wiki/Help:Images MediaWiki Help: Imagesagreements.html|800px|The four disability classifications]]
==Tables=====Syntax===<table class="wikitable" width="60%"><trpre><td style="padding[[File: 10px;"><big>{a11y-disability.png|thumb|</big></td><td style="padding: 5px;"><b>table start</b></td></tr><tr><td style="padding: 10px;"><big>none|+</big></td><td stylealt="padding: 5px;">table <b>caption,</b> <i>optional;</i> only between <b>table start</b> and first <b>table row</b></td></tr><tr><td style="padding: 10px;"><big>four images of disabilities|-</big></td><td stylelink="paddinghttps: 5px;"><b>table row,</b> <i>optional on first row</i> -- wiki engine assumes the first row</td></tr><tr><td style="padding: 10px;"><big>!</big></td><td style="padding: 5px;"><b>table header</b> cell, <i>optionalwww.smartsimple.</i> Consecutive <b>table header</b> cells may be added on same line separated by double marks (<code>!!<com/code>) or start on new lines, each with its own single mark (<code>!</code>)agreements.</td></tr><tr><td style="padding: 10px;"><big>html|</big></td><td style="padding: 5px;"><b>table data</b> cell, <i>required!</i> Consecutive <b>table data</b> cells may be added on same line separated by double marks (<code>||</code>) or start on new lines, each with its own single mark (<code>|</code>).</td></tr><tr><td style="padding: 10px;"><big>800px|}</big></td><td style="padding: 5px;"><b>table end</b></td></tr>The four disability classifications]]</tablepre>
===Example===You can upload a new version of any file by typing '''File:''' then your desired file name into the search.
This...==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:
<nowiki>{| border="1"</nowiki> <nowiki>|'''Menu or Application'''</nowiki> <nowiki>|'''Search For'''</nowiki> <nowiki>|-</nowiki> <nowiki>|Organization, Search People</nowiki> <nowiki>|People[[File: internal and external, related companies, standard and custom fields.</nowiki> <nowiki>|website-</nowiki> <nowiki>|Communications, Contacts</nowiki> <nowiki>|External people only portal- limited search capabilities.</nowiki> <nowiki>|sample-</nowiki> <nowiki>|[[Universal Tracking Application]] > Contact Tab</nowiki> <nowiki>|Same page as the ''Search People'' pageimages.</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 [[UTAzip]]</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>
<pre>[[File:website-portal-sample-images...produces this...zip]]</pre>
==Tables=====Syntax==={| borderclass="1wikitable"|'''Menu or Application'''|'''Search For'''
|-
!|Organization, Search PeopleSyntax!|People: internal and external, related companies, standard and custom fields.Description
|-
|Communications, Contacts|<pre>{|</pre>|External people only - limited search capabilities.|'''table start'''
|-
|[[Universal Tracking Application]] |<pre>|+</pre> Contact Tab|Same page as the |table '''caption,''' optional; only between '''table start''' and first '''table row'Search People'' page.
|-
|[[Universal Tracking Application]] |<pre>|-</pre> Company Tab|Same functionality as the |''Search People'table row,''' page, but with companies.
|-
|Sales Tracking Application |<pre>!|</pre> Company Tab|Same page as the Company tab in the [[UTA]]|'''table header'''
|-
|Sales Tracking Application |<pre>||</pre> Contacts Tab|Same page as the |'''table data'Search People'' pageeach cell
|-
|Sales Tracking Application |<pre>|}</pre> My Contacts|Limited to contacts associated with companies where the current user is the owner.|'''table end'''
|}
===Example of Aligning Text=== This...  <nowiki>{|</nowiki> <nowiki>! alignclass="leftwikitable"| Item</nowiki> <nowiki>! Amount</nowiki> <nowiki>! Cost</nowiki> <nowiki>|-</nowiki> <nowiki>|Orange</nowiki> <nowiki>|10</nowiki> <nowiki>|7.00</nowiki> <nowiki>|-</nowiki> <nowiki>|Butter</nowiki> <nowiki>|1</nowiki> <nowiki>|5.00</nowiki> <nowiki>|-</nowiki> <nowiki>!Total</nowiki> <nowiki>|</nowiki> <nowiki>|12.00</nowiki> <nowiki>|}</nowiki> ...produces this... {|! align="left"| Item! Amount! Cost
|-
!|OrangeSample Header!|10|7.00Sample Header
|-
|Butter|Sample Text|1|5.00Sample Text
|-
!Total||Sample Text||12.00Sample Text
|}
For more info, go to [http:<pre>{| class="wikitable"|-!|Sample Header!|Sample Header|-||Sample Text||Sample Text|-||Sample Text||Sample Text|-|} <//www.mediawiki.org/wiki/Help:Tables MediaWiki Help: Tables]pre>
==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.
===Adding a <pre>[[Category to a Page===:Interface]]</pre>
<nowiki>[[Category:Help]]</nowiki>
===Adding a Category Link to a Category Page with a Different Label===[[:Category:Interface|Interface]]
<nowikipre>[[:Category:HelpInterface|Help categoryInterface]]</nowikipre>
==Templates=Adding =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 Link Wiki Article to a New Category Page===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. '''
<nowiki>[[:Category:Help|Help 3. Select the page's new category]]</nowiki>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. 
For more info, go to [http://www5.mediawikiClick '''Move Page.org/wiki/Help:Categories MediaWiki Help: Categories]'''
==TemplatesHow to Add a User to the Wiki:==* On left panel, click on '''User Manager'''.* Click the green Add button.* Add '''smartstaff''' group.* Click '''OK'''.
Pages that start with ==Deleting Articles==# Before you delete an article use the phrase "Template:" can be used tool in a similar fashion the left navigation called '''what links here'''.# Once you have removed the links go to SmartSimplethe '''s [[System Variables]]. They can contain blocks of text, such as commonly used terms, Wiki tables More''' menu top right and uploaded imagesselect delete. You should use templates if a term, table or image will be repeated across multiple # Make sure you delete all pagesno longer required. The template can be referenced by surrounding # Delete the template name (minus category the leading "Template:" string) with <nowiki>{{double brackets}}</nowiki>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.
===Example Templates=Finding Broken Links==* <nowiki>{{UTA}}<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:/nowiki> - returns {{UTA}}* <nowiki>{{GUA}}</nowiki> - returns {{GUA}}* <nowiki>{{LUA}}<wiki.smartsimple.com/nowiki> - returns {{LUA}}* <nowiki>{{XML}}</nowiki> - returns {{XML}}* <nowiki>{{ROSV}}</nowiki> - returns {{ROSV}}* <nowiki>{{WPV}}</nowiki> - returns {{WPV}}* <nowiki>{{l1}}</nowiki> - returns {{l1}}* <nowiki>{{l2}}</nowiki> - returns {{l2}}* <nowiki>{{CopyIcon}}</nowiki> - returns {{CopyIcon}}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]]
 
[[aitranscriptgpttest]]
Smartstaff, administrator
3,321
edits

Navigation menu