Plugins

Module navadd.navadd
/usr/lib/python2.4/site-packages/NavAdd-0.1-py2.4.egg/navadd/navadd.pyc
Description

Allows to add items to main and meta navigation bar

Extension points: trac.web.chrome.INavigationContributor (18 extensions)

Extension point interface for components that contribute items to the navigation.

AboutModule

Module trac.About
/usr/lib/python2.4/site-packages/trac/About.pyc
Description

Provides various about pages.

AttachmentModule

Module trac.attachment
/usr/lib/python2.4/site-packages/trac/attachment.pyc
Extension points: trac.attachment.IAttachmentChangeListener

Extension point interface for components that require notification when attachments are created or deleted.

trac.attachment.IAttachmentManipulator

Extension point interface for components that need to manipulate attachments.

Unlike change listeners, a manipulator can reject changes being committed to the database.

Environment

Module trac.env
/usr/lib/python2.4/site-packages/trac/env.pyc
Description

Trac stores project information in a Trac environment.

A Trac environment consists of a directory structure containing among other things:

  • a configuration file.
  • an SQLite database (stores tickets, wiki pages...)
  • Project specific templates and wiki macros.
  • wiki and ticket attachments.
Extension points: trac.env.IEnvironmentSetupParticipant (4 extensions)

Extension point interface for components that need to participate in the creation and upgrading of Trac environments, for example to create additional database tables.

EnvironmentSetup

Module trac.env
/usr/lib/python2.4/site-packages/trac/env.pyc

NotificationSystem

Module trac.notification
/usr/lib/python2.4/site-packages/trac/notification.pyc

DefaultPermissionGroupProvider

Module trac.perm
/usr/lib/python2.4/site-packages/trac/perm.pyc
Description

Provides the basic builtin permission groups 'anonymous' and 'authenticated'.

DefaultPermissionStore

Module trac.perm
/usr/lib/python2.4/site-packages/trac/perm.pyc
Description

Default implementation of permission storage and simple group management.

This component uses the PERMISSION table in the database to store both permissions and groups.

Extension points: trac.perm.IPermissionGroupProvider (1 extensions)

Extension point interface for components that provide information about user groups.

PermissionSystem

Module trac.perm
/usr/lib/python2.4/site-packages/trac/perm.pyc
Description

Sub-system that manages user permissions.

Extension points: trac.perm.IPermissionRequestor (12 extensions)

Extension point interface for components that define actions.

SearchModule

Module trac.Search
/usr/lib/python2.4/site-packages/trac/Search.pyc
Extension points: trac.Search.ISearchSource (3 extensions)

Extension point interface for adding search sources to the Trac Search system.

SettingsModule

Module trac.Settings
/usr/lib/python2.4/site-packages/trac/Settings.pyc

TimelineModule

Module trac.Timeline
/usr/lib/python2.4/site-packages/trac/Timeline.pyc
Extension points: trac.Timeline.ITimelineEventProvider (4 extensions)

Extension point interface for adding sources for timed events to the timeline.

TOCMacro

Module tractoc.macro
/usr/lib/python2.4/site-packages/TracTocMacro-1.0-py2.4.egg/tractoc/macro.pyc
Description

Generate a table of contents for the current page or a set of pages. If no arguments are given, a table of contents is generated for the current page, with the top-level title stripped: 

    [[TOC]]

To generate a table of contents for a set of pages, simply pass them as comma separated arguments to the TOC macro, e.g. as in 

[[TOC(TracGuide, TracInstall, TracUpgrade, TracIni, TracAdmin, TracBackup, TracLogging,
         TracPermissions, TracWiki, WikiFormatting, TracBrowser, TracRoadmap, TracChangeset,
         TracTickets, TracReports, TracQuery, TracTimeline, TracRss, TracNotification)]]

The following control arguments change the default behaviour of the TOC macro:

Argument Meaning
heading=<x> Override the default heading of "Table of Contents"
noheading Suppress display of the heading.
depth=<n> Display headings of subsequent pages to a maximum depth of <n>.
inline Display TOC inline rather than as a side-bar.
titleindex Only display the page name and title of each page, similar to TitleIndex.

Note that the current page must also be specified if individual wiki pages are given in the argument list.

ProjectAdminPage

