Skip to content

Commit 22b5844

Browse files
committed
shifted the docs around for the new module name
1 parent 5d25fc2 commit 22b5844

19 files changed

Lines changed: 75 additions & 93 deletions

_modules/events.md

Lines changed: 75 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -15,79 +15,60 @@ module_download: http://github.com/web2project/web2project/archive/master.zip
1515

1616
## Module Overview
1717

18-
The Calendar module provides the users with interfaces to manage the [Tasks](/modules/tasks.html) and Events in a chronological way.
19-
On this module you will find Year, Month, Week and Day displays of Tasks and Events and also the possibility to filter them accordingly.
18+
One of the most useful things of any collaboration system is a single shared Calendar for all users. This is useful for coordinating schedules, reviewing priorities, and even determining individual availability. Web2project offers this basic functionality and quite a bit more combining the Events, Tasks, and offering a variety of filtered display options.
2019

21-
### View Years (Year View Page)
20+
The Calendar module provides the users with interfaces to manage the [Tasks](/modules/tasks.html) and Events in a chronological way. Further, this module gives you the ability to view and filter Events according to Project or Company in addition to displaying by Day, Week, Month, and Year.
2221

23-
<a href="/assets/docs/calendar/view_year.png"><img src="/assets/docs/calendar/thumb-view_year.png" /></a>
22+
### Basic Display
2423

25-
The Yearly view gives the user an overall view of the Year calendar and color codes the days depending on the existence of Tasks and/or Events.
26-
27-
It's not uncommon to have events or task that last more than a calendar month. In addition you may want to be able to recall what your schedule looked like for the year. The year view gives you the option to view your intire schedule for the year.
28-
29-
From the Year View you can:
30-
31-
* Move forward and backwards in time to next or previous year
32-
* Click on any given month to switch to that month
33-
* Set [Company](/modules/companies.html) Filters
34-
* Set Event Filters
35-
* Switch to week view by clicking on the week icon in each month displayed.
36-
37-
### View Month (Month View Page)
38-
39-
<a href="/assets/docs/calendar/view_month.png"><img src="/assets/docs/calendar/thumb-view_month.png" /></a>
40-
41-
The Monthly view shows the user which Tasks and/or Events are scheduled for each day in the Month.
24+
The base view of the Calendar Module is a simple month view similar to Outlook or Google Calendar. It always defaults to the current month displaying all of the Users’ Tasks and Events. This view is filtered according to two aspects: Company and Ownership. At any time, a User can change the Company filter from any one to all of them. This gives a quick review on a per-customer basis with no additional effort. The Ownership filter allows a User to change their view based on All Events, Events I Created, and My Events. By changing the combination of these two aspects, Users can look at the information from a variety of angles and determine a great deal about most projects.
4225

43-
Generally when you create an event or task in the system, this will create links within the calendar dynamically showing you the start and finish dates within that month. Each link in the calendar is dynamic, so you can click on it and it will take you to the details of that object. This is particularly useful when you want a snap shot view of what’s on the agenda for the entire month.
26+
I> In many cases, even filtering Events and Tasks by Company will still display too much information to be useful. Therefore, you can also filter by a specific Project.
4427

45-
Depending on how the administrator has the system configured, you can use filters to view calendar details for other [Departments](/modules/departments.html) or [Users](/modules/users.html), in addition to your own.
28+
D> To make life simpler for all involved, it is currently planned to implement iCal output for any active Web2project user. This will provide a simple way to monitor a calendar from within a third–party application such as Google Calendar, Apple iCalendar, or Outlook.
4629

47-
From this page you can:
30+
From the Month View, a user can click on the button on the far left of any line. This will take the User to a Week View based on the selected Company. It breaks down the week into a simple layout similar to a weekly planner. The Ownership filter is still available but in order to change the Company, the User must go back to the Month view.
4831

49-
* Click on a task or event and view details
50-
* Change to Week View by clicking on the box icon on the left
51-
* Go forward and backwards in month views
52-
* Switch to year view by clicking on the "year view calendar
53-
* Set company filters
54-
* Set Event Filters.
32+
### Creating an Event / Recurring Events
5533

56-
There are effectively two ways to move forward and backwards in time.
57-
58-
* Click the arrow icons at the top of the calendar (Located on the right and left site top)
59-
* On the bottom of the page you'll see the previous and next month quick links.
34+
Creating an Event in Web2project can be done at anytime from anywhere in the system by selecting “New Event” in the upper right hand corner. You simply name the event, give a brief description, select the relevant project, invite members, at set the recurrence schedule. If you set a recurring event, Web2project will automatically add it to all invitee’s calendars and email a notification immediately.
6035

