Reorganize docs, update user docs, add pictures

docs/Self-Hosting and Development/API Documentation.md

@@ -46,4 +46,4 @@ If the request is not well-formed (missing required arguments, invalid API key,
 | `getnotifications` | `username` or `uid` | Get notifications for the user.  When successful, returns an array `notifications` with items similar to: `{"id": 1, "timestamp": "YYYY-MM-DD HH:MM:SS", "title": "text", "content": "text", "url": "text", "seen": false, "sensitive": false}`
 | `readnotification` | `username` or `uid`, `id` | Mark the notification identified by the user and notification ID as read.  Sets `seen` to `true` in future calls to `getnotifications`, and changes how the notification is displayed in the UI.
 | `addnotification` | `username` or `uid`, `title`, `content`, `timestamp` (optional, defaults to current date/time), `url` (optional, defaults to empty string), `sensitive` (optional, defaults to `false`) | Add a notification for the given user with the content.
-| `deletenotification` | `username` or `uid`, `id` | Delete a notification.
+| `deletenotification` | `username` or `uid`, `id` | Delete the notification identified by the user and notifiation ID.

docs/User Documentation.md

@@ -1,73 +0,0 @@
-# User Documentation
-
-## Logging In
-
-1. Go to the address of the AccountHub server in your web browser (Firefox, Chrome, etc.).  This address will be supplied by your IT staff or Netsyms Business Support.
-2. Enter your username and password.
-    * Do not enter your email address.
-    * Passwords are case-sensitive.
-3. If you have setup a 2-factor authentication app, AccountHub will ask you for a code.  Open the app on your phone or other device and type the displayed code.
-    * The code changes every 30 seconds.  If you don't submit the code in that time window, it will be considered incorrect and you will have to go back to step 2.
-4. You are now logged in.
-
-### Login Troubleshooting
-There are some common error messages you may see while logging in.  Here's what they mean annd what you can do about them.
-
-* __Login incorrect.__
-    This means you have entered an incorrect username or password.  Try again.
-* __Authentication code incorrect.__
-    The 2-factor authentication code you entered was either wrong or expired.  Log in and try again.
-* __This account has been disabled. Contact technical support.__
-    Your account has been marked as disabled by your IT staff.  Contact them to resolve the issue.
-* __Account terminated.  Access denied.__
-    The user account has been closed by your IT staff.  Contact them to resolve the issue.
-* __Your account state is not stable.  Log out, restart your browser, and try again.__
-    Your account is not syncronized between the Portal server and the Active Directory domain controller.  Log out (if you are logged in), close your web browser, and start over.  If you continue to see this error, try clearing your cookies and cache or contact your IT department.
-* __You must change your password before continuing.__
-    Your password has been marked by IT staff or an automatic process as requiring a reset before you can log in.
-    
-### Changing your Password during Login
-If your password has expired, you will need to change it before logging in.  Type your current password and new password where prompted on the screen.  You will need to type your new password twice.  Press Continue.  If your current password is correct, you entered the new password correctly, and your new password meets the security requirements, your password will be updated and you will be able to login as usual.
-
-## Home Page (Dashboard)
-The dashboard, or home page, is what you will see after logging in.  It shows you a brief overview of your account, with information taken from all the different Business Apps.
-
-### Using the Dashboard
-
-There are various "widgets" on the dashboard.  They display relevant information from the other Business Apps.  You can use them to quickly view important information or perform common tasks, such as viewing assigned tasks from TaskFloor or punching in or out with QwikClock.
-
-### Navigating between apps
-
-Near the top of the dashboard, you will see a row of icons.  You can click on these icons to go to other apps.  To return to the dashboard from the other apps, click your name in the bar near the top of the screen.
-
-## Account Options
-
-To manage account options, click on Account Options in the top bar of AccountHub.
-
-### Sync Mobile App
-
-If you wish to access the Business Apps from your smartphone or tablet, you can download Business Apps for Mobile on your device.  The first time you open the app, you will be told to scan a sync code.
-
-#### Pairing the Mobile App
-To generate a sync code, go to Account Options in AccountHub, and press `Create new sync code` under `Sync Mobile App`.  Follow the instructions on your smartphone or tablet to scan the code and finish the setup process.  If you cannot scan the code for whatever reason, press `Manual Setup` on your phone and type the details shown below the sync code in AccountHub.
-
-#### Unpairing the Mobile App
-From your Account Options in AccountHub, press the red trash can icon next to the sync key.  The mobile app will no longer work until it is re-paired with a new key.
-
-If your phone or tablet was lost or stolen, you should also change your password, because the password is stored on the phone or tablet to facilitate automatic login.  If your phone or tablet was not lost or stolen, you should open the settings in Business Apps for Mobile and clear all saved data.
-
-#### Updating your Password
-The mobile app saves your password so you don't have to type it every time.  If you change your password, you will need to tell the mobile app the new password.  Open the app settings, press the proper button, and enter your new password.
-
-### Change Password
-Type your current password and new password where prompted on the screen.  You will need to type your new password twice.  Press `Change password`.  If your current password is correct, you entered the new password correctly, and your new password meets the security requirements, your password will be updated.
-
-### Setup 2-factor authentication
-
-2-factor authentication, or 2FA, is the security practice of using a continually-changing code to make it much harder to hack in to an account.  The Business Apps support TOTP, a common 2FA method.  With 2FA enabled, you will be asked for a six-digit code in addition to your password.  This code will be shown on an app on your phone or other device, and changes every 30 seconds.
-
-#### Enable 2FA
-To setup TOTP 2-factor authentication, download an app such as Google Authenticator on your phone.  In AccountHub, press `Enable 2-factor authentication`, add the barcode with your mobile authenticator app, and press `Finish setup` in AccountHub.
-
-#### Disable 2FA
-To disable 2FA, press `Disable 2-factor authentication` from the Account options in AccountHub.  If you are unable to log in due to not having a 2FA code, tech support can remove 2FA from your account for you.

docs/User Guide/Account Security.md

@@ -0,0 +1,26 @@
+# Account Security
+
+## Change Password
+<img src="../../images/screenshots/changepassword.png" alt="Card with a text box for the current password, followed by two boxes for the new password." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />Type your current password and new password where prompted on the screen.  You will need to type your new password twice.  Press <button>Change password</button>.  If your current password is correct, you entered the new password correctly, and your new password meets the security requirements, your password will be updated.
+
+<p style="clear: both;"></p>
+
+# Change PIN
+
+<img src="../../images/screenshots/changepin.png" alt="Card with two text boxes for entering a PIN code, and a button titled 'Change PIN'." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />For more secure access when logging into the Station kiosk app, you may set a numerical PIN code between 1 and 8 digits in length.  Enter the new PIN twice and press <button>Change PIN</button>.  To remove the PIN, leave both boxes empty and press <button>Change PIN</button>.
+
+<p style="clear: both;"></p>
+
+## Setup 2-factor authentication
+
+2-factor authentication, or 2FA, is the security practice of using a continually-changing code to make it much harder to hack in to an account.  The Business Apps support TOTP, a common 2FA method.  With 2FA enabled, you will be asked for a six-digit code in addition to your password.  This code will be shown on an app on your phone or other device, and changes every 30 seconds.
+
+### Enable 2FA
+<img src="../../images/screenshots/setup2fa2.png" alt="Card with a QR code, text box titled 'Enter 6-digit code', button titled 'Finish Setup', and information for manual setup." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />To setup TOTP 2-factor authentication, download an app such as Netsyms Business Mobile, andOTP, Authy, or Google Authenticator on your phone.  In AccountHub, press <button>Enable 2-factor authentication</button>, add the barcode with your mobile authenticator app, and press <button>Finish setup</button> in AccountHub.
+
+<p style="clear: both;"></p>
+
+### Disable 2FA
+<img src="../../images/screenshots/disable2fa.png" alt="Card with a button titled 'Disable 2-factor authentication'." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />To disable 2FA, press <button>Disable 2-factor authentication</button> from the Account options in AccountHub.  If you are unable to log in due to not having a 2FA code, tech support can remove 2FA from your account for you.
+
+<p style="clear: both;"></p>

docs/User Guide/Dashboard.md

@@ -0,0 +1,32 @@
+# Dashboard
+The dashboard, or home page, is what you will see after logging in.  It shows you a brief overview of your account, with information taken from all the different Business Apps.
+
+## Navigating between apps
+
+<img alt="Grid of colored cards, each containing an app icon, app name, and descriptive text" src="../../images/screenshots/appdock.png" style="float: right; margin-bottom: 10px;">
+
+Near the top of the dashboard, you will see one or more rows of icons.  You can click on these icons to go to other apps.  To return to the dashboard from the other apps, click your name in the bar near the top of the screen.
+
+
+## Cards
+
+There are various "cards" on the dashboard.  They will take you to the different applications available.  You can use them instead of the icons, if you choose.
+
+<img alt="Grid of colored cards, each containing an app icon, app name, and descriptive text" src="../../images/screenshots/appcards.png" style="float: right; margin-bottom: 10px;">
+
+## Notifications
+
+<img alt="Sample notification card with title, two buttons (from left to right, a blue eye and a red trash can), some text, and a footer with a date and time" src="../../images/screenshots/notification.png" style="float: right; margin: 10px;">
+
+Certain activity in the Business Apps can cause you to receive notifications.
+
+At the bottom of the notification, you can see the date and time it was created.  If it was created in the past 12 hours, it will not show the date.
+
+
+### Reading Notifications
+
+Unread notifications will have their text shown in **bold**.  To mark a notification as read, click the blue eye button next to the notification title.
+
+### Deleting Notifications
+
+To delete a notification you no longer need, click the red trash can button near the notification title.

docs/User Guide/Logging In.md

@@ -0,0 +1,26 @@
+# Logging In
+
+1. Go to the address of the AccountHub server in your web browser (Firefox, Chrome, etc.).  This address will be supplied by your adminstrator or Netsyms Technologies.
+2. Enter your username and password. <img src="../../images/screenshots/login.png" alt="Login screen, with boxes labeled 'Username' and 'Password', and a button labeled 'Continue'" style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />
+    * Do not enter your email address.
+    * Passwords are case-sensitive.
+3. If you have setup a 2-factor authentication app, AccountHub will ask you for a code.  Open the app on your phone or other device and type the displayed code.<img src="../../images/screenshots/2falogin2.png" alt="Login screen, with text box for entering authentication code and a button labeled 'Continue'" style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />
+    * The code changes every 30 seconds.  If you don't submit the code in that time window, it may be considered incorrect and you will have to go back to step 2.  The system will also accept the previous code, in case it changed while you were typing.
+4. You are now logged in.
+
+## Login Troubleshooting
+There are some common error messages you may see while logging in.  Here's what they mean annd what you can do about them.
+
+* __Login incorrect.__
+    This means you have entered an incorrect username or password.  Try again.
+* __Authentication code incorrect.__
+    The 2-factor authentication code you entered was either wrong or expired.  Log in and try again.
+* __This account has been disabled. Contact technical support.__
+    Your account has been marked as disabled by an administrator.
+* __Account terminated.  Access denied.__
+    The user account has been closed by an administrator.
+* __You must change your password before continuing.__
+    Your password has been marked as requiring a reset before you can log in.
+    
+## Changing your Password during Login
+If your password has expired, you will need to change it before logging in.  Type your current password and new password where prompted on the screen.  You will need to type your new password twice.  Press Continue.  If your current password is correct, you entered the new password correctly, and your new password meets the security requirements, your password will be updated and you will be able to login as usual.

docs/User Guide/Sync Settings.md

@@ -0,0 +1,19 @@
+# Sync Settings
+
+If you wish to access the Business Apps from your smartphone or tablet, you can download Business Apps for Mobile on your device.  The first time you open the app, you will be told to scan a sync code.<img src="../../images/screenshots/syncapp1.png" alt="Card with a text box labeled 'Device nickname', a button labeled 'Create new sync code', and a list of paired devices." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />
+
+## Pairing the Mobile App
+To generate a sync code, go to Sync Settings in AccountHub, enter a name in the "Device Nickname" box, and press <button>Create new sync code</button>. <img src="../../images/screenshots/syncapp2.png" alt="Card with a QR code, button titled 'Done adding code', and manual setup information." style="box-shadow: 0 1px 4px rgba(0,0,0,0.4); margin: 10px; float: right;" />
+
+Follow the instructions on your smartphone or tablet to scan the code and finish the setup process.  If you cannot scan the code for whatever reason, press <button>Manual Setup</button> on your phone and type the details shown below the sync code in AccountHub. <img src="../../images/screenshots/mobilesync.png" alt="Image of phone screen showing mobile app with button labeled 'Scan Code' and button labeled 'Manual Setup'." style="margin: 10px; float: right; border: 1px solid #555;" />
+
+<p style="clear:both;"></p>
+
+## Unpairing the Mobile App
+From Sync Settings in AccountHub, press the red trash can icon next to the sync key.  The mobile app will no longer work until it is re-paired with a new key.
+
+If you are unpairing because your phone or tablet was lost or stolen, you should also change your password, because the password is stored on the phone or tablet to facilitate automatic login and could be recovered.  If your phone or tablet was not lost or stolen, you should open the settings in Business Apps for Mobile and clear all saved data.
+
+## Updating your Password
+
+The mobile app saves your password so you don't have to type it every time.  If you change your password, you will need to tell the mobile app the new password.  Open the app settings, press the button titled <button>Update Password</button>, and enter your new password.