wiki:ContextChromePlugin

Add context-aware styles to Trac page widgets

Description

This plugin offers the capability to style your Trac pages and page widgets according to the type of ticket you are dealing with.

Key features:

  1. Wiki Link Decoration by age of wiki page: add "new" css-class to link to a wiki page that is recent. You can specify the age in trac.ini.
  2. Decayed Wiki: indicate how old the wiki page is. You can specify colors by age in seconds at trac.ini; requires Python 2.7 or later.
  3. Ticket Link Decoration by field value: Set css-class to link to tickets by field value. You can specify field names at trac.ini.
  4. Decorate over intertrac links, with XmlRpcPlugin and corsEnabler included.
  5. Ticket color by Type: Set css-class by type or specified field value on ticket. You can design for each type of ticket with trac:wiki:CookBook/SiteStyleCss feature.
  6. Wiki color by tags: Set css-class by tags added by TagsPlugin.
  7. marked for validation: Set css-class to field specified by validator, such as TracTicketValidatorPlugin or TracTicketConditionalValidatePlugin.

If you want to edit the CSS inline in the browser, use WikiCssPlugin or ThemeEnginePlugin. If you want to modify the decoration link to a new page, edit the files site.html and site.css.

Bugs/Feature Requests

Existing bugs and feature requests for ContextChromePlugin are here.

If you have any issues, create a new ticket.

defect

1 / 2

Download

Download the zipped source from here.

Source

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

Installation

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

Example

Sample trac.ini stanza:

[components]
contextchrome.linkdeco.internalstylesheet = enabled
contextchrome.linkdeco.ticketlinkdecorator = enabled
contextchrome.linkdeco.wikilinknewdecolator = enabled
contextchrome.style.typeclasstoticket = enabled
decayed.wiki.decayedwiki = enabled

Wiki age to decorate or not

Example trac.ini:

[wiki]
wiki_new_info_second = 432000

Decayed Wiki

Sample trac.ini where the background of wiki pages are colored by age, ie white for modified in a day, light grey for in a week, and so on:

[wiki]
decay_colors = 86400: #ffffff, 604800: #eeeeee, 2678400: #dddddd, 31536000: #aaaaaa, 2147483647: #777777

Ticket link decoration by field value

Sample trac.ini:

[ticket]
decorate_fields = owner, milestone, type

Sample style.css:

a.type_is_defect      { background-color: #f5deb3; /* wheat */    }
a.type_is_enhancement { background-color: #87ceeb; /* sky blue */ }
a.type_is_task        { background-color: #ffd700; /* gold */     }
a.owner_is_somebody   { border: maroon thin solid;                }

To decorate over intertrac links, use XmlRpcPlugin and CrossOriginResourceSharingEnabler as follows:

Ticket color by Type

Sample style.css:

body.type_is_defect      { background-color: #f5deb3; /* wheat */    }
body.type_is_enhancement { background-color: #87ceeb; /* sky blue */ }
body.type_is_task        { background-color: #ffd700; /* gold */     }
body.tagged_as_sometag   { background-color: #ffcccc;                }

Marked for validation

Enable required TracTicketValidatorPlugin.

Sample trac.ini:

[ticketvalidator]
validates = keywords, vote
keywords.rule = .+
vote.rule = .+

Recent Changes

13414 by matobaa on 2013-10-15 13:43:24
ContextChromePlugin: fix a bug for new ticket page added on [13404].
13413 by matobaa on 2013-10-12 03:55:09
ContextChromePlugin: fix a bug for CORS - Cross Origin Resource Sharing
refs #6827
13405 by matobaa on 2013-10-05 01:15:36
ContextChromePlugin.TypeClassToTicket: Support for TagsPlugin.
(more)

Author/Contributors

Author: matobaa
Maintainer: Matoba Akihiro
Contributors:

Last modified 9 months ago Last modified on Dec 7, 2015, 11:08:56 AM

Attachments (5)

Download all attachments as: .zip