Module webadmin.basics
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/basics.pyc

LoggingAdminPage

Module webadmin.logging
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/logging.pyc

PermissionAdminPage

Module webadmin.perm
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/perm.pyc

PluginAdminPage

Module webadmin.plugin
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/plugin.pyc

ComponentAdminPage

Module webadmin.ticket
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/ticket.pyc

MilestoneAdminPage

Module webadmin.ticket
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/ticket.pyc

PriorityAdminPage

Module webadmin.ticket
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/ticket.pyc

SeverityAdminPage

Module webadmin.ticket
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/ticket.pyc

TicketTypeAdminPage

Module webadmin.ticket
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/ticket.pyc

VersionAdminPage

Module webadmin.ticket
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/ticket.pyc

AdminModule

Module webadmin.web_ui
/usr/lib/python2.4/site-packages/TracWebAdmin-0.1.2dev_r4429-py2.4.egg/webadmin/web_ui.pyc
Extension points: webadmin.web_ui.IAdminPageProvider (10 extensions)

Extension point interface for adding pages to the admin module.

DatabaseManager

Module trac.db.api
/usr/lib/python2.4/site-packages/trac/db/api.pyc
Extension points: trac.db.api.IDatabaseConnector (3 extensions)

Extension point interface for components that support the connection to relational databases.

MySQLConnector

Module trac.db.mysql_backend
/usr/lib/python2.4/site-packages/trac/db/mysql_backend.pyc
Description

MySQL database support for version 4.1 and greater.

Database urls should be of the form:

mysql://user[:password]@host[:port]/database

PostgreSQLConnector

Module trac.db.postgres_backend
/usr/lib/python2.4/site-packages/trac/db/postgres_backend.pyc
Description

PostgreSQL database support.

SQLiteConnector

Module trac.db.sqlite_backend
/usr/lib/python2.4/site-packages/trac/db/sqlite_backend.pyc
Description

SQLite database support.

ImageRenderer

Module trac.mimeview.api
/usr/lib/python2.4/site-packages/trac/mimeview/api.pyc
Description

Inline image display. Here we don't need the content at all.

LineNumberAnnotator

Module trac.mimeview.api
/usr/lib/python2.4/site-packages/trac/mimeview/api.pyc
Description

Text annotator that adds a column with line numbers.

Mimeview

Module trac.mimeview.api
/usr/lib/python2.4/site-packages/trac/mimeview/api.pyc
Description

A generic class to prettify data, typically source code.

Extension points: trac.mimeview.api.IHTMLPreviewAnnotator (1 extensions)

Extension point interface for components that can annotate an XHTML representation of file contents with additional information.

trac.mimeview.api.IContentConverter (3 extensions)

An extension point interface for generic MIME based content conversion.

NOTE: This api will likely change in the future, e.g.:

def get_supported_conversions(input):

Tells whether this converter can handle this input type.

Return an iterable of Conversion objects, each describing how the conversion should be done and what will be the output type.

def convert_content(context, conversion, content):

Convert the given AbstractContent as specified by Conversion.

The conversion takes place in the given formatting context. A context provides at least a req property. If no other specific context object is available, a ToplevelContext can be used to wrap the req instance.

Return the converted content, which must be a MimeContent object.

trac.mimeview.api.IHTMLPreviewRenderer (9 extensions)

Extension point interface for components that add HTML renderers of specific content types to the Mimeview component.

This interface will be merged with IContentConverter, as conversion to text/html will be simply a particular type of content conversion.

However, note that the IHTMLPreviewRenderer will still be supported for a while through an adapter, whereas the IContentConverter interface itself will be changed.

So if all you want to do is convert to HTML and don't feel like following the API changes, rather you should rather implement this interface for the time being. ---

PlainTextRenderer

Module trac.mimeview.api
/usr/lib/python2.4/site-packages/trac/mimeview/api.pyc
Description

HTML preview renderer for plain text, and fallback for any kind of text for which no more specific renderer is available.

WikiTextRenderer

Module trac.mimeview.api
/usr/lib/python2.4/site-packages/trac/mimeview/api.pyc
Description

Render files containing Trac's own Wiki formatting markup.

EnscriptRenderer

