Smartstaff, administrator
3,316
edits
Changes
no edit summary
=Overview=
SmartSimple’s Wiki is a repository of knowledge used to make learning and configuring SmartSimple easy to do. This page will provide guidance for anyone who is contributing to the wiki. By establishing standards to follow that will improve the user experience of this Wiki.
==Wiki article structure==
All wiki articles need to 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.
===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===
===Category===
Make sure every article has a category that way by default it is easy to find all related pages so we should not need to heavily rely on the “See Also” sections as categories list all related articles and the links are dynamic so there is no maintenance liability and they are accessible from every related page.
===Preformatted text ===
Put code examples inside pre tags the pre stands for preformatted text. This will preserve the formatting of the text you entered (example tab, double spaces, new lines).
<pre>
<code>
<pre>
text
tab tab tab
double space double space
</pre>
</code>
</pre>
===Other considerations===
Note:
When adding screenshots, they should be 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.
