Changes between Version 8 and Version 9 of TracTweakUiPlugin


Ignore:
Timestamp:
Jul 27, 2015, 12:37:26 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • TracTweakUiPlugin

    v8 v9  
    1 = Trac Tweak UI =
    2 [[TOC]]
    3  SEE:'''ZoomQuiet''' ~ Collection KSPEG Trac hacking
     1= Trac Tweak UI
    42
    5 == Description ==
     3== Description
    64
    7  * Its purpose is to implement a javascript deployment platform, which enable trac administrators to easy tweak trac pages by simply using javascript.
    8  * It can apply different javascripts to different pages by matching regular expression.
    9  * Support trac web admin
     5This plugin implements a Javascript deployment platform, which enables Trac administrators to easily tweak Trac pages by using Javascript.
    106
    11 == Bugs/Feature Requests ==
     7Key features:
     8 * Apply different javascripts to different pages by matching regular expression.
     9 * Supports Trac web admin.
     10
     11Alternative: AddStaticResourcesPlugin accomplishes many of the same goals. Very simple deployment and trac.ini configuration (no webadmin screens). Doesn't require an environment upgrade.
     12
     13See: '''ZoomQuiet''' ~ Collection KSPEG Trac hacking
     14
     15== Bugs/Feature Requests
    1216
    1317Existing bugs and feature requests for TracTweakUiPlugin are
    … …  
    1519
    1620If you have any issues, create a
    17 [http://trac-hacks.org/newticket?component=TracTweakUiPlugin&owner=richard new ticket].
     21[/newticket?component=TracTweakUiPlugin new ticket].
    1822
    19 == Download ==
     23[[TicketQuery(component=TracTweakUiPlugin&group=type,format=progress)]]
     24
     25== Download
    2026
    2127Download the zipped source from [download:tractweakuiplugin here].
    2228
    23 == Source ==
     29== Source
    2430
    2531You can check out TracTweakUiPlugin from [http://trac-hacks.org/svn/tractweakuiplugin here] using Subversion, or [source:tractweakuiplugin browse the source] with Trac.
    2632
    27 == Configuration ==
     33== Configuration
     34
    2835 1. Uninstall Trac Tweak UI if you have installed before.
    29 
    30  2. Change to the directory containning setup.py.
    31 
    32  3. If you want to install this plugin globally, that will install this plugin to the python path:
     36 1. Change to the directory containing setup.py.
     37 1. If you want to install this plugin globally, that will install this plugin to the Python path:
    3338  * python setup.py install
    34 
    35  4. If you want to install this plugin to trac instance only:
     39 1. If you want to install this plugin to Trac instance only:
    3640  * python setup.py bdist_egg
    37   * copy the generated egg file to the trac instance's plugin directory
     41  * copy the generated egg file to the Trac instance's plugin directory:
    3842  {{{
    3943cp dist/*.egg /srv/trac/env/plugins
    4044}}}
    41 
    42  5. Config trac.ini:
    43   {{{
     45 1. Configure your `trac.ini` file:
     46  {{{#!ini
    4447[components]
    4548tractweakui.* = enabled
    4649}}}
    47 
    48  6. Add following directory structure to trac environment's htdocs directory(using editcc as example):
     50 1. Add following directory structure to Trac environment's htdocs directory, using `editcc` as an example:
    4951  {{{
    5052htdocs/tractweakui/
    5153}}}
    5254
    53   Or you can simply copy the htdocs/tractweakui/ in source to trac environment's htdocs directory.
     55  Or you can simply copy the htdocs/tractweakui/ in source to Trac environment's htdocs directory.
    5456
    55 == Example ==
    56 === Admin Trac Tweak UI with addon javascript plugins ===
    57  1. Enter trac's '''Web Admin''', select '''TracTweakUI Admin'''
     57== Example
     58
     59=== Admin Trac Tweak UI with addon javascript plugins
     60
     61 1. Enter Trac's '''Web Admin''', select '''TracTweakUI Admin'''
    5862 1. Add url path(regular expression): '''/newticket'''
    5963 1. Select '''/newticket''', then select filter '''editcc'''
    6064 1. Click '''Load Default''', and edit filter javascript, then '''Save'''
    61  1. Now click '''New Ticket''' to test the '''editcc''' javascript plugin.
    62   * Screenshot of Admin
     65 1. Now click '''New Ticket''' to test the '''editcc''' Javascript plugin.
     66  * '''Screenshot of Admin'''
    6367   * [[Image(trac_tweakui_demo_1.png)]]
    64   * Screenshot of editcc
     68  * '''Screenshot of editcc'''
    6569   * [[Image(trac_editcc.png)]]
    6670
    67 === Admin Trac Tweak UI with any other javascript plugins ===
    68  1. take [http://plugins.jquery.com/project/ac autocomplete] for instance
     71=== Admin Trac Tweak UI with any other javascript plugins
    6972
    70  1. Prepare autocomplete directory in trac environment
     73 1. Take [http://plugins.jquery.com/project/ac autocomplete] for instance.
     74 1. Prepare autocomplete directory in the Trac environment:
    7175  {{{
    7276mkdir /path/to/trac/environment/htdocs/tractweakui/autocomplete
    … …  
    7882touch /path/to/trac/environment/htdocs/tractweakui/autocomplete/__template__.js
    7983}}}
    80 
    81  1. Edit __template__.js (optional)
     84 1. Edit __template__.js (optional):
    8285 {{{
    8386$(function() {
    … …  
    8689});
    8790}}}
     91 1. Now you can admin and test autocomplete Javascript plugins as described above.
    8892
    89  1. Now, you can admin and test autocomplete javascript plugins as described above.
    90  
    91 == Related Plugins ==
    92  * AddStaticResourcesPlugin - Attempting to accomplish many of the same goals in a different way.  Very simple deployment and .ini configuration (no webadmin screens).  Doesn't require and upgrade.
    93 == Recent Changes ==
     93== Recent Changes
    9494
    9595[[ChangeLog(tractweakuiplugin, 3)]]
    9696
    97 == Author/Contributors ==
     97== Author/Contributors
    9898
    9999'''Author:''' [wiki:richard] [[BR]]
     100'''Maintainer:''' [[Maintainer]] [[BR]]
    100101'''Contributors:'''