= Trac Tweak UI

== Description

This plugin implements a Javascript deployment platform, which enables Trac administrators to easily tweak Trac pages by using Javascript.

Key features:
 * Apply different javascripts to different pages by matching regular expression.
 * Supports Trac web admin.

Alternative: AddStaticResourcesPlugin accomplishes many of the same goals. Very simple deployment and trac.ini configuration (no webadmin screens). Doesn't require an environment upgrade.

See: '''ZoomQuiet''' ~ Collection KSPEG Trac hacking

== Bugs/Feature Requests

Existing bugs and feature requests for TracTweakUiPlugin are 
[report:9?COMPONENT=TracTweakUiPlugin here].

If you have any issues, create a 
[/newticket?component=TracTweakUiPlugin new ticket].

[[TicketQuery(component=TracTweakUiPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [download:tractweakuiplugin here].

== Source

You can check out TracTweakUiPlugin from [http://trac-hacks.org/svn/tractweakuiplugin here] using Subversion, or [source:tractweakuiplugin browse the source] with Trac.

== Configuration

 1. Uninstall Trac Tweak UI if you have installed before.
 1. Change to the directory containing setup.py.
 1. If you want to install this plugin globally, that will install this plugin to the Python path:
  * python setup.py install
 1. If you want to install this plugin to Trac instance only:
  * python setup.py bdist_egg
  * copy the generated egg file to the Trac instance's plugin directory:
  {{{
cp dist/*.egg /srv/trac/env/plugins
}}}
 1. Configure your `trac.ini` file:
  {{{#!ini
[components]
tractweakui.* = enabled
}}}
 1. Add following directory structure to Trac environment's htdocs directory, using `editcc` as an example:
  {{{
htdocs/tractweakui/
}}}

  Or you can simply copy the htdocs/tractweakui/ in source to Trac environment's htdocs directory.

== Example

=== Admin Trac Tweak UI with addon javascript plugins

 1. Enter Trac's '''Web Admin''', select '''TracTweakUI Admin'''
 1. Add url path(regular expression): '''/newticket'''
 1. Select '''/newticket''', then select filter '''editcc'''
 1. Click '''Load Default''', and edit filter javascript, then '''Save'''
 1. Now click '''New Ticket''' to test the '''editcc''' Javascript plugin.
  * '''Screenshot of Admin'''
   * [[Image(trac_tweakui_demo_1.png)]]
  * '''Screenshot of editcc'''
   * [[Image(trac_editcc.png)]]

=== Admin Trac Tweak UI with any other javascript plugins

 1. Take [http://plugins.jquery.com/project/ac autocomplete] for instance.
 1. Prepare autocomplete directory in the Trac environment:
  {{{
mkdir /path/to/trac/environment/htdocs/tractweakui/autocomplete
cp main.css /path/to/trac/environment/htdocs/tractweakui/autocomplete/
cp jquery.autocomplete.css /path/to/trac/environment/htdocs/tractweakui/autocomplete/
cp jquery.autocomplete.js /path/to/trac/environment/htdocs/tractweakui/autocomplete/
cp jquery.bgiframe.min.js /path/to/trac/environment/htdocs/tractweakui/autocomplete/
cp indicator.gif /path/to/trac/environment/htdocs/tractweakui/autocomplete/
touch /path/to/trac/environment/htdocs/tractweakui/autocomplete/__template__.js
}}}
 1. Edit __template__.js (optional):
 {{{
$(function() {
	var months = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'];
	$("#field-cc").autocomplete(months);
});
}}}
 1. Now you can admin and test autocomplete Javascript plugins as described above.

== Recent Changes

[[ChangeLog(tractweakuiplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:richard] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''