Module trac.mimeview.enscript
/usr/lib/python2.4/site-packages/trac/mimeview/enscript.pyc
Description

Syntax highlighting using GNU Enscript.

PatchRenderer

Module trac.mimeview.patch
/usr/lib/python2.4/site-packages/trac/mimeview/patch.pyc
Description

Structured display of patches in unified diff format, similar to the layout provided by the changeset view.

PHPRenderer

Module trac.mimeview.php
/usr/lib/python2.4/site-packages/trac/mimeview/php.pyc
Description

Syntax highlighting using the PHP executable if available.

ReStructuredTextRenderer

Module trac.mimeview.rst
/usr/lib/python2.4/site-packages/trac/mimeview/rst.pyc
Description

Renders plain text in reStructuredText format as HTML.

SilverCityRenderer

Module trac.mimeview.silvercity
/usr/lib/python2.4/site-packages/trac/mimeview/silvercity.pyc
Description

Syntax highlighting based on SilverCity?.

TextileRenderer

Module trac.mimeview.txtl
/usr/lib/python2.4/site-packages/trac/mimeview/txtl.pyc
Description

Renders plain text in Textile format as HTML.

TracAdminHelpMacro

Module trac.scripts.admin
/usr/lib/python2.4/site-packages/trac/scripts/admin.pyc
Description

Displays help for trac-admin commands.

Examples: 

[[TracAdminHelp]]               # all commands
[[TracAdminHelp(wiki)]]         # all wiki commands
[[TracAdminHelp(wiki export)]]  # the "wiki export" command
[[TracAdminHelp(upgrade)]]      # the upgrade command

TicketSystem

Module trac.ticket.api
/usr/lib/python2.4/site-packages/trac/ticket/api.pyc
Extension points: trac.ticket.api.ITicketChangeListener

Extension point interface for components that require notification when tickets are created, modified, or deleted.

TicketNotificationSystem

Module trac.ticket.notification
/usr/lib/python2.4/site-packages/trac/ticket/notification.pyc

QueryModule

Module trac.ticket.query
/usr/lib/python2.4/site-packages/trac/ticket/query.pyc

TicketQueryMacro

Module trac.ticket.query
/usr/lib/python2.4/site-packages/trac/ticket/query.pyc
Description

Macro that lists tickets that match certain criteria.

This macro accepts two parameters, the second of which is optional.

The first parameter is the query itself, and uses the same syntax as for query: wiki links (but not the variant syntax starting with "?").

The second parameter determines how the list of tickets is presented: the default presentation is to list the ticket ID next to the summary, with each ticket on a separate line. If the second parameter is given, it must be one of:

  • compact -- the tickets are presented as a comma-separated list of ticket IDs.
  • count -- only the count of matching tickets is displayed

ReportModule

Module trac.ticket.report
/usr/lib/python2.4/site-packages/trac/ticket/report.pyc

MilestoneModule

Module trac.ticket.roadmap
/usr/lib/python2.4/site-packages/trac/ticket/roadmap.pyc

RoadmapModule

Module trac.ticket.roadmap
/usr/lib/python2.4/site-packages/trac/ticket/roadmap.pyc

NewticketModule

Module trac.ticket.web_ui
/usr/lib/python2.4/site-packages/trac/ticket/web_ui.pyc
Extension points: trac.ticket.api.ITicketManipulator

Miscellaneous manipulation of ticket workflow features.

TicketModule

Module trac.ticket.web_ui
/usr/lib/python2.4/site-packages/trac/ticket/web_ui.pyc
Extension points: trac.ticket.api.ITicketManipulator

Miscellaneous manipulation of ticket workflow features.

RepositoryManager

Module trac.versioncontrol.api
/usr/lib/python2.4/site-packages/trac/versioncontrol/api.pyc
Description

Component registering the supported version control systems,

It provides easy access to the configured implementation.

Extension points: trac.versioncontrol.api.IRepositoryConnector (2 extensions)

Provide support for a specific version control system.

SvnAuthzOptions

Module trac.versioncontrol.svn_authz
/usr/lib/python2.4/site-packages/trac/versioncontrol/svn_authz.pyc

SubversionConnector

Module trac.versioncontrol.svn_fs
/usr/lib/python2.4/site-packages/trac/versioncontrol/svn_fs.pyc

