wiki:AddStaticResourcesPlugin

Add Static Resources Plugin

Description

A plugin that maps static resources into urls of your choice. Thus if you wish to add a stylesheet or a javascript to an existing trac page, you can specify in the trac ini a regex that matches the urls of the pages and insert the resources. Just add your static resources to the plugins htdocs folder and install then fill out the trac.ini configuration values to enable your static resources on each page you wish. Regular expressions are case insensitive by default.

[static_resources]
url-regex = list_of_files.js, and_style.css

There is also a patch listed below to provide case sensitivity.

Note: This plugin is trying to accomplish much of what TracTweakUiPlugin is, however with the following additional goals:

  • Simple, I want to simply map a url to a javascript/stylesheet that should be included.
  • Affect all tracs at once
    • I have many tracs so specifying this once in the shared conf file is much nicer than once in each database
    • Deployment of files should be simple and preferably in the egg we are already installing, rather than in a static location I need to keep track of and separately manage for each trac.

Bugs/Feature Requests

Existing bugs and feature requests for AddStaticResourcesPlugin are here.

If you have any issues, create a new ticket.

Note: The Trac 0.11 branch seems to work fine in Trac 0.12. If you experience any issues, then please report them.

defect

1 / 1

enhancement

1 / 1

Download

Download the zipped source from here.

Source

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

Also note that there are case sensitive regex patches.

Installation

  1. Insert your static files into the 'addstaticresourcesplugin/htdocs' folder of the plugin before installation.
  2. Install the plugin either for a single project or globally. See the details on how to install a trac plugin at TracPlugins.
  3. Enable the plugin. Add "addstaticresourcesplugin.* = enabled" to your trac.ini file in the [components] subheading. Alternatively, this can be enabled in the Web Admin section of the website as well.
  4. Reload/restart your HTTPD / other webserver / Tracd.

Example

This will cause the helloworld alert message to appear on the ticket and newticket pages.

[static_resources]
/(new)?ticket = helloworld.js

Recent Changes

14167 by bobbysmith007 on 2014-09-12 22:24:12
Allow using absolute refrences to static-resources
13436 by bobbysmith007 on 2013-11-08 17:52:52
New version of addstaticresourcesplugin that interacts better with trac 1.0 and is a bit simpler
13435 by bobbysmith007 on 2013-11-08 17:38:12
initing 1.0 branch
(more)

Author/Contributors

Author: bobbysmith007
Maintainer: Russ Tyndall
Contributors:

Last modified 6 months ago Last modified on Nov 26, 2015, 1:57:54 PM