Extended Fields plugin for Redmine/ChiliProject¶

• Extended Fields plugin for Redmine/ChiliProject
  • New properties
    • Hint
    • On registration
  • New custom field types
    • Wiki text
    • Link
    • Project
  • Templates for custom fields
    • Templates by type
    • Templates by custom field name
  • Configurable columns for listings
    • Projects listing (in “Administration”)
    • Users listing (in “Administration”)
    • Issues listings
  • Install
  • Upgrade

The Extended Fields plugin for Redmine and ChiliProject extends custom fields by adding new properties, new custom field types and by allowing to customize views (rendering) of custom field values.

This plugin can also be used as a “framework” for creating other plugins (like it is used by the Extended Profile plugin).

The Extended Fields plugin extends Redmine/ChiliProject by adding:

New properties¶

This plugin adds new properties (into the custom field creation/edition form):

Hint¶

This plugin adds the “Hint” property value of which is displayed below the custom field input element in a form.

On registration¶

To let users control the registration form this plugin adds new user custom field property “On registration”. If this property is disabled the custom field won’t be shown in the registration form.

New custom field types¶

This plugin also adds the following new custom field types:

Wiki text¶

Redmine and ChiliProject have built-in custom field type “text” (more known as “Long text”) but this type does not support Wiki formatting. This plugin provides a solution by adding new type “Wiki text”.

Link¶

This plugin adds new type “Link” which supports HTTP URLs and renders them as links.

Project¶

With this plugin you can now create a custom field allowing to select a project from the projects list. The value of such custom field is rendered as a link to project.

Templates for custom fields¶

But the most interesting feature of this plugin, perhaps, is support for custom field templates. With a template you can extend any custom field of any type (by the way, this is how the “Project” type is rendered)! For example, you can make integer contain the percentage sign or boolean be shown as a checkbox...

So let’s review how this can be done:

Templates by type¶

To create a template for custom fields of some type create an eRuby file _<type>.html.erb in the app/views/custom_values/common directory. For example, file app/views/custom_values/common/_bool.html.erb will specify view for boolean custom fields.

Check also this page for details and sample.

Templates by custom field name¶

It is also possible to specify a template for a custom field with a particular name. Saying you have a custom field named “Very special custom field” of type string. To create a template for this field create an eRuby file _very_special_custom_field.html.erb in the string subdirectory of the app/views/custom_values directory.

Check also this page for details and sample.

Configurable columns for listings¶

The plugin also adds possibility to specify, which columns should be shown in listings and adds new columns.

Projects listing (in “Administration”)¶

The projects listing in the “Administration” section now supports columns customization. Besides main attributes of projects the plugin also adds custom fields, issues counts by tracker, status and priority, project modules statuses and other special columns.

Users listing (in “Administration”)¶

The users listing in the “Administration” section now supports columns customization. Besides main attributes of users the plugin also adds custom fields and special columns.

Issues listings¶

Some special columns were also added to the issue listing.

Install¶

To install this plugin do:

• For Redmine 2.x.x and above:
  • Copy extended_fields directory to #{RAILS_ROOT}/plugins.
  • Run: rake redmine:plugins:migrate RAILS_ENV=production.
• For older Redmine and ChiliProject:
  • Copy extended_fields directory to #{RAILS_ROOT}/vendor/plugins.
  • Run: rake db:migrate:plugins RAILS_ENV=production.
• Restart Redmine/ChiliProject.

Upgrade¶

As Redmine 2.5 comes with support of Wiki formatting for the “Long text” type, the version 0.2.3 of Extended Fields plugin drops the “Wiki” custom field type in favor of “Long text”, but only if it’s run under Redmine 2.5! I.e, when Extended Fields 0.2.3 is run under Redmine 2.4 or below the “Wiki” type will be still available.

So, Extended Fields 0.2.3 comes with the special script to migrate “Wiki” custom fields to the “Long text” type, when it’s run under Redmine 2.5 or above. But, it changes nothing under Redmine 2.4 or below! Yet still Redmine remembers, that the migration script has been run, and therefore won’t run it, when you upgrade to Redmine 2.5!

So, if you have upgraded Extended Fields to 0.2.3 under Redmine 2.4 or below, when upgrading Redmine to 2.5 or above you need to:

• Rename db/migrate/004_migrate_wiki_custom_fields.rb to db/migrate/999_migrate_wiki_custom_fields.rb.
  (or any other large number instead of 999)
• Run the migration: rake redmine:plugins:migrate RAILS_ENV=production