LoginModule

Module trac.web.auth
/usr/lib/python2.4/site-packages/trac/web/auth.pyc
Description

Implements user authentication based on HTTP authentication provided by the web-server, combined with cookies for communicating the login information across the whole site.

This mechanism expects that the web-server is setup so that a request to the path '/login' requires authentication (such as Basic or Digest). The login name is then stored in the database and associated with a unique key that gets passed back to the user agent using the 'trac_auth' cookie. This cookie is used to identify the user in subsequent requests to non-protected resources.

Chrome

Module trac.web.chrome
/usr/lib/python2.4/site-packages/trac/web/chrome.pyc
Description

Responsible for assembling the web site chrome, i.e. everything that is not actual page content.

Extension points: trac.web.chrome.INavigationContributor (18 extensions)

Extension point interface for components that contribute items to the navigation.

trac.web.chrome.ITemplateProvider (2 extensions)

Extension point interface for components that provide their own ClearSilver? templates and accompanying static resources.

RequestDispatcher

Module trac.web.main
/usr/lib/python2.4/site-packages/trac/web/main.pyc
Description

Component responsible for dispatching requests to registered handlers.

Extension points: trac.web.api.IAuthenticator (1 extensions)

Extension point interface for components that can provide the name of the remote user.

trac.web.api.IRequestHandler (20 extensions)

Extension point interface for request handlers.

WikiSystem

Module trac.wiki.api
/usr/lib/python2.4/site-packages/trac/wiki/api.pyc
Description

Represents the wiki system.

Extension points: trac.wiki.api.IWikiChangeListener (2 extensions)

Extension point interface for components that should get notified about the creation, deletion and modification of wiki pages.

trac.wiki.api.IWikiMacroProvider (12 extensions)

Extension point interface for components that provide Wiki macros.

trac.wiki.api.IWikiSyntaxProvider (12 extensions)

InterTracDispatcher

Module trac.wiki.intertrac
/usr/lib/python2.4/site-packages/trac/wiki/intertrac.pyc
Description

Implements support for InterTrac dispatching.

InterWikiMap

Module trac.wiki.interwiki
/usr/lib/python2.4/site-packages/trac/wiki/interwiki.pyc
Description

Implements support for InterWiki maps.

ImageMacro

Module trac.wiki.macros
/usr/lib/python2.4/site-packages/trac/wiki/macros.pyc
Description

Embed an image in wiki-formatted text.

The first argument is the file specification. The file specification may reference attachments or files in three ways:

  • module:id:file, where module can be either wiki or ticket, to refer to the attachment named file of the specified wiki page or ticket.
  • id:file: same as above, but id is either a ticket shorthand or a Wiki page name.
  • file to refer to a local attachment named 'file'. This only works from within that wiki page or a ticket.

Also, the file specification may refer to repository files, using the source:file syntax (source:file@rev works also).

The remaining arguments are optional and allow configuring the attributes and style of the rendered <img> element:

  • digits and unit are interpreted as the size (ex. 120, 25%) for the image
  • right, left, top or bottom are interpreted as the alignment for the image
  • nolink means without link to image source.
  • key=value style are interpreted as HTML attributes or CSS style

indications for the image. Valid keys are:

  • align, border, width, height, alt, title, longdesc, class, id and usemap
  • border can only be a number

Examples: 

    [[Image(photo.jpg)]]                           # simplest
    [[Image(photo.jpg, 120px)]]                    # with size
    [[Image(photo.jpg, right)]]                    # aligned by keyword
    [[Image(photo.jpg, nolink)]]                   # without link to source
    [[Image(photo.jpg, align=right)]]              # aligned by attribute

