wiki:CustomFieldAdminPlugin

Version 2 (modified by osimons, 7 years ago) (diff)

Added another author to page and tags.

Trac Custom Field Admin plugin

Description

This plugin is a Web Admin page for administrating custom fields - adding, modifying and deleting them without editing the trac.ini file directly.

The plugin is developed and tested for Trac 0.10.x (should work on 0.9.x). No plans yet for converting it to 0.11.

This plugin is a cooperation between CodeResort.com and Optaros.com, and is made freely available under a BSD license.

Known issues:

  • If your web server runs multiple processes, the other processes will not be able to delete custom fields - see ticket:3833 and ticket:5135 for progress on this issue.

Bugs/Feature Requests

Existing bugs and feature requests for CustomFieldAdminPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out CustomFieldAdminPlugin from here using Subversion, or browse the source with Trac.

Example

This plugin requires Web Admin plugin (wiki:WebAdmin).

Enable the plugin in trac.ini:

[components]
customfieldadmin.* = enabled

The plugin also has an API that can be called from other code if you need to create or modify custom fields. Here is an interactive session as example:

from trac.env import Environment
from customfieldadmin.api import CustomFields

myenv = Environment('/path/to/env')
mycfcomp = CustomFields(myenv)

# Get Cusom fields (list of dicts)
myfields = mycfcomp.get_custom_fields(myenv)
for item in myfields: print item

# Create a custom field - text box
mycfdict = {                # a template dictionary
    'name': 'test01',       # name of field (alphanumeric only)
    'type': 'text',         # text|checkbox|select|radio|textarea
    'label': 'Test 01',     # description
    'value': 'first test',  # default value for field content
    'options': None,        # options for select and radio types (list, leave first empty for optional)
    'cols': None,           # number of columns for text area
    'rows': None,           # number of rows for text area
    'order': 0 }            # specify sort order for field, 0 for last
mycfcomp.update_custom_field(myenv, mycfdict, create=True)

# Updating
mycfdict['type'] = 'select'
mycfdict['options'] = ['', 'one', 'two', 'three']
mycfdict['value'] = None
mycfcomp.update_custom_field(myenv, mycfdict)

# And deleting an existing custom field
mycfcomp.delete_custom_field(myenv, mycfdict)

Recent Changes

[14260] by rjollos on 2014-11-14 09:21:37
0.2.10: Support Trac 1.1.2 in which the cols property of Custom Field textareas has been removed. Fixes #11855.
[14259] by rjollos on 2014-11-14 09:17:17
0.2.9: Support fine-grained permission checks on the Custom Field admin pages. Fixes #11826.
[13733] by osimons on 2014-03-10 00:06:34
CustomFieldAdminPlugin: Test for #10082.

Author/Contributors

Authors: osimons, cbalan
Contributors: