Project

General

Profile

PluginGoogleCalendar » History » Version 15

Mischa The Evil, 2009-07-28 03:01
Added short description.

1 5 Mischa The Evil
h1. Google Calendar plugin
2 1 Eric Davis
3 5 Mischa The Evil
{{>toc}}
4 1 Eric Davis
5 15 Mischa The Evil
A plugin for Redmine which provides the project-manager a way to include a Google Calendar iframe as a tab within Redmine projects.
6
7 14 Mischa The Evil
h2. Packager and maintainer
8
9
* Mischa The Evil
10
11 5 Mischa The Evil
h2. Author
12
13
* Jim Mulholland
14
15
h2. Changelog
16
17
For the complete changelog see the @CHANGELOG@-file in the Redmine Google Calendar plugin directory.
18
19
h2. Latest stable release
20
21 11 Mischa The Evil
The currently available, latest stable release of the plugin is version *0.1.2*.
22 5 Mischa The Evil
23
h2. Description
24
25
The Google Calendar plugin is a simple Redmine plugin which provides the project-manager a way to include a Google Calendar iframe as a tab within Redmine projects. The calendar timezone will be user-dependent based off the timezone in your Redmine user account and defaulted to the timezone set in the <code><iframe></code> if the user does not have a timezone selected.
26
27 1 Eric Davis
h2. Compatibility
28
29 7 Mischa The Evil
This plugin is compatible with Redmine 0.8.x as well as with the current Redmine trunk.
30 1 Eric Davis
31
h2. Prerequisites
32
33
The plugin requires the "@tzinfo@":http://tzinfo.rubyforge.org/ gem to be available. If it does not already exist on your server, you can install it using a command like: <pre>$ sudo gem install tzinfo</pre>
34
35 7 Mischa The Evil
h2. Obtaining 
36 5 Mischa The Evil
37 7 Mischa The Evil
h3. Packaged releases
38 5 Mischa The Evil
39 7 Mischa The Evil
The plugin can be downloaded as packaged releases from:
40
* this GitHub-site: http://github.com/MischaTheEvil/redmine_google_calendar/downloads
41
* this MediaFire-account: http://www.mediafire.com/evildev
42
43
h3. Source on GitHub
44
45
bq. URL of the GitHub repository: http://github.com/MischaTheEvil/redmine_google_calendar/tree/master
46
47
The source of this plugin can be "cloned" from the GitHub-repo using two different methods:
48 10 Mischa The Evil
* using @git clone@ (Git version < 1.5.3):<pre>
49 1 Eric Davis
$ cd {RAILS_ROOT}/vendor/plugins
50 5 Mischa The Evil
$ git clone git://github.com/MischaTheEvil/redmine_google_calendar.git
51
</pre>
52
53 10 Mischa The Evil
* using @git-rails@ (Git version >= 1.5.3 -- Because the @git-rails@ gem uses Git Submodules which were introduced in v. 1.5.3):<pre>
54 5 Mischa The Evil
$ sudo gem install git-rails
55 1 Eric Davis
$ git-rails install git://github.com/MischaTheEvil/redmine_google_calendar.git
56 4 Mischa The Evil
</pre>
57 5 Mischa The Evil
58 7 Mischa The Evil
h2. Installation
59 5 Mischa The Evil
60 7 Mischa The Evil
# Download the plugin from the available sources (see "Obtaining":http://www.redmine.org/wiki/redmine/PluginGoogleCalendar#Obtaining)
61
# Install the plugin as described at: http://www.redmine.org/wiki/redmine/Plugins, according to the way you've obtained the plugin (this plugin does not require a plugin database migration)
62
# Restart Redmine
63
64 5 Mischa The Evil
h2. Global setup
65
66
Before you can actually use the plugin within the preferred projects some setup has to be done first.
67
68
# Go to "Administration -> Custom fields" and create a Project custom field of the type "long text", named 'Google Calendar IFrame' for example.
69 1 Eric Davis
# Go to "Administration -> Plugins -> Google Calendar Plugin > Configure" to configure the Google Calendar plugin:
70
* select the project custom field which contains the Google Calendar-iframe; in this example select the newly created project custom field "Google Calendar IFrame"
71
72 5 Mischa The Evil
h2. Project level setup
73 1 Eric Davis
74 5 Mischa The Evil
After you have completed the global setup of the plugin you can select which projects will actually be able to use the feature brought by the plugin. Due to the way the plugin implements this feature it is also possible to configure which Google Calendar is actually being displayed on a project level base.
75
The project level setup consists of the following two tasks:
76 1 Eric Davis
77 5 Mischa The Evil
h3. Retrieve the embedding-code from Google
78 1 Eric Davis
79 5 Mischa The Evil
You should retrieve the actual Google Calendar embedding-code (<code><iframe></code>). Therefore, go to the Google Calendar which you want to embed and:
80
81 1 Eric Davis
# Click on "Settings" in the upper left hand corner
82
# Click on the "Calendars" tab
83
# Select the calendar you want to use
84
# In the "Embed This Calendar" section, copy the entire <code><iframe></code> code from the text box
85
86
(If this is a private calendar, you will have to replace the "src" in the <code><iframe></code> with the HTML found by clicking the blue "HTML" block in the "Private Address" section on the same page.)
87 10 Mischa The Evil
88
For detailed help on how to obtain the calendar-information see http://www.google.com/calendar/embed/EmbedHelper_en.html.
89 1 Eric Davis
90
h3. Configure the plugin per each project
91
92
Now the copied <code><iframe></code> code should be added to a Redmine project. At first we need to make sure the plugin is enabled for the project.
93
In the preferred Redmine project, go to the "Project settings":
94
95 5 Mischa The Evil
# On the "Modules" tab: enable the plugin-module by checking "Google Calendar".
96 1 Eric Davis
# On the "Information" tab: paste the <code><iframe></code> code, that you have copied to your clipboard from the Google Calendar you want to embed, into the 'Google Calendar IFrame' project custom field you created in the global setup under step 1.
97 5 Mischa The Evil
98 3 Mischa The Evil
After that, a new item named "Calendar" will show up in the project menu. Click on this item to see your Google Calendar.
99 7 Mischa The Evil
100 12 Mischa The Evil
h2. FAQ
101
102
# On the project overview tab I see the iframe code. Could that be removed?
103 13 Mischa The Evil
** Yes, see Redmine patch #1746 which provides an option to project custom fields to hide them from the project overview especially written for this purpose.
104 12 Mischa The Evil
105 7 Mischa The Evil
h2. Upgrading
106
107
# When using packaged releases: download the latest source of the plugin from the available sources (see "Obtaining":http://www.redmine.org/wiki/redmine/PluginGoogleCalendar#Obtaining)
108
# Backup the currently deployed Google Calendar plugin (@cp -r /vendor/plugins/redmine_google_calendar /vendor/plugins/redmine_google_calendar-backup@)
109
# Reinstall the updated plugin:
110
** When using packaged releases: Unpack the downloaded file to your Redmine into the plugin-directory _"../vendor/plugins"_ and let it overwrite your outdated plugin instance (which you've backed-up earlier)
111
** When using the GitHub-sources: with either @git pull@ or @git-rails update@
112
# Restart your Redmine
113 5 Mischa The Evil
114
h2. Uninstalling
115
116
# Remove the directory _"redmine_google_calendar"_ from the plugin-directory _"../vendor/plugins"_
117
# Restart Redmine
118
119
h2. Licensing
120
121 9 Mischa The Evil
This plugin is open-source and licensed under the "GNU General Public License v2":http://www.gnu.org/licenses/old-licenses/gpl-2.0.html (GPL). See the included @COPYRIGHT.txt@ and @GPL.txt@ files for details.
122 1 Eric Davis
123 9 Mischa The Evil
* ©2009, Mischa The Evil (http://www.evil-dev.net)
124
* ©2008, Jim Mulholland (http://www.squeejee.com)
125
126 8 Mischa The Evil
h2. Support
127
128
If you would like to report a bug or request a new feature you can open a new issue at the issue-tracking section of the plugins' GitHub site: http://github.com/MischaTheEvil/redmine_google_calendar/issues.
129 1 Eric Davis
You can also post your feedback about the plugin in the dedicated plugin-section of the "Redmine forums":http://www.redmine.org/projects/redmine/boards/3.
130 8 Mischa The Evil
131 9 Mischa The Evil
As an alternative you can also join the @#redmine@-channel on the "freenode":http://freenode.net/irc_servers.shtml IRC network to see if the active maintainer is connected (with the nickname @Mischa_The_Evil@).