diff --git a/devdocs/todo.txt b/devdocs/todo.txt index 286f824d..bd034c80 100644 --- a/devdocs/todo.txt +++ b/devdocs/todo.txt @@ -11,7 +11,9 @@ (none are as old as 2009 ca) - If all is well then do a rebuild as there are changes to the AyaNova client (at least maybe more) move current dl to previous folder and move next to current download slot and post about it on the forum - +SCREENSHOTS in manual pages +Since the manual is now the main marketing link from the website it really needs screenshots NOW of all major areas +Every form should have a picture of that form giving people a visual idea of what to expect so they don't actually need to run the app to determine what's what todo: BIG PICTURE - NEXT diff --git a/docs/8.0/ayanova/docs/home-schedule.md b/docs/8.0/ayanova/docs/home-schedule.md index cec8009f..e098be12 100644 --- a/docs/8.0/ayanova/docs/home-schedule.md +++ b/docs/8.0/ayanova/docs/home-schedule.md @@ -2,10 +2,34 @@ The home personal schedule displays events connected to the currently logged in User and can also be used to create new items or modify existing ones. -The events potentially displayed are [Work order](svc-workorders.md) item scheduled User records, [Review](home-reviews.md) and [Reminder](home-reminders.md) records. +The events potentially displayed are _personal_ [Work order](svc-workorders.md) item scheduled User records, [Review](home-reviews.md) and [Reminder](home-reminders.md) records. + +The personal schedule form only displays information for the currently logged in User unlike the [Service schedule](svc-schedule.md) form. + +## Views + +There are multiple views available: + +### Month view + +![Month view](img/home-schedule-form.png) + +### Week view + +![Week view](img/home-schedule-form-week-view.png) + +### Four Day view + +![4 Day view](img/home-schedule-form-four-day-view.png) + +### Day view + +![Day view](img/home-schedule-form-day-view.png) ## Menu options +![Menu](img/home-schedule-form-menu.png) + The personal schedule menu provides quick access to the currently logged in User's Reminders, Reviews, Work order item scheduled user and Work order item Labor data tables for viewing or reporting ## Settings @@ -26,7 +50,11 @@ This controls what types of items show in the schedule. Choose where the color comes from that is displayed in the schedule: -The Schedule is technically showing Work order item scheduled user records however a Work order has several different colors associated with it. This setting controls which color to use for display in the schedule. 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. +The Schedule is technically showing Work order item scheduled user records however a Work order has several different colors associated with it. + +This setting controls which color to use for display in the schedule. + +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. ## Items with no date set @@ -36,34 +64,52 @@ The schedule shows dated items only, any Work order item scheduled user records A Review object does not have a time period associated with it as it only has a single _Review Date_ field. For this reason all Review items will display in the schedule starting at their Review Date as a 15 minute interval. +## Opening an event + +Clicking on an event displayed in the schedule opens a pop up display with more detailed information about the object selected including links to open it directly. + +### Work order more info box + +![wo more info](img/home-schedule-form-wo-more-info.png) + +### Review more info box + +![review more info](img/home-schedule-form-review-more-info.png) + +In addition to opening the source Review with the Open button you can also open the source object by clicking on it's icon beside the name of the object being reviewed (in the image above it's the Customer icon). + +### Reminder more info box + +![reminder more info](img/home-schedule-form-reminder-more-info.png) + ## 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 the current view to the Day view for that date. +- 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 the current view to the Day view for that date. ## Create / modify / view events ### Devices with a mouse -- Drag and drop an existing event to a new time or day -- 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 and drop an existing event to a new time or day +- 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 ![Extend](img/svc-schedule-extend.png) -- Events with a lock symbol on them are not modifiable +- Events with a lock symbol on them are not modifiable ![Locked](img/svc-schedule-locked.png) -- Click and drag in an empty space in any Day view to create a new object in that time frame selected -- Click an event to open a More information display with a summary of that item and an Open button to open the source record +- Click and drag in an empty space in any Day view to create a new object in that time frame selected +- Click an event to open a More information display with a summary of that item and an Open button to open the source record ### 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 +- 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 diff --git a/docs/8.0/ayanova/docs/img/home-schedule-form-day-view.png b/docs/8.0/ayanova/docs/img/home-schedule-form-day-view.png new file mode 100644 index 00000000..1c2cf569 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/home-schedule-form-day-view.png differ diff --git a/docs/8.0/ayanova/docs/img/home-schedule-form-four-day-view.png b/docs/8.0/ayanova/docs/img/home-schedule-form-four-day-view.png new file mode 100644 index 00000000..5ce60164 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/home-schedule-form-four-day-view.png differ diff --git a/docs/8.0/ayanova/docs/img/home-schedule-form-menu.png b/docs/8.0/ayanova/docs/img/home-schedule-form-menu.png new file mode 100644 index 00000000..d3932398 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/home-schedule-form-menu.png differ diff --git a/docs/8.0/ayanova/docs/img/home-schedule-form-reminder-more-info.png b/docs/8.0/ayanova/docs/img/home-schedule-form-reminder-more-info.png new file mode 100644 index 00000000..3bee15bf Binary files /dev/null and b/docs/8.0/ayanova/docs/img/home-schedule-form-reminder-more-info.png differ diff --git a/docs/8.0/ayanova/docs/img/home-schedule-form-review-more-info.png b/docs/8.0/ayanova/docs/img/home-schedule-form-review-more-info.png new file mode 100644 index 00000000..9cbf2697 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/home-schedule-form-review-more-info.png differ diff --git a/docs/8.0/ayanova/docs/img/home-schedule-form-week-view.png b/docs/8.0/ayanova/docs/img/home-schedule-form-week-view.png new file mode 100644 index 00000000..9e7ae4d7 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/home-schedule-form-week-view.png differ diff --git a/docs/8.0/ayanova/docs/img/home-schedule-form-wo-more-info.png b/docs/8.0/ayanova/docs/img/home-schedule-form-wo-more-info.png new file mode 100644 index 00000000..fdcd8998 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/home-schedule-form-wo-more-info.png differ diff --git a/docs/8.0/ayanova/docs/img/home-schedule-form.png b/docs/8.0/ayanova/docs/img/home-schedule-form.png new file mode 100644 index 00000000..9ad7abb1 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/home-schedule-form.png differ diff --git a/docs/8.0/ayanova/docs/img/svc-schedule-form-day-view.png b/docs/8.0/ayanova/docs/img/svc-schedule-form-day-view.png new file mode 100644 index 00000000..31dc5a45 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/svc-schedule-form-day-view.png differ diff --git a/docs/8.0/ayanova/docs/img/svc-schedule-form-four-day-view.png b/docs/8.0/ayanova/docs/img/svc-schedule-form-four-day-view.png new file mode 100644 index 00000000..e9cdce6b Binary files /dev/null and b/docs/8.0/ayanova/docs/img/svc-schedule-form-four-day-view.png differ diff --git a/docs/8.0/ayanova/docs/img/svc-schedule-form-team-day-view.png b/docs/8.0/ayanova/docs/img/svc-schedule-form-team-day-view.png new file mode 100644 index 00000000..ecc54b33 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/svc-schedule-form-team-day-view.png differ diff --git a/docs/8.0/ayanova/docs/img/svc-schedule-form-week-view.png b/docs/8.0/ayanova/docs/img/svc-schedule-form-week-view.png new file mode 100644 index 00000000..f0659872 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/svc-schedule-form-week-view.png differ diff --git a/docs/8.0/ayanova/docs/img/svc-schedule-form.png b/docs/8.0/ayanova/docs/img/svc-schedule-form.png new file mode 100644 index 00000000..9a15699e Binary files /dev/null and b/docs/8.0/ayanova/docs/img/svc-schedule-form.png differ diff --git a/docs/8.0/ayanova/docs/svc-schedule.md b/docs/8.0/ayanova/docs/svc-schedule.md index e6b1d9d2..86349a97 100644 --- a/docs/8.0/ayanova/docs/svc-schedule.md +++ b/docs/8.0/ayanova/docs/svc-schedule.md @@ -1,10 +1,44 @@ # Service schedule -The Service schedule form displays Work order item scheduled User records, (here we'll refer to them as "events") and can also be used to create new events or modify existing ones. Events are displayed for all Users or a filtered sub set selected through Tags. The schedule also supports "drilling down" into a single User's schedule. +The Service schedule form displays Work order item scheduled User records, (here we'll refer to them as "events") and can also be used to create new events or modify existing ones. -### Reminders +Events are displayed for **all** scheduleable Users or a filtered sub set selected through Tags. -Reminders are only available in a Users [personal Home Schedule](home-schedule.md) form, not in this Service schedule form which displays work order scheduled user records only. +The schedule also supports "drilling down" into a single User's schedule. + +The Service schedule does not display Reminders or Reviews like you would see in the [personal schedule](home-schedule.md) form. + + +## Views + +There are multiple views available: + +### Month view + +![Month view](img/svc-schedule-form.png) + +The image shows a monthly view [filtered](#filtering) to only include events for service technicians tagged with "blue" or "black". + +### Week view + +![Week view](img/svc-schedule-form-week-view.png) + +### Four Day view + +![4 Day view](img/svc-schedule-form-four-day-view.png) + +### Day view + +![Day view](img/svc-schedule-form-day-view.png) + +All today's events ([filtered](#filtering) to only include events for service technicians tagged with "blue" or "black"). + +### Day view + +![Day view](img/svc-schedule-form-team-day-view.png) + +All today's events separated by service technician. +Only technicians with events on this day will show here and [filtering](#filtering) still applies if used. ## Menu options