Miscellaneous functions to ticket view: CKEditor, navigation table, descriptions, sorting versions


The following plugin adds additional functionality to your Trac site. All changes can be implemented in the site's trac.ini file.

Component TextAreaDescription

Shows next to a text area a description what the field is for, such as the description itself or any custom description.

Default values for options:

description_descr = 
descr_template = <div style="white-space: normal; height: 250px; overflow: scroll;" class="system-message">%s<div>

TextAreaDescription - red box under "Beschreibung" (Description) and HtmlContent (Editor):

Screenshot of text area description (red box)

Component CssTemplate

Add links to style sheets located in templates folder.

The stylesheet files (CSS files) starting with "all_templates" are added for all Trac sites. The CSS files starting with the template name (without .html-suffix) are applied to the specific template.

To apply the changes you need to restart the Trac server.

Examples for files which resides in projects templates folder:

all_templates_general.css added to all Trac sites
ticket_additional.css only added for ticket.html pages

For a discussion in Trac about this topic, see Trac ticket #9683.

Component CustomizedTicketView

Supports changes of the ticket view:

  • disables field field-reporter, so it cannot be changed anymore
  • disables button Reply, so no comment can be made to any description

CustomizedTicketView - creator "Ersteller" is disabled, so it cannot be changed:

Showing hiding creator of ticket (Component `CustomizedTicketView`)

See also: SimpleTicketPlugin

Component SortMilestoneVersion

Sorts drop-down lists of version and milestone regardless of the case and make milestone a mandatory field, when a default milestone is set.

Default behavior of Trac for sorting milestones is:

inbox, v1, v2, Inbox, V1, V2

This plugin sorts it as follows:

inbox, Inbox, v1, V1, v2, V2

SortMilestoneVersion - milestones are sorted by name regardless of their case (uppercase "TBD" is next to lowercase "tbd"):

Sorting milestones by name instead of due date (Component `SortMilestoneVersion`)

SortMilestoneVersion - versions are sorted in alphabetical order instead of their due / completion date:

Sorting versions by name instead of due date (Component `SortMilestoneVersion`)

Component TicketNavigation

Implements an extra Navigation menu by dividing the main ticket information in several div areas and providing a "jump-to" to the areas which are represented in the navigation box.

TicketNavigation - list of headers are as toolbox under mainnav:

Showing ticket navigation box (Component `TicketNavigation`)

Bugs/Feature Requests

Existing bugs and feature requests for TicketNavPlugin are here.

If you have any issues, create a new ticket.


0 / 2


1 / 1


Download the zipped source from here.

Or download the pre-compiled Python egg.


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


General instructions on installing Trac plugins can be found on the TracPlugins page.


Sample configuration of TextAreaDescription

descr_template = <div style="white-space: normal; height: 250px; overflow: auto; text-align: left;" class="system-message">%s<div>
description_descr = <div style="font-weight: bold">Folgende Fragen sollen beantworten werden:<br/></div><ul><li>Was wurde gemacht?</li></ul>

Sample configuration of HtmlContent

description_format = html
editor_source = site/js/ckeditor/ckeditor.js
editor_replace = <script type="text/javascript">CKEDITOR.replace('@FIELD_NAME@', {toolbar: 'custom'});</script>
additional_css = site/css/add_ticket.css

Recent Changes

14674 by framay on 2015-06-16 04:59:02
fixes #12386: added license
13249 by aleuhe on 2013-05-27 14:16:31
TextAreaDescription and it's .css file have been changed a little bit.

the Trac.ini has to be adapted:

The following attributes are now obsolete:
ATTRNAME.css_style = ...

The following attributes have to be added
descr_template = <div class="ticket-descr %s">%s%s<div>
releasenotes_relevant_tag = <p class = "rntag">Release-Notes relevant!</p>
releasenotes_relevant = <COMMA-SEPARATED LIST OF ATTRNAMES>

11355 by aleuhe on 2012-03-02 14:14:05


Author: framay
Maintainer: Franz

Last modified 20 months ago Last modified on Apr 22, 2022, 6:13:54 AM

Attachments (7)

Download all attachments as: .zip