docs/8.0/ayanova/docs/home-schedule.md

@@ -1,32 +1,63 @@
 # HOME-SCHEDULE Placeholder
 
-[Incomplete - under construction]
+
+## Overview
+
+The personal schedule displays events tied to the currently logged in User and can also be used to create new items or modify existing ones.
+
+## Settings
+
+The settings dialog (access by clicking on gear icon at top) controls what is displayed in the schedule.  On most devices saving your settings will refresh the display immediately, however on some devices such as an iPad you will need to manually refresh the page after changing settings by reloading in the browser or any operation that forces a refresh of the underlying data such as changing the month or day.
+
+Schedule settings are device independant and saved to the server so that any device used will take these same settings.
+
+### First time in day view
+
+This controls the starting hour to display in day views.  Use it to hide unused hours to reduce the need to scroll down.
+
+### Show
+
+This controls what types of items show in the schedule. 
+
+### Work order color source
+
+The schedule is technically showing each Work order item scheduled user record however it also needs to show some Work order information in the display. Since a work order has several different colors associated with it, this setting controls which color to use in the schedule event display.  Note that you can always click on an event to view a summary of the work order including all the status and priority color based properties regardless of what is set here.
 
 
-Notes to cover:
+## Items with no date set
-Null dates - schedule has no way to display null dates (e.g. woitemscheduser with no start or end date selected).  Null dates must be viewed in data table lists instead.
 
-Review type objects have a ReviewDate but no end date so they are automatically shown as ReviewDate plus 15 minutes items in the schedule for display purposes
+The schedule shows dated items only. 
-Changing start / stop times
+
-Change day in month view only
+Some scheduleable items such as a Work order item scheduled user record have optional dates that can be left empty.  In these cases those items are not displayed anywhere on the schedule and must be viewed through their data table form which *will* display undated items.
-Change Time in any other view but month view
+
-    change start time by dragging to another time slot
+## Review events
-    change end time by dragging bottom of appointment 
+
+A Review object does not have a duration of it's event associated with it as it only has a single Review Date field.  For this reason all Review items will display at their Review Date in the schedule display and a "synthetic" end date that is 15 minutes after the Review Date.
 
 
-Tips and tricks:
+## Moving around
 
+* Today button - this button will take you to the current day in the schedule
+* Previous "<" / Forward ">" buttons will move to the next or prior window of time being displayed.  In Day view this will move one day, in Month view this will move one month, in Week view one week etc
+* Month Year button - This button displays the current month and year and can be clicked on to switch to month view if in any other view
+* Settings (Gear / Cog icon) opens the settings form
+* View drop down at top right is used to switch the view between the available options
+* Date (Day) number - Clicking on a date in the Calendar (i.e. clicking on the "23" for the 23rd of the month) will switch to the day view for that date if in any view other than day view
 
-Click on appointment for popup mini display of relevant details or to open the source object for editing
+## Create / modify / view events
-Click on Open or Icon at top of more info display to open it (no need to scroll down to open button)
-Click on Month-Year display in title above calendar to quickly go back to month view from other view
 
-DRAG / EXTEND
+### Devices with a mouse
-Mouse devices can drag drop and extend existing events (or click-drag on empty space to create new events) directly in the calendar
+
-Non-mouse touch based devices need to change event times by opening and editing the object in it's UI
+* Drag and drop an existing event to a new time or day
-Non mouse touch devices can create new events in the calendar by touching an empty location however the times will need to be set in the object once it's open for editing
+* Extend the duration of an event: hover the mouse over the bottom, a "grip" will appear, click and drag up or down to modify the time range
-Drag extend appointments at bottom
+* Events with a lock symbol on them are not modifiable
-Drag appointments to move to another day or time range
+* Click and drag in an empty space in any Day view to create a new object in that time frame selected
-Lock symbol on appointment means it cannot have it's time changed
+* Click an event to open a quick More information display with a summary of that item
-    (locked or completed Work order item scheduled user records, completed Reviews)
+* Open the object the event represents for editing by clicking on Open or the icon at the top of the More information dialog
-Drag in empty space in any DAY view (not month view) to create a new object in that time frame selected
+
+### Non mouse devices
+
+* Non mouse devices are not supported for drag or extend operations
+* Touch an empty space in any Day view to create a new Reminder or Work order starting at the date and time touched initially
+* Touch an event to open a more information dialog 
+* Edit / view the original object the event is displayed for from the more information dialog "Open" button