Project

General

Profile

PluginGoogleCalendar » History » Version 8

Mischa The Evil, 2009-06-29 00:08
Added support-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 7 Mischa The Evil
The currently available, latest stable release of the plugin is version *0.1.1*.
16 5 Mischa The Evil
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 1 Eric Davis
h2. Compatibility
22
23 7 Mischa The Evil
This plugin is compatible with Redmine 0.8.x as well as with the current Redmine trunk.
24 1 Eric Davis
25
h2. Prerequisites
26
27
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>
28
29 7 Mischa The Evil
h2. Obtaining 
30 5 Mischa The Evil
31 7 Mischa The Evil
h3. Packaged releases
32 5 Mischa The Evil
33 7 Mischa The Evil
The plugin can be downloaded as packaged releases from:
34
* this GitHub-site: http://github.com/MischaTheEvil/redmine_google_calendar/downloads
35
* this MediaFire-account: http://www.mediafire.com/evildev
36
37
h3. Source on GitHub
38
39
bq. URL of the GitHub repository: http://github.com/MischaTheEvil/redmine_google_calendar/tree/master
40
41
The source of this plugin can be "cloned" from the GitHub-repo using two different methods:
42 1 Eric Davis
* using @git clone@ (Git version < 1.5.3)<pre>
43
$ cd {RAILS_ROOT}/vendor/plugins
44 5 Mischa The Evil
$ git clone git://github.com/MischaTheEvil/redmine_google_calendar.git
45
</pre>
46
47 1 Eric Davis
* 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 5 Mischa The Evil
$ sudo gem install git-rails
49 1 Eric Davis
$ git-rails install git://github.com/MischaTheEvil/redmine_google_calendar.git
50 4 Mischa The Evil
</pre>
51 5 Mischa The Evil
52 7 Mischa The Evil
h2. Installation
53 5 Mischa The Evil
54 7 Mischa The Evil
# Download the plugin from the available sources (see "Obtaining":http://www.redmine.org/wiki/redmine/PluginGoogleCalendar#Obtaining)
55
# 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)
56
# Restart Redmine
57
58 5 Mischa The Evil
h2. Global setup
59
60
Before you can actually use the plugin within the preferred projects some setup has to be done first.
61
62
# Go to "Administration -> Custom fields" and create a Project custom field of the type "long text", named 'Google Calendar IFrame' for example.
63 1 Eric Davis
# Go to "Administration -> Plugins -> Google Calendar Plugin > Configure" to configure the Google Calendar plugin:
64
* select the project custom field which contains the Google Calendar-iframe; in this example select the newly created project custom field "Google Calendar IFrame"
65
66 5 Mischa The Evil
h2. Project level setup
67 1 Eric Davis
68 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.
69
The project level setup consists of the following two tasks:
70 1 Eric Davis
71 5 Mischa The Evil
h3. Retrieve the embedding-code from Google
72 1 Eric Davis
73 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:
74
75 1 Eric Davis
# Click on "Settings" in the upper left hand corner
76
# Click on the "Calendars" tab
77
# Select the calendar you want to use
78
# In the "Embed This Calendar" section, copy the entire <code><iframe></code> code from the text box
79
80
(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.)
81
82
h3. Configure the plugin per each project
83
84
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.
85
In the preferred Redmine project, go to the "Project settings":
86
87 5 Mischa The Evil
# On the "Modules" tab: enable the plugin-module by checking "Google Calendar".
88 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.
89 5 Mischa The Evil
90 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.
91 7 Mischa The Evil
92
h2. Upgrading
93
94
# 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)
95
# Backup the currently deployed Google Calendar plugin (@cp -r /vendor/plugins/redmine_google_calendar /vendor/plugins/redmine_google_calendar-backup@)
96
# Reinstall the updated plugin:
97
** 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)
98
** When using the GitHub-sources: with either @git pull@ or @git-rails update@
99
# Restart your Redmine
100 5 Mischa The Evil
101
h2. Uninstalling
102
103
# Remove the directory _"redmine_google_calendar"_ from the plugin-directory _"../vendor/plugins"_
104
# Restart Redmine
105
106
h2. Licensing
107
108
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.
109 8 Mischa The Evil
110
h2. Support
111
112
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.
113
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.
114
115
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 most-active maintainer is connected (with the nickname @Mischa_The_Evil@).