| | 1 | [[PageOutline(2-5,Contents,pullout)]] |
| | 2 | |
| | 3 | = Multi-week calendar for planning |
| | 4 | |
| | 5 | == Description |
| | 6 | |
| | 7 | A new macro `[[WeekPlan(...)]]` can be used to show calendars / week plans. Clicking on that calendar allows interactively adding events to days. Moving or resizing events is possible by drag-and-drop. Clicking an event allows editing or deleting. |
| | 8 | |
| | 9 | A "plan" is a named set of events. Multiple plans can be shown and edited in the same calendar in different colors. |
| | 10 | |
| | 11 | The calendar data can be accessed as an ''iCalendar'' feed at `/weekplan?format=ics&plan=xyz`. |
| | 12 | |
| | 13 | The [http://arshaw.com/fullcalendar/ FullCalendar] library is used for the UI. The data is stored in a new table in the Trac database. |
| | 14 | |
| | 15 | === Example |
| | 16 | |
| | 17 | `[[WeekPlan(plan=vacations|parties)]]` |
| | 18 | [[Image(example.png)]] |
| | 19 | |
| | 20 | === Limitations |
| | 21 | * There is no history or undo functionality. |
| | 22 | * There is no tracking of users. Everyone with `WEEK_PLAN` permission can freely edit any plan. |
| | 23 | * There is no support for collaborative editing. Changes only become visible when the page is manually refreshed. There is no conflict detection or resolution mechanism. |
| | 24 | * Timezones and daylight-saving-time might not yet be handled correctly. |
| | 25 | |
| | 26 | === Parameters |
| | 27 | * `plan`: Id of the shown collection of events. (required) |
| | 28 | * Can be a `|`-separated list of multiple plans. |
| | 29 | * `start`: A date in the first week shown. (Defaults to today.) |
| | 30 | * `weeks`: Number of weeks shown. (Defaults to one.) |
| | 31 | * `width`: Width of the calendar. (Defaults to 400) |
| | 32 | * `rowheight`: Height of one row of the calendar. (Defaults to 100) |
| | 33 | * `showweekends`: Show Saturdays and Sundays (Default is hidden) |
| | 34 | * `color`: Color of the events. (Defaults to `#3A87AD|#39AC60|#D7A388|#88BDD7|#9939AC|#AC9939`) |
| | 35 | * Can be a `|`-separated list of multiple colors. Each plan uses a different colors if multiple plans are specified. |
| | 36 | * `format`: One of the following formatting modes: |
| | 37 | * `multiweek`: A multi-week calendar. (The default) |
| | 38 | * `count`: A simple count of events. |
| | 39 | * `matchtitle`: A regexp that matches event titles. (Defaults to match all events.) |
| | 40 | |
| | 41 | |
| | 42 | == !Bugs/Feature Requests |
| | 43 | |
| | 44 | Existing bugs and feature requests for WeekPlanPlugin are |
| | 45 | [report:9?COMPONENT=WeekPlanPlugin here]. |
| | 46 | |
| | 47 | If you have any issues, create a |
| | 48 | [http://trac-hacks.org/newticket?component=WeekPlanPlugin&owner=lucid new ticket]. |
| | 49 | |
| | 50 | == Download |
| | 51 | |
| | 52 | Download the zipped source from [export:weekplanplugin here]. |
| | 53 | |
| | 54 | == Source |
| | 55 | |
| | 56 | You can check out WeekPlanPlugin from [http://trac-hacks.org/svn/weekplanplugin here] using Subversion, or [source:weekplanplugin browse the source] with Trac. |
| | 57 | |
| | 58 | == Installation |
| | 59 | |
| | 60 | Installation of the plugin requires the usual step, e.g. `easy_install http://trac-hacks.org/svn/weekplanplugin/trunk` and enable it in Trac's plugin admin page or by adding `weekplan.* = enabled` to the `[components]` section in trac.ini. |
| | 61 | |
| | 62 | A database upgrade will be required as usual (`trac-admin path-to-your-trac-environment upgrade`). |
| | 63 | |
| | 64 | Assign the new `WEEK_PLAN` permission to the appropriate Trac groups / users (e.g. in Trac's permission admin page). |
| | 65 | |
| | 66 | == Recent Changes |
| | 67 | |
| | 68 | [[ChangeLog(weekplanplugin, 3)]] |
| | 69 | |
| | 70 | == !Author/Contributors |
| | 71 | |
| | 72 | '''Author:''' [wiki:lucid] [[BR]] |
| | 73 | '''Maintainer:''' [[Maintainer]] [[BR]] |
| | 74 | '''Contributors:''' |
