HowTo create a custom Redmine theme » History » Version 5

« Previous - Version 5/8 (diff) - Next » - Current version
Jean-Philippe Lang, 2011-01-02 17:21
custom javascript for 1.1.0


HowTo create a custom Redmine theme

Redmine offers basic support for themes. Themes can override stylesheets (application.css) and add some custom javascript.

Creating a new theme

Create a directory in public/themes. The directory name will be used as the theme name.

Example:

public/themes/my_theme

Create your custom application.css and save it in a subdirectory named stylesheets:

public/themes/my_theme/stylesheets/application.css

Here is an example of a custom stylesheet that only override a few settings:

/* load the default Redmine stylesheet */
@import url(../../../stylesheets/application.css);

/* add a logo in the header */
#header {
    background: #507AAA url(../images/logo.png) no-repeat 2px;
    padding-left: 86px;
}

/* move the project menu to the right */
#main-menu { 
    left: auto;
    right: 0px;
}

This example assume you have an image located at my_theme/images/logo.png.

You can download this sample theme as a starting point for your own theme. Extract it in the public/themes directory.

Adding custom javascript

Simply put your javascript in javascripts/theme.js and it will automatically be loaded on each page (Redmine >= 1.1.0 only).

Applying the theme

Go to "Administration -> Settings" and select your newly created theme in the "Theme" drop-down list. Save your settings.
Redmine should now be displayed using your custom theme.

If you are using Redmine < 1.1.0, you may need to restart the application so that it shows up in the list of available themes.

sample_theme.tar.gz (5.98 KB) Jean-Philippe Lang, 2007-10-10 19:48