61-
### View Month w/ tool tip (Month View Page)
36+
Q> Although every Event can be attached to a Project, there is no Events tab on the View Project screen. It will likely be developed in Head and released as a patch at a later date.
6237

63-
<a href="/assets/docs/calendar/view_month_tt.png"><img src="/assets/docs/calendar/thumb-view_month_tt.png" /></a>
38+
<a href="/assets/docs/events/addedit.png"><img src="/assets/docs/events/thumb-addedit.png" /></a>
6439

65-
Besides the information shown on the Monthly Calendar if the user hovers the items on the Calendar it will give the user a complete overview over the data on a form of a tooltip.
40+
With this form you will be able to create or edit Events. You can invite other users to those events and make sure they get notified by email about those Events.
6641

67-
The main advantage of this tooltip function is that it displays the details of that event so you do not need to click down to a lower view. This is useful for designers or managers who need to view information on the fly.
42+
Events can be associated with projects, task, meetings, or anything else relative to your daily workflow. You can access the add/edit events page from the Day View.
6843

69-
### View Week (Week View Page)
44+
How-to use this page:
7045

71-
<a href="/assets/docs/calendar/view_week.png"><img src="/assets/docs/calendar/thumb-view_week.png" /></a>
46+
* Enter a name or title for the event.
47+
* Define the type of event.
48+
* Note: This can be modified under the System Administration > System Look-up values to meet your needs
49+
* Associate this event to a project
50+
* Determine whether or not this is a private entry
51+
* Set start and finish date
52+
* Note: These will determine how it displays on the calendar view
53+
* You can recur this event to repeat weekly ect...
54+
* Assign internal resources
55+
* Note: To assign internal resources, click to highlight the name then select the arrow icon located under the box.
56+
* Type a description
57+
* Specify a time
58+
* This will replicate to the day view timeline
59+
* On the bottom of the page you have the option to send an email to the resources notifying them of the event.
7260

73-
The Week View page gives a week perspective of the Tasks and Events set for a given Week.
61+
### Viewing all Events
7462

75-
One area identified by some companies as a standard best practice is to view your task and events that are active for the week. In addition, if you are a designer and you wish to collaborate with another designer on a project in the system, you can use this view to see what their schedule looks like before including them as a resource.
63+
#### View Today's Events (Today's Tasks Todo)
7664

77-
From this page you can:
65+
<a href="/assets/docs/events/today_events.png"><img src="/assets/docs/events/thumb-today_events.png" /></a>
7866

79-
* Switch to month view
80-
* Click on a day and switch to day view
81-
* View the weekly calendar for a company
82-
* Change Event Filter
83-
* All Events
84-
* Your events (This includes events assigned to you that you may not have created)
85-
* Events you created.
86-
* You can also move forward and backwards in weeks.
67+
This tab will show the user the Events marked for the given date depending on the existing filters.
8768

88-
### View Day (Day View Page)
69+
#### View a Specific Day's Events (Day View Page)
8970

90-
<a href="/assets/docs/calendar/view_day.png"><img src="/assets/docs/calendar/thumb-view_day.png" /></a>
71+
<a href="/assets/docs/events/view_day.png"><img src="/assets/docs/events/thumb-view_day.png" /></a>
9172

9273
On this interface the user will be able to see what is going on, on a given date as well as the Tasks and Events set for that date considering the available filters.
9374
You will find two tabs, one with the Tasks to be done on that date and another with the Events set for that date.
@@ -104,60 +85,61 @@ From this page you can:
10485

10586
Clicking on a day within any of the calendars on the right hand side will take you to the day view for that month.
10687

107-
### View Today's Tasks (Today's Tasks Todo)
88+
#### View Week (Week View Page)
10889

109-
<a href="/assets/docs/calendar/today_tasks.png"><img src="/assets/docs/calendar/thumb-today_tasks.png" /></a>
90+
<a href="/assets/docs/events/view_week.png"><img src="/assets/docs/events/thumb-view_week.png" /></a>
91+
92+
The Week View page gives a week perspective of the Tasks and Events set for a given Week.
11093

111-
Here you will be able to see the Tasks that were defined to be done on this date.
112-
There is a set of filtering options you can use to fine tune the Tasks displayed.
94+
One area identified by some companies as a standard best practice is to view your task and events that are active for the week. In addition, if you are a designer and you wish to collaborate with another designer on a project in the system, you can use this view to see what their schedule looks like before including them as a resource.
95+
96+
From this page you can:
11397

