Smartstaff, administrator
3,321
edits
Changes
→Links to External Pages
=Overview=
SmartSimple’s Wiki is a repository of knowledge used targeted at system Administrators intended to help make learning and configuring SmartSimple easy to doeasier. This page will provide guidance for anyone who is contributing to the wiki. By establishing Following established standards to follow that 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 need to should follow this format:
===Overview===
===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 task 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. Example: Setting: Is Default Login Page, Description: By default, when a user goes to your system's URL, example https://smart.smartsimple.com they will be directed to the English US language login page. If you want users to go to a different language login page by default, toggle this setting on for the login page with your desired language. Note: only one login page can be set as the default. ===See Also===This section is optional. If there are other related articles you think a user should be made aware or that you have mentioned in In time this article you may wish to add links to these articles in here. Be mindful that any static links you add here will need to be maintained. If a page name changes someone will need to go back and fix every link added to every page replaced by an in a See Alsosystem help.
===Category===
Make sure every article has a category that . This way by default it is easy to find all related pages so we . Ideally all articles should not need to heavily rely be in one of the categories found on the “See Also” sections as categories list home page https://wiki.smartsimple.com/wiki/Main_Page. This way anyone entering the wiki for the first time can find all related the good articles and the links are dynamic so there . If an article falls into more than one category that is no maintenance liability and they are accessible from every related pageok.
===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)
===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.
<pre>your code goes here
<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===
<pre>[https://www.smartsimple.com smartsimple.com]</pre>
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===
[mailto:sales@smartsimple.com sales@smartsimple.com]
<pre>[mailto:sales@smartsimple.com sales@smartsimple.com]</pre>
==Image Files==
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
[[File:a11y-disability.png|thumb|none|500pxalt=four images of disabilities|800px|The four disability classifications]]
<pre>[[File:a11y-disability.png|thumb|none|500pxalt=four images of disabilities|800px|The four disability classifications]]</pre>
Images are uploaded at a resolution of 800 1280 pixels but displayed at 500px800px.
Make sure you add a caption.
Image with internal link
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=Accessibility|500px800px|The four disability classifications]]
<pre>[[File:a11y-disability.png|thumb|none|500pxalt=four images of disabilities|link=Accessibility|800px|The four disability classifications|link=Accessibility]]</pre>
Image with external link
[[File:a11y-disability.png|thumb|none|alt=four images of disabilities|link=https://www.smartsimple.com/agreements.html|500px800px|The four disability classifications]]
<pre>[[File:a11y-disability.png|thumb|none|500px|The alt=four disability classificationsimages 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==
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==
* 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
[[Category:SmartSimple]]
[[aitranscriptgpttest]]