You can use image from other page, other ticket or other module. 

    [[Image(OtherPage:foo.bmp)]]    # if current module is wiki
    [[Image(base/sub:bar.bmp)]]     # from hierarchical wiki page
    [[Image(#3:baz.bmp)]]           # if in a ticket, point to #3
    [[Image(ticket:36:boo.jpg)]]
    [[Image(source:/images/bee.jpg)]] # straight from the repository!
    [[Image(htdocs:foo/bar.png)]]   # image file in project htdocs dir.

Adapted from the Image.py macro created by Shun-ichi Goto <gotoh@taiyo.co.jp>

MacroListMacro

Module trac.wiki.macros
/usr/lib/python2.4/site-packages/trac/wiki/macros.pyc
Description

Displays a list of all installed Wiki macros, including documentation if available.

Optionally, the name of a specific macro can be provided as an argument. In that case, only the documentation for that macro will be rendered.

Note that this macro will not be able to display the documentation of macros if the PythonOptimize option is enabled for mod_python!

PageOutlineMacro

Module trac.wiki.macros
/usr/lib/python2.4/site-packages/trac/wiki/macros.pyc
Description

Displays a structural outline of the current wiki page, each item in the outline being a link to the corresponding heading.

This macro accepts three optional parameters:

  • The first is a number or range that allows configuring the minimum and maximum level of headings that should be included in the outline. For example, specifying "1" here will result in only the top-level headings being included in the outline. Specifying "2-3" will make the outline include all headings of level 2 and 3, as a nested list. The default is to include all heading levels.
  • The second parameter can be used to specify a custom title (the default is no title).
  • The third parameter selects the style of the outline. This can be either inline or pullout (the latter being the default). The inline style renders the outline as normal part of the content, while pullout causes the outline to be rendered in a box that is by default floated to the right side of the other content.

RecentChangesMacro

Module trac.wiki.macros
/usr/lib/python2.4/site-packages/trac/wiki/macros.pyc
Description

Lists all pages that have recently been modified, grouping them by the day they were last modified.

This macro accepts two parameters. The first is a prefix string: if provided, only pages with names that start with the prefix are included in the resulting list. If this parameter is omitted, all pages are listed.

The second parameter is a number for limiting the number of pages returned. For example, specifying a limit of 5 will result in only the five most recently changed pages to be included in the list.

TitleIndexMacro

Module trac.wiki.macros
/usr/lib/python2.4/site-packages/trac/wiki/macros.pyc
Description

Inserts an alphabetic list of all wiki pages into the output.

Accepts a prefix string as parameter: if provided, only pages with names that start with the prefix are included in the resulting list. If this parameter is omitted, all pages are listed.

TracIniMacro

Module trac.wiki.macros
/usr/lib/python2.4/site-packages/trac/wiki/macros.pyc
Description

Produce documentation for Trac configuration file.

Typically, this will be used in the TracIni page. Optional arguments are a configuration section filter, and a configuration option name filter: only the configuration options whose section and name start with the filters are output.

UserMacroProvider

Module trac.wiki.macros
/usr/lib/python2.4/site-packages/trac/wiki/macros.pyc
Description

Adds macros that are provided as Python source files in the wiki-macros directory of the environment, or the global macros directory.

WikiModule

Module trac.wiki.web_ui
/usr/lib/python2.4/site-packages/trac/wiki/web_ui.pyc
Extension points: trac.wiki.api.IWikiPageManipulator

Extension point interface for components that need to to specific pre and post processing of wiki page changes.

Unlike change listeners, a manipulator can reject changes being committed to the database.

MercurialConnector

Module tracvc.hg.backend
/usr/lib/python2.4/site-packages/TracMercurial-0.10.0.2-py2.4.egg/tracvc/hg/backend.pyc

BrowserModule

Module trac.versioncontrol.web_ui.browser
/usr/lib/python2.4/site-packages/trac/versioncontrol/web_ui/browser.pyc

AnyDiffModule

Module trac.versioncontrol.web_ui.changeset
/usr/lib/python2.4/site-packages/trac/versioncontrol/web_ui/changeset.pyc

ChangesetModule

Module trac.versioncontrol.web_ui.changeset
/usr/lib/python2.4/site-packages/trac/versioncontrol/web_ui/changeset.pyc
Description

Provide flexible functionality for showing sets of differences.

If the differences shown are coming from a specific changeset, then that changeset informations can be shown too.

In addition, it is possible to show only a subset of the changeset: Only the changes affecting a given path will be shown. This is called the restricted changeset.

But the differences can also be computed in a more general way, between two arbitrary paths and/or between two arbitrary revisions. In that case, there's no changeset information displayed.

LogModule

Module trac.versioncontrol.web_ui.log
/usr/lib/python2.4/site-packages/trac/versioncontrol/web_ui/log.pyc