114-
The task tab is located next to the events tab in the day view page and displays useful information and control options designed to help you better manage your task for that day. In order to have task you need to establish a project (Insert link to project details)
98+
* Switch to month view
99+
* Click on a day and switch to day view
100+
* View the weekly calendar for a company
101+
* Change Event Filter
102+
* All Events
103+
* Your events (This includes events assigned to you that you may not have created)
104+
* Events you created.
105+
* You can also move forward and backwards in weeks.
115106

116-
The main focus of this page allows you to:
107+
#### View Month (Month View Page)
117108

118-
* Pin Task
119-
* View the task overall progress
120-
* View the task name and the project name it is associated with
121-
* View the state date
122-
* View the Duration (either in hours or days)
123-
* View the actual finish date
124-
* View due in days. (Will show a plus or minus especially when the project has passed it due date)
125-
* Change the status of this task.
109+
<a href="/assets/docs/events/view_month.png"><img src="/assets/docs/events/thumb-view_month.png" /></a>
126110

127-
To change the status of a task, select the option from the dropdown and click "Update Task"
111+
The Monthly view shows the user which Tasks and/or Events are scheduled for each day in the Month.
128112

129-
Task are color coded and this is usefull for tracking a projects life cycle. You can see a legend for the colors below the task list.
113+
Generally when you create an event or task in the system, this will create links within the calendar dynamically showing you the start and finish dates within that month. Each link in the calendar is dynamic, so you can click on it and it will take you to the details of that object. This is particularly useful when you want a snap shot view of what’s on the agenda for the entire month.
130114

131-
From this page you can also move forward and backwards in time by either clicking on the arrows located at the top or by clicking on a calendar day from any calendar shown on the right side.
115+
Depending on how the administrator has the system configured, you can use filters to view calendar details for other [Departments](/modules/departments.html) or [Users](/modules/users.html), in addition to your own.
132116

133-
### View Today's Events (Today's Events Todo)
117+
From this page you can:
134118

135-
<a href="/assets/docs/calendar/today_events.png"><img src="/assets/docs/calendar/thumb-today_events.png" /></a>
119+
* Click on a task or event and view details
120+
* Change to Week View by clicking on the box icon on the left
121+
* Go forward and backwards in month views
122+
* Switch to year view by clicking on the "year view calendar
123+
* Set company filters
124+
* Set Event Filters.
136125

137-
This tab will show the user the Events marked for the given date depending on the existing filters.
126+
There are effectively two ways to move forward and backwards in time.
138127

139-
### Event add/edit page (Event add/edit)
128+
* Click the arrow icons at the top of the calendar (Located on the right and left site top)
129+
* On the bottom of the page you'll see the previous and next month quick links.
140130

141-
<a href="/assets/docs/calendar/addedit.png"><img src="/assets/docs/calendar/thumb-addedit.png" /></a>
131+
#### View Years (Year View Page)
142132

143-
With this form you will be able to create or change Events.
144-
You can invite other users to those events and make sure they get notified by email about those Events.
133+
<a href="/assets/docs/events/view_year.png"><img src="/assets/docs/events/thumb-view_year.png" /></a>
145134

146-
Events can be associated with projects, task, meetings, or anything else relative to your daily workflow. You can access the add/edit events page from the Day View.
135+
The Yearly view gives the user an overall view of the Year calendar and color codes the days depending on the existence of Tasks and/or Events.
147136

148-
How-to use this page:
137+
It's not uncommon to have events or task that last more than a calendar month. In addition you may want to be able to recall what your schedule looked like for the year. The year view gives you the option to view your intire schedule for the year.
149138

150-
* Enter a name or title for the event.
151-
* Define the type of event.
152-
* Note: This can be modified under the System Administration > System Look-up values to meet your needs
153-
* Associate this event to a project
154-
* Determine whether or not this is a private entry
155-
* Set start and finish date
156-
* Note: These will determine how it displays on the calendar view
157-
* You can recur this event to repeat weekly ect...
158-
* Assign internal resources
159-
* Note: To assign internal resources, click to highlight the name then select the arrow icon located under the box.
160-
* Type a description
161-
* Specify a time
162-
* This will replicate to the day view timeline
163-
* On the bottom of the page you have the option to send an email to the resources notifying them of the event.
139+
From the Year View you can:
140+
141+
* Move forward and backwards in time to next or previous year
142+
* Click on any given month to switch to that month
143+
* Set [Company](/modules/companies.html) Filters
144+
* Set Event Filters
145+
* Switch to week view by clicking on the week icon in each month displayed.

assets/docs/.DS_Store

-6 KB
Binary file not shown.

assets/docs/calendar/.DS_Store

-6 KB
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)