Project

General

Profile

PluginGoogleCalendar » History » Version 6

Mischa The Evil, 2009-06-26 01:22
Added operator due to GitHub download-facility :) TODO: Add info about download-section.

1 5 Mischa The Evil
h1. Google Calendar plugin
2 1 Eric Davis
3 5 Mischa The Evil
{{>toc}}
4 1 Eric Davis
5 5 Mischa The Evil
h2. Author
6
7
* Jim Mulholland
8
9
h2. Changelog
10
11
For the complete changelog see the @CHANGELOG@-file in the Redmine Google Calendar plugin directory.
12
13
h2. Latest stable release
14
15
The currently available, latest stable release of the plugin is version **0.1.1**.
16
17
h2. Description
18
19
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.
20
21 6 Mischa The Evil
Currently, the only way to install is using Git and/or GitHub:
22 1 Eric Davis
23 5 Mischa The Evil
bq. URL: http://github.com/MischaTheEvil/redmine_google_calendar/tree/master
24 1 Eric Davis
25 5 Mischa The Evil
h2. Compatibility
26 1 Eric Davis
27 5 Mischa The Evil
This plugin is compatible with Redmine 0.8.x as well as with current Redmine trunk.
28
29
h2. Latest release
30
31
* @0.1.1@
32
33
h2. Prerequisites
34
35
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>
36
37
h2. Installation 
38
39
bq. General Redmine plugin installation information can be found "here":http://www.redmine.org/wiki/redmine/Plugins.
40
41
The installation of this plugin can be done using two different methods:
42
* using @git clone@ (Git version < 1.5.3)<pre>
43 1 Eric Davis
$ cd {RAILS_ROOT}/vendor/plugins
44 5 Mischa The Evil
$ git clone git://github.com/MischaTheEvil/redmine_google_calendar.git
45 1 Eric Davis
</pre>
46 4 Mischa The Evil
47 5 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>
48 1 Eric Davis
$ sudo gem install git-rails
49 5 Mischa The Evil
$ git-rails install git://github.com/MischaTheEvil/redmine_google_calendar.git
50 1 Eric Davis
</pre>
51 3 Mischa The Evil
52 5 Mischa The Evil
The plugin does not require a database migration afterwards. It does require a restart of Redmine after the installation before the plugin is detected by Redmine and useable.
53 1 Eric Davis
54 5 Mischa The Evil
h2. Global setup
55
56
Before you can actually use the plugin within the preferred projects some setup has to be done first.
57
58
# Go to "Administration -> Custom fields" and create a Project custom field of the type "long text", named 'Google Calendar IFrame' for example.
59 1 Eric Davis
# Go to "Administration -> Plugins -> Google Calendar Plugin > Configure" to configure the Google Calendar plugin:
60
* select the project custom field which contains the Google Calendar-iframe; in this example select the newly created project custom field "Google Calendar IFrame"
61
62 5 Mischa The Evil
h2. Project level setup
63 1 Eric Davis
64 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.
65
The project level setup consists of the following two tasks:
66 1 Eric Davis
67 5 Mischa The Evil
h3. Retrieve the embedding-code from Google
68 1 Eric Davis
69 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:
70
71 1 Eric Davis
# Click on "Settings" in the upper left hand corner
72
# Click on the "Calendars" tab
73
# Select the calendar you want to use
74 5 Mischa The Evil
# In the "Embed This Calendar" section, copy the entire <code><iframe></code> code from the text box
75 1 Eric Davis
76 5 Mischa The Evil
(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.)
77 3 Mischa The Evil
78 5 Mischa The Evil
h3. Configure the plugin per each project
79 1 Eric Davis
80 5 Mischa The Evil
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.
81
In the preferred Redmine project, go to the "Project settings":
82 1 Eric Davis
83 5 Mischa The Evil
# On the "Modules" tab: enable the plugin-module by checking "Google Calendar".
84
# 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.
85 3 Mischa The Evil
86 5 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.
87
88
h2. Uninstalling
89
90
# Remove the directory _"redmine_google_calendar"_ from the plugin-directory _"../vendor/plugins"_
91
# Restart Redmine
92
93
h2. Licensing
94
95
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 @GPL.txt@ file for details.