# wiki

name: CamelCase
author: trac
ipnr: 127.0.0.1
text:
  = !CamelCase =
  New words created by smashing together capitalized words.

  CamelCase is the original wiki convention for creating hyperlinks, with the additional requirement that the capitals are followed by a lower-case letter; hence “AlabamA” and “ABc” will not be links.

  == Customizing the Wiki behavior ==

  Some people dislike linking by CamelCase.  While Trac remains faithful to the original Wiki style, it provides a number of ways to accomodate users with different preferences:
   * There's an option (`ignore_missing_pages` in `[wiki]`) to simply ignore links to missing pages when the link is written using the CamelCase style, instead of that word being replaced by a gray link followed by a question mark.[[BR]]
     That can be useful when CamelCase style is used to name code artifacts like class names and there's no corresponding page for them.
   * There's an option (`split_page_names` in `[wiki]`) to automatically insert space characters between the words of a CamelCase link when rendering the link.
   * Creation of explicit Wiki links is also easy, see WikiPageNames for details.
   * In addition, Wiki formatting can be disabled completely in some places (e.g. when rendering commit log messages)

  See TracIni for more information on the available options.

  == More information on !CamelCase ==

   * http://c2.com/cgi/wiki?WikiCase
   * http://en.wikipedia.org/wiki/CamelCase

  ----
  See also: WikiPageNames, WikiNewPage, WikiFormatting, TracWiki


name: InterMapTxt
author: trac
ipnr: 127.0.0.1
text:
  = InterMapTxt =

  == This is the place for defining InterWiki prefixes ==

  This page was modelled after the MeatBall:InterMapTxt page.
  In addition, an optional comment is allowed after the mapping.


  This page is interpreted in a special way by Trac, in order to support
  !InterWiki links in a flexible and dynamic way.

  The code block after the first line separator in this page
  will be interpreted as a list of !InterWiki specifications:
  {{{
  prefix <space> URL [<space> # comment]
  }}}

  By using `$1`, `$2`, etc. within the URL, it is possible to create 
  InterWiki links which support multiple arguments, e.g. Trac:ticket:40.
  The URL itself can be optionally followed by a comment, 
  which will subsequently be used for decorating the links 
  using that prefix.

  New !InterWiki links can be created by adding to that list, in real time.
  Note however that ''deletions'' are also taken into account immediately,
  so it may be better to use comments for disabling prefixes.

  Also note that !InterWiki prefixes are case insensitive.


  == List of Active Prefixes ==

  [[InterWiki]]


  ----

  == Prefix Definitions ==

  {{{
  PEP     http://www.python.org/peps/pep-$1.html                                       # Python Enhancement Proposal 
  PythonBug http://bugs.python.org/issue$1                                             # Python Issue #$1
  Trac-ML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/ # Message $1 in Trac Mailing List
  trac-dev http://thread.gmane.org/gmane.comp.version-control.subversion.trac.devel/   # Message $1 in Trac Development Mailing List

  Mercurial http://www.selenic.com/mercurial/wiki/index.cgi/ # the wiki for the Mercurial distributed SCM
  RFC       http://tools.ietf.org/html/rfc$1 # IETF's RFC $1
  ISO       http://en.wikipedia.org/wiki/ISO_ # ISO Standard $1 in Wikipedia

  CheeseShop  http://cheeseshop.python.org/pypi/  # Python Package $1 from the Cheese Shop
  SQLite      http://www.sqlite.org/cvstrac/wiki?p= 
  mysql-bugs  http://bugs.mysql.com/bug.php?id=  # Bug #$1 in MySQL's bug database
  peak        http://peak.telecommunity.com/DevCenter/ # $1 in Python Enterprise Application Kit's Wiki
  MODPYTHON   http://issues.apache.org/jira/browse/MODPYTHON- # Issue $1 in mod_python's JIRA instance
  SvnWiki     http://www.orcaware.com/svn/wiki/ # Subversion Wiki

  #
  # A arbitrary pick of InterWiki prefixes...
  #
  Acronym          http://www.acronymfinder.com/af-query.asp?String=exact&Acronym=
  C2find           http://c2.com/cgi/wiki?FindPage&value=
  Cache            http://www.google.com/search?q=cache:
  CPAN             http://search.cpan.org/perldoc?
  DebianBug        http://bugs.debian.org/
  DebianPackage    http://packages.debian.org/
  Dictionary       http://www.dict.org/bin/Dict?Database=*&Form=Dict1&Strategy=*&Query=
  Google           http://www.google.com/search?q=
  GoogleGroups     http://groups.google.com/group/$1/msg/$2        # Message $2 in $1 Google Group
  JargonFile       http://downlode.org/perl/jargon-redirect.cgi?term=
  MeatBall         http://www.usemod.com/cgi-bin/mb.pl?
  MetaWiki         http://sunir.org/apps/meta.pl?
  MetaWikiPedia    http://meta.wikipedia.org/wiki/
  MoinMoin         http://moinmoin.wikiwikiweb.de/
  WhoIs            http://www.whois.sc/
  Why              http://clublet.com/c/c/why?
  c2Wiki             http://c2.com/cgi/wiki?
  WikiPedia        http://en.wikipedia.org/wiki/
  }}}


name: InterTrac
author: trac
ipnr: 127.0.0.1
text:
  = InterTrac Links  =

  Trac supports a convenient way to refer to resources of other Trac servers, from within the Wiki markup, since version 0.10.

  == Definitions ==

  An InterTrac link can be seen as a scoped TracLinks.
  It is used for referring to a Trac resource 
  (Wiki page, changeset, ticket, ...) located in another
  Trac environment.

  == List of Active InterTrac Prefixes ==

  [[InterTrac]]

  == Link Syntax ==

  Simply use the name of the other Trac environment as a prefix, 
  followed by a colon, ending with the resource located in the other environment.

  {{{
  <target_environment>:<TracLinks>
  }}}

  The other resource is specified using a regular TracLinks, of any flavor.

  That target environment name is either the real name of the 
  environment, or an alias for it. 
  The aliases are defined in `trac.ini` (see below).
  The prefix is case insensitive.

  For convenience, there's also some alternative short-hand form, 
  where one can use an alias as an immediate prefix 
  for the identifier of a ticket, changeset or report:
  (e.g. `#T234`, `[T1508]`, `[trac 1508]`, ...)

  == Examples ==

  It is necessary to setup a configuration for the InterTrac facility.
  This configuration has to be done in the TracIni file, `[intertrac]` section.

  Example configuration:
  {{{
  ...
  [intertrac]
  # -- Example of setting up an alias:
  t = trac

  # -- Link to an external Trac:
  trac.title = Edgewall's Trac for Trac
  trac.url = http://trac.edgewall.org
  }}}

  The `.url` is mandatory and is used for locating the other Trac.
  This can be a relative URL in case that Trac environment is located 
  on the same server.

  The `.title` information will be used for providing an useful tooltip
  when moving the cursor over an InterTrac links.

  Finally, the `.compat` option can be used to activate or disable
  a ''compatibility'' mode:
   * If the targeted Trac is running a version below milestone:0.10 
     (r3526 to be precise), then it doesn't know how to dispatch an InterTrac 
     link, and it's up to the local Trac to prepare the correct link. 
     Not all links will work that way, but the most common do. 
     This is called the compatibility mode, and is `true` by default. 
   * If you know that the remote Trac knows how to dispatch InterTrac links, 
     you can explicitly disable this compatibility mode and then ''any'' 
     TracLinks can become an InterTrac link.

  Now, given the above configuration, one could create the following links:
   * to this InterTrac page:
     * `trac:wiki:InterTrac` trac:wiki:InterTrac
     * `t:wiki:InterTrac` t:wiki:InterTrac
     * Keys are case insensitive: `T:wiki:InterTrac` T:wiki:InterTrac
   * to the ticket #234:
     * `trac:ticket:234` trac:ticket:234
     * `trac:#234` trac:#234 
     * `#T234` #T234
   * to the changeset [1912]:
     * `trac:changeset:1912` trac:changeset:1912
     * `[T1912]` [T1912]
   * to the log range [3300:3330]: '''(Note: the following ones need `trac.compat=false`)'''
     * `trac:log:@3300:3330` trac:log:@3300:3330  
     * `[trac 3300:3330]` [trac 3300:3330] 
   * finally, to link to the start page of a remote trac, simply use its prefix followed by ':', inside an explicit link. Example: `[th: Trac Hacks]` (''since 0.11; note that the ''remote'' Trac has to run 0.11 for this to work'')

  The generic form `intertrac_prefix:module:id` is translated
  to the corresponding URL `<remote>/module/id`, shorthand links
  are specific to some modules (e.g. !#T234 is processed by the
  ticket module) and for the rest (`intertrac_prefix:something`),
  we rely on the TracSearch#quickjump facility of the remote Trac.

  ----
  See also: TracLinks, InterWiki


name: InterWiki
author: trac
ipnr: 127.0.0.1
text:
  = Support for InterWiki links =

  ''(since [milestone:0.10])''

  == Definition ==

  An InterWiki link can be used for referring to a Wiki page
  located in another Wiki system, and by extension, to any object
  located in any other Web application, provided a simple URL 
  mapping can be done.

  At the extreme, InterWiki prefixes can even be used to simply introduce
  links to new protocols, such as `tsvn:` used by TortoiseSvn.

  == Link Syntax ==

  {{{
  <target_wiki>(:<identifier>)+
  }}}

  The link is composed by the targeted Wiki (or system) name,
  followed by a colon (e.g. `MeatBall:`),
  followed by a page specification in the target.
  Note that, as for InterTrac prefixes, '''InterWiki prefixes are case insensitive'''.

  The target Wiki URL is looked up in the InterMapTxt wiki page, 
  modelled after MeatBall:InterMapTxt.

  In addition to traditional InterWiki links, where the target
  is simply ''appended'' to the URL, 
  Trac supports parametric InterWiki URLs:
  identifiers `$1`, `$2`, ... in the URL
  will be replaced by corresponding arguments.
  The argument list is formed by splitting the page identifier
  using the ":" separator.

  == Examples ==

  If the following is an excerpt of the InterMapTxt page:

  {{{
  = InterMapTxt =
  == This is the place for defining InterWiki prefixes ==

  Currently active prefixes: [[InterWiki]]

  This page is modelled after the MeatBall:InterMapTxt page.
  In addition, an optional comment is allowed after the mapping.
  ----
  {{{
  PEP      http://www.python.org/peps/pep-$1.html           # Python Enhancement Proposal $1 
  Trac-ML  http://thread.gmane.org/gmane.comp.version-control.subversion.trac.general/$1  # Message $1 in Trac Mailing List

  tsvn     tsvn:                                            # Interact with TortoiseSvn
  ...
  MeatBall http://www.usemod.com/cgi-bin/mb.pl?
  MetaWiki http://sunir.org/apps/meta.pl?
  MetaWikiPedia http://meta.wikipedia.org/wiki/
  MoinMoin http://moinmoin.wikiwikiweb.de/
  ...
  }}}
  }}}

  Then, 
   * `MoinMoin:InterWikiMap` should be rendered as MoinMoin:InterWikiMap
     and the ''title'' for that link would be "!InterWikiMap in !MoinMoin"
   * `Trac-ML:4346` should be rendered as Trac-ML:4346
     and the ''title'' for that link would be "Message 4346 in Trac Mailing List"

  ----
  See also: InterTrac, InterMapTxt


name: PageTemplates
author: trac
ipnr: 127.0.0.1
text:
  = Wiki Page Templates = 

    ''(since [http://trac.edgewall.org/milestone/0.11 0.11])''

  The default content for a new wiki page can be chosen from a list of page templates. 

  That list is made up from all the existing wiki pages having a name starting with ''PageTemplates/''.
  The initial content of a new page will simply be the content of the chosen template page, or a blank page if the special ''(blank page)'' entry is selected. When there's actually no wiki pages matching that prefix, the initial content will always be the blank page and the list selector will not be shown (i.e. this matches the behavior we had up to now).

  To create a new template, simply create a new page having a name starting with ''PageTemplates/''.

  (Hint: one could even create a ''!PageTemplates/Template'' for facilitating the creation of new templates!)

  Available templates:
  [[TitleIndex(PageTemplates/)]]

  ----
  See also: TracWiki


name: SandBox
author: trac
ipnr: 127.0.0.1
text:
  = The Sandbox =

  This is just a page to practice and learn WikiFormatting. 

  Go ahead, edit it freely.


name: TracAccessibility
author: trac
ipnr: 127.0.0.1
text:
  = Accessibility Support in Trac =

  Not every user has a graphic environment with a mouse or other pointing device. Some users rely on keyboard, alternative keyboard or voice input to navigate links, activate form controls, etc. In Trac, we work to assure users may interact with devices other than a pointing device.

  Trac supports accessibility keys for the most common operations. On Windows and Linux platforms, press any of the keys listed below in combination with the `<Alt>` key; on a Mac, use the `<ctrl>` key instead.

  ''Note that when using Internet Explorer on Windows, you need to hit `<Enter>` after having used the access key.''[[BR]]
  ''Note that when using Firefox 2.0 on Windows, you need to hit `<Shift> + <Alt> + <Key>`.''

  == Global Access Keys ==

   * `1` - WikiStart
   * `2` - [wiki:TracTimeline Timeline]
   * `3` - [wiki:TracRoadmap Roadmap]
   * `4` - [wiki:TracSearch Search]
   * `6` - [wiki:TracGuide Trac Guide / Documentation]
   * `7` - [wiki:TracTickets New Ticket]
   * `9` - [../about About Trac]
   * `0` - This page
   * `e` - Edit this page
   * `f` - Search


  ----
  See also: TracGuide


name: TracAdmin
author: trac
ipnr: 127.0.0.1
text:
  = TracAdmin =
  [[TracGuideToc]]

  Trac is distributed with a powerful command-line configuration tool. This tool can be used  to configure and customize your Trac-installation to better fit your needs.

  Some of those operations can also be performed via the ''Admin'' web interface, an updated version of the [http://trac.edgewall.org/wiki/WebAdmin WebAdmin] plugin now integrated within Trac (since version 0.11).

  == Usage ==

  You can get a comprehensive list of the available options, commands and sub-commands by invoking `trac-admin` with the `help` command:.
  {{{
  trac-admin help
  }}}

  Unless you're executing the `help`, `about` or `version` sub-commands, you'll need to specify the path to the TracEnvironment that you want to administer as the first argument, for example:
  {{{
  trac-admin /path/to/projenv wiki list
  }}}

  == Interactive Mode ==

  When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
  Commands can then be executed on the selected environment using the prompt, which offers tab-completion
  (on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.

  Once you're in interactive mode, you can also get help on specific commands or subsets of commands:

  For example, to get an explanation of the `resync` command, run:
  {{{
  > help resync
  }}}

  To get help on all the Wiki-related commands, run:
  {{{
  > help wiki
  }}}

  == Full Command Reference ==

  [[TracAdminHelp()]]

  === Notes ===

  The `initenv` also supports an extra `--inherit` option, which can be used to specify the `[inherit] file` option at environment creation time so that only the options ''not'' already specified in the global configuration file will be written in the conf/trac.ini file of the newly created environment.
  See TracIni#GlobalConfiguration.
  ----
  See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, TracMigrate


name: TracBackup
author: trac
ipnr: 127.0.0.1
text:
  = Trac Backup =
  [[TracGuideToc]]

  Since Trac uses a database backend, some extra care is required to safely create a backup of a [wiki:TracEnvironment project environment]. Luckily, [wiki:TracAdmin trac-admin] has a command to make backups easier: `hotcopy`.

    ''Note: Trac uses the `hotcopy` nomenclature to match that of [http://subversion.tigris.org/ Subversion], to make it easier to remember when managing both Trac and Subversion servers.''

  == Creating a Backup ==

  To create a backup of a live TracEnvironment, simply run:
  {{{

    $ trac-admin /path/to/projenv hotcopy /path/to/backupdir

  }}}

  [wiki:TracAdmin trac-admin] will lock the database while copying.''

  The resulting backup directory is safe to handle using standard file-based backup tools like `tar` or `dump`/`restore`.

  Please, note, that hotcopy command does not overwrite target directory and when such exists, hotcopy ends with error: `Command failed: [Errno 17] File exists:` This is discussed in [trac:ticket:3198 #3198].

  === Restoring a Backup ===

  Backups are simply a copied snapshot of the entire [wiki:TracEnvironment project environment] directory, including the SQLite database. 

  To restore an environment from a backup, simply stop the process running Trac (i.e. the Web server or [wiki:TracStandalone tracd]), restore the directory structure from the backup and restart the service.

    ''Note: Automatic backup of environments that don't use SQLite as database backend is not supported at this time. As a workaround, we recommend that you stop the server, copy the environment directory, and make a backup of the database using whatever mechanism is provided by the database system.''

  ----
  See also: TracAdmin, TracEnvironment, TracGuide, TracMigrate


name: TracBrowser
author: trac
ipnr: 127.0.0.1
text:
  = The Trac Repository Browser =
  [[TracGuideToc]]

  The Trac repository browser can be used to browse directories 
  and specific revisions of files stored in the repository of the configured
  version control system.

  Directory entries are displayed in a list with sortable columns. The list 
  entries can be sorted by ''name'', ''size'' or ''age'' by clicking on the column
  headers. The sort order can be reversed by clicking on a given column
  header again.

  The browser can be used to navigate through the directory structure 
  by clicking on the directory names. Clicking on a file name will show
  the contents of the file. Clicking on the revision number of a file or
  directory will take you to the TracRevisionLog for that file.
  Note that there's also a ''Revision Log'' navigation link that will do
  the same for the path currently being examined.

  It's also possible to browse directories or files as they were in history,
  at any given repository revision. The default behavior is to display the
  latest revision but another revision number can easily be selected using
  the ''View revision'' input field at the top of the page.

  ''(since 0.11)'':

  At the top of the browser page, there's a drop-down menu which you can use 
  to select some interesting places in the repository, for example branches or tags. 
  This is sometimes referred to as the ''browser quickjump'' facility.
  The precise meaning and content of this menu depends on your backend.
  For Subversion, this list contains by default a few branches (`trunk` and any sub-folder of the latest `branches` top-level folder) and a few tags (any sub-folder of the latest `tags` top-level folder). This can be [TracIni#svn-section configured] for more advanced cases.

  If you're using a Javascript enabled brower, you'll be able to expand and collapse folders in-place by clicking on the arrow head at the right side of a folder. Alternatively, the keyboard can also be used for this: use 'j' and 'k' to go to the next or previous entry, and 'o' (or 'Enter') to toggle between expanded and collapsed state of the selected folder or for visiting the selected file.

  For the Subversion backend, some additional features are available:
   - support for `svn:needs-lock` property
   - support for `svn:externals` property (which can be [TracIni#svn:externals-section configured])

  ----
  See also: TracGuide, TracChangeset, TracFineGrainedPermissions


name: TracCgi
author: trac
ipnr: 127.0.0.1
text:
  = Installing Trac as CGI =

  To install Trac as a CGI script, you need to make the `trac.cgi` executable as a CGI by your web server.

    ''Please note that using Trac via CGI is significantly slower than any other deployment method, such as [TracModPython mod_python] or [TracFastCgi FastCGI].''

  If you're using [http://httpd.apache.org/ Apache HTTPD], there are a couple ways to do that:

   1. Use a `ScriptAlias` to map a URL to the `trac.cgi` script
   2. Copy the `trac.cgi` file into the directory for CGI executables used by your web server (commonly named `cgi-bin`). You can also create a symbolic link, but in that case make sure that the `FollowSymLinks` option is enabled for the `cgi-bin` directory.

  The first option is recommended as it also allows you to map the CGI to a friendly URL.

  Now, edit the Apache configuration file and add this snippet, file names and locations changed to match your installation:
  {{{
  ScriptAlias /trac /usr/share/trac/cgi-bin/trac.cgi
  }}}

   ''Note that this directive requires the `mod_alias` module to be installed and enabled.''

  If you're using Trac with a single project you need to set its location using the `TRAC_ENV` environment variable:
  {{{
  <Location "/trac">
    SetEnv TRAC_ENV "/path/to/projectenv"
  </Location>
  }}}

  Or to use multiple projects you can specify their common parent directory using the `TRAC_ENV_PARENT_DIR` variable:
  {{{
  <Location "/trac">
    SetEnv TRAC_ENV_PARENT_DIR "/path/to/project/parent/dir"
  </Location>
  }}}

   ''Note that the `SetEnv` directive requires the `mod_env` module to be installed and enable. If not, you could set TRAC_ENV in trac.cgi. Just add the following code between "try:" and "from trac.web ...":''

  {{{
      import os
      os.environ['TRAC_ENV'] = "/path/to/projectenv"
  }}}

   '' Or for TRAC_ENV_PARENT_DIR: ''

  {{{
      import os
      os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
  }}}

  This will make Trac available at `http://yourhost.example.org/trac`.

  If you are using the [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature please see [http://trac.edgewall.org/wiki/ApacheSuexec].

  On some systems, you ''may'' need to edit the shebang line in the `trac.cgi` file to point to your real Python installation path. On a Windows system you may need to configure Windows to know how to execute a .cgi file (Explorer -> Tools -> Folder Options -> File Types -> CGI).

  == Mapping Static Resources ==

  Out of the box, Trac will serve static resources such as style sheets or images itself. For a CGI setup, though, this is highly undesirable, because it results in the CGI script being invoked for documents that could be much more efficiently served by the web server directly.

  Web servers such as [http://httpd.apache.org/ Apache HTTPD] allow you to create “Aliases” to resources, thereby giving them a virtual URL that doesn't necessarily bear any resemblance to the layout of the servers file system. We already used this capability above when defining a `ScriptAlias` for the CGI script, and we'll use it now to map requests to the static resources to the directory on the file system that contains them, thereby bypassing the processing of such requests by the CGI script.

  Edit the Apache configuration file again and add the following snippet '''before''' the `ScriptAlias` for the CGI script , file names and locations changed to match your installation:
  {{{
  Alias /trac/chrome/common /usr/share/trac/htdocs
  <Directory "/usr/share/trac/htdocs">
    Order allow,deny
    Allow from all
  </Directory>
  }}}

  Note that whatever URL path you mapped the `trac.cgi` script to, the path `/chrome/common` is the path you have to append to that location to intercept requests to the static resources. 

  For example, if Trac is mapped to `/cgi-bin/trac.cgi` on your server, the URL of the Alias should be `/cgi-bin/trac.cgi/chrome/common`.

  Similarly, if you have static resources in a projects htdocs directory, you can configure apache to serve those resources (again, put this '''before''' the `ScriptAlias` for the CGI script, and adjust names and locations to match your installation):

  {{{
  Alias /trac/chrome/site /path/to/projectenv/htdocs
  <Directory "/path/to/projectenv/htdocs">
    Order allow,deny
    Allow from all
  </Directory>
  }}}

  Alternatively, you can set the `htdocs_location` configuration option in [wiki:TracIni trac.ini]:
  {{{
  [trac]
  htdocs_location = /trac-htdocs
  }}}

  Trac will then use this URL when embedding static resources into HTML pages. Of course, you still need to make the Trac `htdocs` directory available through the web server at the specified URL, for example by copying (or linking) the directory into the document root of the web server:
  {{{
  $ ln -s /usr/share/trac/htdocs /var/www/your_site.com/htdocs/trac-htdocs
  }}}

  Note that in order to get this `htdocs` directory, you need first to extract the relevant Trac resources using the `deploy` command of TracAdmin:
  [[TracAdminHelp(deploy)]]


  == Adding Authentication ==

  The simplest way to enable authentication with Apache is to create a password file. Use the `htpasswd` program to create the password file:
  {{{
  $ htpasswd -c /somewhere/trac.htpasswd admin
  New password: <type password>
  Re-type new password: <type password again>
  Adding password for user admin
  }}}

  After the first user, you dont need the "-c" option anymore:
  {{{
  $ htpasswd /somewhere/trac.htpasswd john
  New password: <type password>
  Re-type new password: <type password again>
  Adding password for user john
  }}}

    ''See the man page for `htpasswd` for full documentation.''

  After you've created the users, you can set their permissions using TracPermissions.

  Now, you'll need to enable authentication against the password file in the Apache configuration:
  {{{
  <Location "/trac/login">
    AuthType Basic
    AuthName "Trac"
    AuthUserFile /somewhere/trac.htpasswd
    Require valid-user
  </Location>
  }}}

  If you're hosting multiple projects you can use the same password file for all of them:
  {{{
  <LocationMatch "/trac/[^/]+/login">
    AuthType Basic
    AuthName "Trac"
    AuthUserFile /somewhere/trac.htpasswd
    Require valid-user
  </LocationMatch>
  }}}

  For better security, it is recommended that you either enable SSL or at least use the “Digest” authentication scheme instead of “Basic”. Please read the [http://httpd.apache.org/docs/2.0/ Apache HTTPD documentation] to find out more. For example, on a Debian 4.0r1 (etch) system the relevant section  in apache configuration can look like this:
  {{{
  <Location "/trac/login">
      LoadModule auth_digest_module /usr/lib/apache2/modules/mod_auth_digest.so
      AuthType Digest
      AuthName "trac"
      AuthDigestDomain /trac
      AuthDigestFile /somewhere/trac.htpasswd
      Require valid-user
  </Location>
  }}}
  and you'll have to create your .htpasswd file with htdigest instead of htpasswd as follows:
  {{{
  # htdigest /somewhere/trac.htpasswd trac admin
  }}}
  where the "trac" parameter above is the same as !AuthName above  ("Realm" in apache-docs). 

  ----
  See also:  TracGuide, TracInstall, TracFastCgi, TracModPython


name: TracChangeset
author: trac
ipnr: 127.0.0.1
text:
  = Trac Changeset Module =
  [[TracGuideToc]]

  Trac has a built-in functionality for visualizing “diffs” - changes to files.

  There are different kinds of ''change sets''. 
  Some can correspond to revisions made in the repositories,
  others can aggregate changes made in several revisions, 
  but in the end, any kind of differences can be shown.

  The changeset view consists of two parts, the ''header'' 
  and the ''diff views''.

  == Changeset Header ==

  The header shows an overview of the whole changeset.
  Here you will find information such as:

   * Timestamp -- When the changeset was commited
   * Author -- Who commited the changeset
   * Message -- A brief description from the author (the commit log message)
   * Files -- A list of files affected by this changeset

  If more than one revision is involved in the set of changes being
  displayed, the ''Timestamp'', ''Author'' and ''Message'' fields 
  won't be shown.

  In front of each listed file, you'll find  a colored rectangle. The color
  indicates how the file is affected by the changeset.
   
   * Green: Added
   * Red: Removed
   * Yellow: Modified
   * Blue: Copied
   * Gray: Moved

  The color legend is located below the header as a reminder.

  == Diff Views ==

  Below the header is the main part of the changeset, the diff view. Each file is shown in a separate section, each of which will contain only the regions of the file that are affected by the changeset. There are two different styles of displaying the diffs: ''inline'' or ''side-by-side'' (you can switch between those styles using the preferences form):

   * The ''inline'' style shows the changed regions of a file underneath each other. A region removed from the file will be colored red, an added region will be colored green. If a region was modified, the old version is displayed above the new version. Line numbers on the left side indicate the exact position of the change in both the old and the new version of the file.
   * The ''side-by-side'' style shows the old version on the left and the new version on the right (this will typically require more screen width than the inline style.) Added and removed regions will be colored in the same way as with the inline style (green and red, respectively), but modified regions will have a yellow background.

  In addition, various advanced options are available in the preferences form for adjusting the display of the diffs:
   * You can set how many lines are displayed before and after every change
     (if the value ''all'' is used, then the full file will be shown)
   * You can toggle whether blank lines, case changes and white space changes are ignored, thereby letting you find the functional changes more quickly


  == The Different Ways to Get a Diff ==

  === Examining a Changeset ===

  When viewing a repository check-in, such as when following a
  changeset [wiki:TracLinks link] or a changeset event in the 
  [wiki:TracTimeline timeline], Trac will display the exact changes
  made by the check-in.

  There will be also navigation links to the ''Previous Changeset''
  to and ''Next Changeset''.

  === Examining Differences Between Revisions ===

  Often you'll want to look at changes made on a file 
  or on a directory spanning multiple revisions. The easiest way
  to get there is from the TracRevisionLog, where you can select
  the ''old'' and the ''new'' revisions of the file or directory, and
  then click the ''View changes'' button.

  === Examining Differences Between Branches ===

  One of the core features of version control systems is the possibility
  to work simultaneously on different ''Lines of Developments'', commonly
  called “branches”. Trac enables you to examine the exact differences
  between such branches.

  Using the '''View changes ...''' button in the TracBrowser allows you to enter
  ''From:'' and ''To:'' path/revision pairs. The resulting set of differences consist
  of the changes that should be applied to the ''From:'' content in order
  to get to the ''To:'' content.

  For convenience, it is possible to invert the roles of the ''old'' and the ''new''
  path/revision pairs by clicking the ''Reverse Diff'' link on the changeset page.

  === Checking the Last Change ===

  The last possibility for examining changes is to use the ''Last Change''
  link provided by the TracBrowser.

  This link will take you to the last change that was made on that path.
  From there, you can use the ''Previous Change'' and ''Next Change'' links
  to traverse the change history of the file or directory.

  ----
  See also: TracGuide, TracBrowser


name: TracEnvironment
author: trac
ipnr: 127.0.0.1
text:
  = The Trac Environment =

  Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.

  == Creating an Environment ==

  A new Trac environment is created using  [wiki:TracAdmin trac-admin]:
  {{{
  $ trac-admin /path/to/myproject initenv
  }}}

  [wiki:TracAdmin trac-admin] will ask you for the name of the project, the
  database connection string (explained below), and the type and path to
  your source code repository.

  ''Note: The web server user will require file system write permission to 
  the environment directory and all the files inside. Please remember to set
  the appropriate permissions. The same applies to the Subversion repository 
  Trac is eventually using, although Trac will only require read access as long 
  as you're not using the BDB file system. Also, it seems that project names
  with spaces can be problematic for authentication (see [trac:#7163]).''

  == Database Connection Strings ==

  Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
  [http://www.postgresql.org/ PostgreSQL] database backends.  Preliminary
  support for [http://mysql.com/ MySQL] was added in 0.10.  The default is
  to use SQLite, which is probably sufficient for most projects. The database
  file is then stored in the environment directory, and can easily be 
  [wiki:TracBackup backed up] together with the rest of the environment.

  === Embedded SQLite Connection String ===
  The connection string for an embedded SQLite database is:
  {{{
  sqlite:db/trac.db
  }}}

  === PostgreSQL Connection String ===
  If you want to use PostgreSQL or MySQL instead, you'll have to use a
  different connection string. For example, to connect to a PostgreSQL
  database on the same machine called `trac`, that allows access to the
  user `johndoe` with the password `letmein`, use:
  {{{
  postgres://johndoe:letmein@localhost/trac
  }}}
  ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''

  If PostgreSQL is running on a non-standard port (for example 9342), use:
  {{{
  postgres://johndoe:letmein@localhost:9342/trac
  }}}

  On UNIX, you might want to select a UNIX socket for the transport,
  either the default socket as defined by the PGHOST environment variable:
  {{{
  postgres://user:password@/database
  }}}
  or a specific one:
  {{{
  postgres://user:password@/database?host=/path/to/socket/dir
  }}}

  Note that with PostgreSQL you will have to create the database before running
  `trac-admin initenv`.

  See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
  Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
  {{{
  createuser -U postgres -E -P tracuser
  createdb -U postgres -O tracuser -E UTF8 trac
  }}}
  When running `createuser` you will be prompted for the password for the user 'tracuser'. This new user will not be a superuser, will not be allowed to create other databases and will not be allowed to create other roles. These privileges are not needed to run a trac instance. If no password is desired for the user, simply remove the `-P` and `-E` options from the `createuser` command.  Also note that the database should be created as UTF8. LATIN1 encoding causes errors trac's use of unicode in trac.  SQL_ASCII also seems to work.

  Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user.  For example:
  {{{
  sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
  sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
  }}}

  Trac uses the `public` schema by default but you can specify a different schema in the connection string:
  {{{
  postgres://user:pass@server/database?schema=yourschemaname
  }}}

  === MySQL Connection String ===

  If you want to use MySQL instead, you'll have to use a
  different connection string. For example, to connect to a MySQL
  database on the same machine called `trac`, that allows access to the
  user `johndoe` with the password `letmein`, the mysql connection string is:
  {{{
  mysql://johndoe:letmein@localhost:3306/trac
  }}}

  == Source Code Repository ==

  You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion,
  which is the default), then the ''path'' where the repository is located.

  If you don't want to use Trac with a source code repository, simply leave the ''path'' empty
  (the ''type'' information doesn't matter, then).

  For some systems, it is possible to specify not only the path to the repository,
  but also a ''scope'' within the repository. Trac will then only show information
  related to the files and changesets below that scope. The Subversion backend for
  Trac supports this; for other types, check the corresponding plugin's documentation.

  Example of a configuration for a Subversion repository:
  {{{
  [trac]
  repository_type = svn
  repository_dir = /path/to/your/repository
  }}}

  The configuration for a scoped Subversion repository would be:
  {{{
  [trac]
  repository_type = svn
  repository_dir = /path/to/your/repository/scope/within/repos
  }}}

  == Directory Structure ==

  An environment directory will usually consist of the following files and directories:

   * `README` - Brief description of the environment.
   * `VERSION` - Contains the environment version identifier.
   * `attachments` - Attachments to wiki pages and tickets are stored here.
   * `conf`
     * `trac.ini` - Main configuration file. See TracIni.
   * `db`
     * `trac.db` - The SQLite database (if you're using SQLite).
   * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(0.11 only)'''''
   * `log` - default directory for log files, if logging is turned on and a relative path is given.
   * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [milestone:0.10])
   * `templates` - Custom ClearSilver environment-specific templates. '''''(0.10 only)'''''
     * `site_css.cs` - Custom CSS rules.
     * `site_footer.cs` - Custom page footer.
     * `site_header.cs` - Custom page header.
   * `templates` - Custom Genshi environment-specific templates. '''''(0.11 only)'''''
     * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance
   * `wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''''(0.10 only)'''''

    '''Note: don't confuse a Trac environment directory with the source code repository directory.
  It happens that the above structure is loosely modelled after the Subversion repository directory 
  structure, but they are not and ''must not'' be located at the same place.'''

  ----
  See also: TracAdmin, TracBackup, TracIni, TracGuide


name: TracFastCgi
author: trac
ipnr: 127.0.0.1
text:
  = Trac with FastCGI =

  Since version 0.9, Trac supports being run through the [http://www.fastcgi.com/ FastCGI] interface. Like [wiki:TracModPython mod_python], this allows Trac to remain resident, and is faster than external CGI interfaces which must start a new process for each request. However, unlike mod_python, it is able to support [http://httpd.apache.org/docs/suexec.html SuEXEC]. Additionally, it is supported by much wider variety of web servers.

  {{{
  #!html
  <p style="background: #fdc; border: 2px solid #d00; font-style: italic; padding: 0 .5em; margin: 1em 0;">
  <strong>Note for Windows:</strong> Trac's FCGI does not run under Windows, as Windows does not implement Socket.fromfd, which is used by _fcgi.py
  </p>
  }}}

  == Simple Apache configuration ==

  There are two FastCGI modules commonly available for Apache: `mod_fastcgi` and
  `mod_fcgid`.  The `FastCgiIpcDir` and `FastCgiConfig` directives discussed
  below are `mod_fastcgi` directives; the `DefaultInitEnv` is a `mod_fcgid`
  directive.

  For `mod_fastcgi`, add the following to an appropriate Apache configuration
  file:
  {{{
  # Enable fastcgi for .fcgi files
  # (If you're using a distro package for mod_fcgi, something like
  # this is probably already present)
  <IfModule mod_fastcgi.c>
     AddHandler fastcgi-script .fcgi
     FastCgiIpcDir /var/lib/apache2/fastcgi 
  </IfModule>
  LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so
  }}}
  Setting `FastCgiIpcDir` is optional if the default is suitable. Note that the `LoadModule` line must be after the `IfModule` group.

  Configure `ScriptAlias` or similar options as described in TracCgi, but
  calling `trac.fcgi` instead of `trac.cgi`.

  You can set up the `TRAC_ENV` as an overall default:
  {{{
  FastCgiConfig -initial-env TRAC_ENV=/path/to/env/trac
  }}}

  Or you can serve multiple Trac projects in a directory like:
  {{{
  FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects
  }}}

  But neither of these will work for `mod_fcgid`.  A similar but partial
  solution for `mod_fcgid` is:
  {{{
  DefaultInitEnv TRAC_ENV /path/to/env/trac/
  }}}
  But this cannot be used in `Directory` or `Location` context, which makes it
  difficult to support multiple projects.

  A better method which works for both of these modules (and for  [http://www.lighttpd.net/ lighttpd] and CGI as well), because it involves
  no server configuration settings for environment variables, is to set one
  of the variables in `trac.fcgi`, e.g.:
  {{{
  import os
  os.environ['TRAC_ENV'] = "/path/to/projectenv"
  }}}
  or
  {{{
  import os
  os.environ['TRAC_ENV_PARENT_DIR'] = "/path/to/project/parent/dir"
  }}}

  Using this method, different projects can be supported by using different
  `.fcgi` scripts with different `ScriptAliases`, copying and appropriately
  renaming `trac.fcgi` and adding the above code to create each such script.

  See [https://coderanger.net/~coderanger/httpd/fcgi_example.conf this fcgid example config] which uses a !ScriptAlias directive with trac.fcgi with a trailing / like this:
  {{{
  ScriptAlias / /srv/tracsite/cgi-bin/trac.fcgi/
  }}}

  == Simple Cherokee Configuration ==

  Configuration wanted.

  == Simple Lighttpd Configuration ==

  The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.lighttpd.net/ lighttpd].

  lighttpd is a secure, fast, compliant and very flexible web-server that has been optimized for high-performance
  environments.  It has a very low memory footprint compared to other web servers and takes care of CPU load.

  For using `trac.fcgi` with lighttpd add the following to your lighttpd.conf:
  {{{
  fastcgi.server = ("/trac" =>
                     ("trac" =>
                       ("socket" => "/tmp/trac-fastcgi.sock",
                        "bin-path" => "/path/to/cgi-bin/trac.fcgi",
                        "check-local" => "disable",
                        "bin-environment" =>
                          ("TRAC_ENV" => "/path/to/projenv")
                       )
                     )
                   )
  }}}

  Note that you will need to add a new entry to `fastcgi.server` for each separate Trac instance that you wish to run. Alternatively, you may use the `TRAC_ENV_PARENT_DIR` variable instead of `TRAC_ENV` as described above,
  and you may set one of the two in `trac.fcgi` instead of in `lighttpd.conf`
  using `bin-environment` (as in the section above on Apache configuration).

  For using two projects with lighttpd add the following to your `lighttpd.conf`:
  {{{
  fastcgi.server = ("/first" =>
                     ("first" =>
                      ("socket" => "/tmp/trac-fastcgi-first.sock",
                       "bin-path" => "/path/to/cgi-bin/trac.fcgi",
                       "check-local" => "disable",
                       "bin-environment" =>
                         ("TRAC_ENV" => "/path/to/projenv-first")
                      )
                    ),
                    "/second" =>
                      ("second" =>
                      ("socket" => "/tmp/trac-fastcgi-second.sock",
                       "bin-path" => "/path/to/cgi-bin/trac.fcgi",
                       "check-local" => "disable",
                       "bin-environment" =>
                         ("TRAC_ENV" => "/path/to/projenv-second")
                      )
                    )
                  )
  }}}
  Note that field values are different.  If you prefer setting the environment
  variables in the `.fcgi` scripts, then copy/rename `trac.fcgi`, e.g., to
  `first.fcgi` and `second.fcgi`, and reference them in the above settings.
  Note that the above will result in different processes in any event, even
  if both are running from the same `trac.fcgi` script.
  {{{
  #!html
  <p style="background: #fdc; border: 2px solid #d00; font-style: italic; padding: 0 .5em; margin: 1em 0;">
  <strong>Note from c00i90wn:</strong> It's very important the order on which server.modules are loaded, if mod_auth is not loaded <strong>BEFORE</strong> mod_fastcgi, then the server will fail to authenticate the user.
  </p>
  }}}
  For authentication you should enable mod_auth in lighttpd.conf 'server.modules', select auth.backend and auth rules:
  {{{
  server.modules              = (
  ...
    "mod_auth",
  ...
  )

  auth.backend               = "htpasswd"

  # Separated password files for each project
  # See "Conditional Configuration" in
  # http://trac.lighttpd.net/trac/file/branches/lighttpd-merge-1.4.x/doc/configuration.txt

  $HTTP["url"] =~ "^/first/" {
    auth.backend.htpasswd.userfile = "/path/to/projenv-first/htpasswd.htaccess"
  }
  $HTTP["url"] =~ "^/second/" {
    auth.backend.htpasswd.userfile = "/path/to/projenv-second/htpasswd.htaccess"
  }

  # Enable auth on trac URLs, see
  # http://trac.lighttpd.net/trac/file/branches/lighttpd-merge-1.4.x/doc/authentication.txt

  auth.require = ("/first/login" =>
                  ("method"  => "basic",
                   "realm"   => "First project",
                   "require" => "valid-user"
                  ),
                  "/second/login" =>
                  ("method"  => "basic",
                   "realm"   => "Second project",
                   "require" => "valid-user"
                  )
                 )


  }}}
  Note that lighttpd (I use version 1.4.3) stopped if password file doesn't exist.

  Note that lighttpd doesn't support 'valid-user' in versions prior to 1.3.16.

  Conditional configuration is also useful for mapping static resources, i.e. serving out images and CSS directly instead of through FastCGI:
  {{{
  # Aliasing functionality is needed
  server.modules += ("mod_alias")

  # Setup an alias for the static resources
  alias.url = ("/trac/chrome/common" => "/usr/share/trac/htdocs")

  # Use negative lookahead, matching all requests that ask for any resource under /trac, EXCEPT in
  # /trac/chrome/common, and use FastCGI for those
  $HTTP["url"] =~ "^/trac(?!/chrome/common)" {
  # Even if you have other fastcgi.server declarations for applications other than Trac, do NOT use += here
  fastcgi.server = ("/trac" =>
                     ("trac" =>
                       ("socket" => "/tmp/trac-fastcgi.sock",
                        "bin-path" => "/path/to/cgi-bin/trac.fcgi",
                        "check-local" => "disable",
                        "bin-environment" =>
                          ("TRAC_ENV" => "/path/to/projenv")
                       )
                     )
                   )
  }
  }}}
  The technique can be easily adapted for use with multiple projects by creating aliases for each of them, and wrapping the fastcgi.server declarations inside conditional configuration blocks.
  Also there is another way to handle multiple projects and it's to use TRAC_ENV_PARENT_DIR instead of TRAC_ENV and use global auth, let's see an example:
  {{{
  #  This is for handling multiple projects
    alias.url       = ( "/trac/" => "/path/to/trac/htdocs/" )

    fastcgi.server += ("/projects"  =>
                        ("trac" =>
                          (
                            "socket" => "/tmp/trac.sock",
                            "bin-path" => "/path/to/cgi-bin/trac.fcgi",
                            "check-local" => "disable",
                            "bin-environment" =>
                              ("TRAC_ENV_PARENT_DIR" => "/path/to/parent/dir/of/projects/" )
                          )
                        )
                      )
  #And here starts the global auth configuration
    auth.backend = "htpasswd"
    auth.backend.htpasswd.userfile = "/path/to/unique/htpassword/file/trac.htpasswd"
    $HTTP["url"] =~ "^/projects/.*/login$" {
      auth.require = ("/" =>
                       (
                         "method"  => "basic",
                         "realm"   => "trac",
                         "require" => "valid-user"
                       )
                     )
    }
  }}}

  Changing date/time format also supported by lighttpd over environment variable LC_TIME
  {{{
  fastcgi.server = ("/trac" =>
                     ("trac" =>
                       ("socket" => "/tmp/trac-fastcgi.sock",
                        "bin-path" => "/path/to/cgi-bin/trac.fcgi",
                        "check-local" => "disable",
                        "bin-environment" =>
                          ("TRAC_ENV" => "/path/to/projenv",
                          "LC_TIME" => "ru_RU")
                       )
                     )
                   )
  }}}
  For details about languages specification see TracFaq question 2.13.

  Other important information like [http://trac.lighttpd.net/trac/wiki/TracInstall this updated TracInstall page], [wiki:TracCgi#MappingStaticResources and this] are useful for non-fastcgi specific installation aspects.

  If you use trac-0.9, read [http://lists.edgewall.com/archive/trac/2005-November/005311.html about small bug]

  Relaunch lighttpd, and browse to `http://yourhost.example.org/trac` to access Trac.

  Note about running lighttpd with reduced permissions:

    If nothing else helps and trac.fcgi doesn't start with lighttpd settings __server.username = "www-data"__, __server.groupname = "www-data"__, then in the `bin-environment` section set `PYTHON_EGG_CACHE` to the home directory of `www-data` or some other directory accessible to this account for writing.


  == Simple LiteSpeed Configuration ==

  The FastCGI front-end was developed primarily for use with alternative webservers, such as [http://www.litespeedtech.com/ LiteSpeed].

  LiteSpeed web server is an event-driven asynchronous Apache replacement designed from the ground-up to be secure, scalable, and operate with minimal resources. LiteSpeed can operate directly from an Apache config file and is targeted for business-critical environments.

  Setup

  1) Please make sure you have first have a working install of a Trac project. Test install with “tracd” first.

  2) Create a Virtual Host for this setup. From now on we will refer to this vhost as TracVhost. For this tutorial we will be assuming that your trac project will be accessible via:

  {{{
  http://yourdomain.com/trac/
  }}}

  3) Go “TracVhost → External Apps” tab and create a new “External Application”.

  {{{
  Name: MyTracFCGI	
  Address: uds://tmp/lshttpd/mytracfcgi.sock
  Max Connections: 10
  Environment: TRAC_ENV=/fullpathto/mytracproject/ <--- path to root folder of trac project
  Initial Request Timeout (secs): 30
  Retry Timeout (secs): 0
  Persistent Connection	Yes
  Connection Keepalive Timeout: 30
  Response Bufferring: No	
  Auto Start: Yes
  Command: /usr/share/trac/cgi-bin/trac.fcgi  <--- path to trac.fcgi
  Back Log: 50
  Instances: 10
  }}}

  4) Optional. If you need to use htpasswd based authentication. Go to “TracVhost → Security” tab and create a new security “Realm”.

  {{{
  DB Type: Password File
  Realm Name: MyTracUserDB               <--- any name you wish and referenced later
  User DB Location: /fullpathto/htpasswd <--- path to your htpasswd file
  }}}

  If you don’t have a htpasswd file or don’t know how to create the entries within one, go to http://sherylcanter.com/encrypt.php, to generate the user:password combos.

  5) Go to “PythonVhost → Contexts” and create a new “FCGI Context”.

  {{{
  URI: /trac/                              <--- URI path to bind to python fcgi app we created	
  Fast CGI App: [VHost Level] MyTractFCGI  <--- select the trac fcgi extapp we just created
  Realm: TracUserDB                        <--- only if (4) is set. select realm created in (4)
  }}}

  6) Modify /fullpathto/mytracproject/conf/trac.ini

  {{{
  #find/set base_rul, url, and link variables
  base_url = http://yourdomain.com/trac/ <--- base url to generate correct links to
  url = http://yourdomain.com/trac/      <--- link of project
  link = http://yourdomain.com/trac/     <--- link of graphic logo
  }}}

  7) Restart LiteSpeed, “lswsctrl restart”, and access your new Trac project at: 

  {{{
  http://yourdomain.com/trac/
  }}}

  ----
  See also TracCgi, TracModPython, TracInstall, TracGuide


name: TracFineGrainedPermissions
author: trac
ipnr: 127.0.0.1
text:
  = Fine grained permissions =

  Before Trac 0.11, it was only possible to define fine-grained permissions checks on the repository browser sub-system.

  Since 0.11, there's a general mechanism in place that allows custom permission policy plugins to grant or deny any action on any kind of Trac resources, even at the level of specific versions of such resources.

  == Permission Policies ==

  === !AuthzPolicy ===

  An example policy based on an Authz-style system has been added. See
  [source:trunk/sample-plugins/permissions/authz_policy.py] for details. (See also [source:trunk/sample-plugins/permissions] for more samples.)

   - Install [http://www.voidspace.org.uk/python/configobj.html ConfigObj] (required).
   - Copy authz_policy.py into your plugins directory.
   - Put a [http://swapoff.org/files/authzpolicy.conf authzpolicy.conf] file somewhere (preferably on a secured location on the server, not readable for others than the webuser.
   - Update your `trac.ini`:
  {{{
  [trac]
  ...
  permission_policies = AuthzPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy

  [authz_policy]
  authz_file = /some/trac/env/conf/authzpolicy.conf

  [components]
  ...
  authz_policy = enabled
  }}}

  Note that the order in which permission policies are specified is quite critical, 
  as policies will be examined in the sequence provided.

  A policy will return either `True`, `False` or `None` for a given permission check.
  Only if the return value is `None` will the ''next'' permission policy be consulted.
  If no policy explicitly grants the permission, the final result will be `False` 
  (i.e. no permission).

  For example, if the `authz_file` contains:
  {{{
  [wiki:WikiStart@*]
  * = WIKI_VIEW

  [wiki:PrivatePage@*]
  john = WIKI_VIEW
  * =
  }}}
  and the default permissions are set like this:
  {{{
  john           WIKI_VIEW
  jack           WIKI_VIEW
  # anonymous has no WIKI_VIEW
  }}}

  Then: 
   - All versions of WikiStart will be viewable by everybody (including anonymous)
   - !PrivatePage will be viewable only by john
   - other pages will be viewable only by john and jack


  === mod_authz_svn-like permission policy ===

  At the time of this writing, the old fine grained permissions system from Trac 0.10 and before used for restricting access to the repository has not yet been converted to a permission policy component, but from the user point of view, this makes little if no differences.

  That kind of fine-grained permission control needs a definition file, which is the one used by Subversion's mod_authz_svn. 
  More information about this file format and about its usage in Subversion is available in the [http://svnbook.red-bean.com/svnbook/book.html#svn-ch-6-sect-4.4.2 Subversion Book (Per-Directory Access Control)].

  Example:
  {{{
  [/]
  * = r

  [/branches/calc/bug-142]
  harry = rw
  sally = r

  [/branches/calc/bug-142/secret]
  harry =
  }}}

   * '''/''' = ''Everyone has read access by default''
   * '''/branches/calc/bug-142''' = ''harry has read/write access, sally read only''
   * '''/branches/calc/bug-142/secret''' = ''harry has no access, sally has read access (inherited as a sub folder permission)''

  ==== Trac Configuration ====

  To activate fine grained permissions you __must__ specify the {{{authz_file}}} option in the {{{[trac]}}} section of trac.ini. If this option is set to null or not specified the permissions will not be used.

  {{{
  [trac]
  authz_file = /path/to/svnaccessfile
  }}}

  if you want to support the use of the `[`''modulename''`:/`''some''`/`''path''`]` syntax within the `authz_file`, add 

  {{{
  authz_module_name = modulename
  }}}

  where ''modulename'' refers to the same repository indicated by the `repository_dir` entry in the `[trac]` section.

  '''Note:''' Usernames inside the Authz file __must__ be the same as those used inside trac. 

  ==== Subversion Configuration ====

  The same access file is typically applied to the corresponding Subversion repository using an Apache directive like this:
  {{{
  <Location /repos>
    DAV svn
    SVNParentPath /usr/local/svn

    # our access control policy
    AuthzSVNAccessFile /path/to/svnaccessfile
  </Location>
  }}}

  For information about how to restrict access to entire projects in a multiple project environment see [trac:wiki:TracMultipleProjectsSVNAccess]

  ----
  See also: TracPermissions


name: TracGuide
author: trac
ipnr: 127.0.0.1
text:
  = The Trac User and Administration Guide =
  [[TracGuideToc]]

  The TracGuide is meant to serve as a starting point for all documentation regarding Trac usage and development. The guide is a free document, a collaborative effort, and a part of the [http://trac.edgewall.org Trac Project] itself.

  == Table of Contents ==
  Currently available documentation:
   * TracGuide (This page)  -- Documentation starting point.
   * '''Administrator Guide'''
     * TracInstall -- How to install and run Trac.
     * TracUpgrade -- How to upgrade existing installations.
     * TracAdmin -- Administering a Trac project.
     * TracImport -- Importing tickets from other bug databases.
     * TracIni -- Trac configuration file reference. 
     * TracPermissions -- Access control and permissions.
     * TracInterfaceCustomization -- Customizing the Trac interface.
     * TracPlugins -- Installing and managing Trac extensions.
     * TracLogging -- The Trac logging facility.
     * TracNotification -- Email notification.
     * TracWorkflow -- Configurable Ticket Workflow.
   * '''User Guide'''
     * TracWiki -- How to use the built-in Wiki.
     * TracTimeline -- The timeline provides a historic perspective on a project.
     * TracRss -- RSS content syndication in Trac.
     * ''The Version Control Subsystem''
       * TracBrowser -- Browsing source code with Trac.
       * TracChangeset -- Viewing changes to source code.
       * TracRevisionLog -- Viewing change history.
     * ''The Ticket Subsystem''
       * TracTickets -- Using the issue tracker.
       * TracReports -- Writing and using reports.
       * TracQuery -- Executing custom ticket queries.
       * TracRoadmap -- The roadmap helps tracking project progress.
   * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] - A collection of Frequently Asked Questions (on the project website).

  == Support and Other Sources of Information ==
  If you are looking for a good place to ask a question about Trac, look no further than the [http://trac.edgewall.org/wiki/MailingList MailingList]. It provides a friendly environment to discuss openly among Trac users and developers.

  See also the TracSupport page for more information resources.


name: TracImport
author: trac
ipnr: 127.0.0.1
text:
  = Importing ticket data =

  == Bugzilla ==

  Ticket data can be imported from Bugzilla using the [http://trac.edgewall.org/browser/trunk/contrib/bugzilla2trac.py bugzilla2trac.py] script, available in the contrib/ directory of the Trac distribution.

  {{{
  $ bugzilla2trac.py
  bugzilla2trac - Imports a bug database from Bugzilla into Trac.

  Usage: bugzilla2trac.py [options]

  Available Options:
    --db <MySQL dbname>              - Bugzilla's database
    --tracenv /path/to/trac/env      - full path to Trac db environment
    -h | --host <MySQL hostname>     - Bugzilla's DNS host name
    -u | --user <MySQL username>     - effective Bugzilla's database user
    -p | --passwd <MySQL password>   - Bugzilla's user password
    -c | --clean                     - remove current Trac tickets before importing
    --help | help                    - this help info

  Additional configuration options can be defined directly in the script.
  }}}

  Currently, the following data is imported from Bugzilla:

    * bugs
    * bug activity (field changes)
    * bug attachments
    * user names and passwords (put into a htpasswd file)

  The script provides a number of features to ease the conversion, such as:

    * PRODUCT_KEYWORDS:  Trac doesn't have the concept of products, so the script provides the ability to attach a ticket keyword instead.

    * IGNORE_COMMENTS:  Don't import Bugzilla comments that match a certain regexp.

    * STATUS_KEYWORDS:  Attach ticket keywords for the Bugzilla statuses not available in Trac.  By default, the 'VERIFIED' and 'RELEASED' Bugzilla statuses are translated into Trac keywords.

  For more details on the available options, see the configuration section at the top of the script.

  == Sourceforge ==

  Ticket data can be imported from Sourceforge using the [http://trac.edgewall.org/browser/trunk/contrib/sourceforge2trac.py sourceforge2trac.py] script, available in the contrib/ directory of the Trac distribution.

  == Mantis ==

  NB! The mantis2trac script now lives at http://trac-hacks.org/wiki/MantisImportScript . You can always get the latest version from http://trac-hacks.org/changeset/latest/mantisimportscript?old_path=/&filename=mantisimportscript&format=zip

  Mantis bugs can be imported using the attached script.

  Currently, the following data is imported from Mantis:
    * bugs
    * bug comments
    * bug activity (field changes)
    * attachments (as long as the files live in the mantis db, not on the filesystem) 

  If you use the script, please read the NOTES section (at the top of the file) and make sure you adjust the config parameters for your environment.

  mantis2trac.py has the same parameters as the bugzilla2trac.py script:
  {{{
  mantis2trac - Imports a bug database from Mantis into Trac.

  Usage: mantis2trac.py [options] 

  Available Options:
    --db <MySQL dbname>              - Mantis database
    --tracenv /path/to/trac/env      - Full path to Trac db environment
    -h | --host <MySQL hostname>     - Mantis DNS host name
    -u | --user <MySQL username>     - Effective Mantis database user
    -p | --passwd <MySQL password>   - Mantis database user password
    -c | --clean                     - Remove current Trac tickets before importing
    --help | help                    - This help info

  Additional configuration options can be defined directly in the script.
  }}} 

  == Other ==

  Since trac uses a SQL database to store the data, you can import from other systems by examining the database tables. Just go into [http://www.sqlite.org/sqlite.html sqlite] command line to look at the tables and import into them from your application.

  === Using a comma delimited file - CSV ===
  See [http://trac.edgewall.org/attachment/wiki/TracSynchronize/csv2trac.2.py] for details.  This approach is particularly useful if one needs to enter a large number of tickets by hand. (note that the ticket type type field, (task etc...) is also needed for this script to work with more recent Trac releases)


name: TracIni
author: trac
ipnr: 127.0.0.1
text:
  = The Trac Configuration File =

  [[TracGuideToc]]

  == Global Configuration ==

  In versions prior to 0.11, the global configuration was by default located in `$prefix/share/trac/conf/trac.ini` or sometimes /etc/trac/trac.ini depending on the distribution. If you're upgrading, you may want to specify that file to inherit from.

  Global options will be merged with the environment-specific options, where local options override global options. The options file is specified as follows:
  {{{
  [inherit]
  file = /usr/share/trac/conf/trac.ini
  }}}

  Note that you can also specify a global option file when creating a new project,  by adding the option
  `--inherit=/path/to/global/options` to [TracAdmin trac-admin]'s `initenv` command.
  If you would not do this but nevertheless intend to use a global option file with your new environment, 
  you would have to go through the newly generated conf/trac.ini file and delete the entries that would
  otherwise override those set in the global file.


  == Reference ==

  This is a brief reference of available configuration options.

  [[TracIni()]]


  == [components] == #components-section
  This section is used to enable or disable components provided by plugins, as well as by Trac itself. The component to enable/disable is specified via the name of the option. Whether its enabled is determined by the option value; setting the value to `enabled` or `on` will enable the component, any other value (typically `disabled` or `off`) will disable the component.

  The option name is either the fully qualified name of the components or the module/package prefix of the component. The former enables/disables a specific component, while the latter enables/disables any component in the specified package/module.

  Consider the following configuration snippet:
  {{{
  [components]
  trac.ticket.report.ReportModule = disabled
  webadmin.* = enabled
  }}}

  The first option tells Trac to disable the [wiki:TracReports report module]. The second option instructs Trac to enable all components in the `webadmin` package. Note that the trailing wildcard is required for module/package matching.

  See the ''Plugins'' page on ''About Trac'' to get the list of active components (requires `CONFIG_VIEW` [wiki:TracPermissions permissions].)

  See also: TracPlugins

  == [ticket-custom] == #ticket-custom-section

  In this section, you can define additional fields for tickets. See TracTicketsCustomFields for more details.

  == [ticket-workflow] == #ticket-workflow-section
  ''(since 0.11)''

  The workflow for tickets is controlled by plugins. 
  By default, there's only a `ConfigurableTicketWorkflow` component in charge. 
  That component allows the workflow to be configured via this section in the trac.ini file.
  See TracWorkflow for more details.

  == [milestone-groups] == #milestone-groups-section
  ''(since 0.11)''

  As the workflow for tickets is now configurable, there can be many ticket states,
  and simply displaying closed tickets vs. all the others is maybe not appropriate 
  in all cases. This section enables one to easily create ''groups'' of states 
  that will be shown in different colors in the milestone progress bar.

  Example configuration (which is also the default):
  {{{
  closed = closed
  closed.order = 0                     # sequence number in the progress bar
  closed.query_args = group=resolution # optional extra param for the query
  closed.overall_completion = true     # count for overall completion

  active = *                           # one catch-all group is allowed
  active.order = 1
  active.css_class = open              # CSS class for this interval
  active.label = in progress           # Displayed label for this group
  }}}

  The definition consists in a comma-separated list of accepted status.
  Also, '*' means any status and could be used to associate all remaining
  states to one catch-all group.

  The CSS class can be one of: new (yellow), open (no color) or
  closed (green). New styles can easily be added using the following
  selector:  `table.progress td.<class>`

  == [svn:externals] == #svn:externals-section
  ''(since 0.11)''

  The TracBrowser for Subversion can interpret the `svn:externals` property of folders out of the box.
  However, if those externals are ''not'' using the `http:` protocol, or if a link to a different repository browser (such another Trac or [http://www.viewvc.org/ ViewVC]) is desired, then Trac needs to be able to map an external prefix to this other URL.

  This mapping is done in the `[svn:externals]` section of the TracIni

  Example:
  {{{
  [svn:externals]
  1 = svn://server/repos1 http://trac/proj1/browser/$path?rev=$rev
  2 = svn://server/repos2 http://trac/proj2/browser/$path?rev=$rev
  3 = http://theirserver.org/svn/eng-soft       http://ourserver/viewvc/svn/$path/?pathrev=25914
  4 = svn://anotherserver.com/tools_repository  http://ourserver/trac/support/browser/$path?rev=$rev
  }}}
  With the above, the `svn://anotherserver.com/tools_repository/tags/1.1/tools` external will be mapped to `http://ourserver/trac/support/browser/tags/1.1/tools?rev=` (and `rev` will be set to the appropriate revision number if the external additionally specifies a revision, see the [http://svnbook.red-bean.com/en/1.4/svn.advanced.externals.html SVN Book on externals] for more details).

  Note that the number used as a key in the above section is purely used as a place holder, as the URLs themselves can't be used as a key due to various limitations in the configuration file parser.

  ----
  See also: TracGuide, TracAdmin, TracEnvironment


name: TracInstall
author: trac
ipnr: 127.0.0.1
text:
  = Trac Installation Guide for 0.11 = 
  [[TracGuideToc]]

  Trac is written in the Python programming language and needs a database, [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL], or [http://mysql.com/ MySQL]. For HTML rendering, Trac uses the [http://genshi.edgewall.org Genshi] templating system.

  What follows are generic instructions for installing and setting up Trac and its requirements. While you can find instructions for installing Trac on specific systems at TracInstallPlatforms on the main Trac site, please be sure to '''first read through these general instructions''' to get a good understanding of the tasks involved.

  == Short - Install a released version ==
  For the quick install, make sure you have [http://python.org Python-2.5], [http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install easy_install] and SQlite-3.3.4 installed (or above).
  {{{
  sudo easy_install Trac==0.11
  }}}

  == Requirements - also older versions possible ==

  To install Trac, the following software packages must be installed:

   * [http://www.python.org/ Python], version >= 2.3
     * if using mod_python together with xml-related things, use python-2.5. expat is namespaced there and does not cause apache to crash any more(see [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash here] for details).
     * For RPM-based systems you might also need the `python-devel` and `python-xml` packages.
     * See instructions in ["TracOnWindows/Python2.5"]
   * [http://peak.telecommunity.com/DevCenter/setuptools setuptools], version >= 0.6
   * [http://genshi.edgewall.org/wiki/Download Genshi], version >= 0.4.1
   * You also need a database system and the corresponding python drivers for it.
     The database can be either SQLite, PostgreSQL or ''MySQL (experimental)''.
   * optional if some plugins require it: [http://www.clearsilver.net/ ClearSilver]

  === For SQLite ===

   * [http://www.sqlite.org/ SQLite], version 3.3.4 and above preferred.
   * If not using Python-2.5: [http://pysqlite.org/ PySQLite], version 1.x (for SQLite 2.x) or version 2.x (for SQLite 3.x), version 2.3.2 preferred. For details see PySqlite

  ''Note: It appears that PySQLite 2.x is required for Trac 0.9+/SQLite 3.x if you plan to use the 'trac-post-commit-hook.py' script available from the 'contrib' section of the source repository.''

  ''Note: Users of Mac OS X please take care; the Apple-supplied SQLite contains additional code to support file locking on network filesystems like AFP or SMB. This is not presently (3.3.6) in the mainline sources, so if you build your own SQLite from source it will not function correctly on such filesystems - typically it gives the error "{{{database is locked}}}". [http://www.alastairs-place.net/2006/07/sqlite_and_mac/ A patch] is available for version 3.3.6, based on Apple's code, otherwise you're probably best off using the Apple supplied version (presently 3.1.3).''

  === For PostgreSQL ===

   * [http://www.postgresql.org/ PostgreSQL]
   * [http://initd.org/projects/psycopg2 psycopg2] or [http://pypgsql.sourceforge.net/ pyPgSQL]

  '''Warning''': PostgreSQL 8.3 uses a strict type checking mechanism. To use Trac with the 8.3 Version of PostgreSQL, you will need [http://trac.edgewall.org/changeset/6512 trac-0.11] or later.

  === For MySQL ===

  '''Warning''': MySQL support is currently ''still'' experimental. That means it works for some people, but several issues remain, in particular regarding the use of unicode and the key length in the repository cache. See MySqlDb for more detailed information.

   * [http://mysql.com/ MySQL], version 4.1 or later
   * [http://sf.net/projects/mysql-python MySQLdb], version 1.2.1 or later

  === Optional Requirements ===

  ==== Version Control System ====

  '''Please note:''' if using Subversion, Trac must be installed on the '''same machine'''. Remote repositories are currently not supported.

   * [http://subversion.tigris.org/ Subversion], version >= 1.0. (versions recommended: 1.2.4, 1.3.2 or 1.4.2) and the '''''corresponding''''' Python bindings. For troubleshooting, check TracSubversion
     * Trac uses the [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 SWIG] bindings included in the Subversion distribution, '''not''' [http://pysvn.tigris.org/ PySVN] (which is sometimes confused with the standard SWIG bindings).
     * If Subversion was already installed without the SWIG bindings, on Unix you'll need to re-`configure` Subversion and `make swig-py`, `make install-swig-py`.
     * There are [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 pre-compiled bindings] available for win32. 
   * Support for other version control systems is provided via third-parties. See PluginList and VersioningSystemBackend.

  ==== Web Server ====
   * A CGI-capable web server (see TracCgi), or
   * a [http://www.fastcgi.com/ FastCGI]-capable web server (see TracFastCgi), or
   * [http://httpd.apache.org/ Apache] with [http://code.google.com/p/modwsgi/ mod_wsgi] (see [wiki:TracModWSGI])
      * This should work with Apache 1.3, 2.0 or 2.2 and promises to deliver more performance than using mod_python. A little less mature than mod_python.
   * [http://httpd.apache.org/ Apache] with [http://www.modpython.org/ mod_python 3.1.3+] (see TracModPython)
      * When installing mod_python the development versions of Python and Apache are required (actually the libraries and header files)

  For those stuck with Apache 1.3, it is also possible to get Trac working with [http://www.modpython.org/ mod_python 2.7] (see [wiki:TracModPython2.7 TracModPython2.7]). This guide hasn't been updated since 0.84, so it may or may not work.

  ==== Other Python Utilities ====
   * [http://docutils.sourceforge.net/ docutils], version >= 0.3.9 for WikiRestructuredText.
   * [http://pygments.pocoo.org Pygments] for [wiki:TracSyntaxColoring syntax highlighting], also [http://silvercity.sourceforge.net/ SilverCity] and/or [http://gnu.org/software/enscript/enscript.html Enscript] may still be used.
      * Note that !SilverCity 0.9.6 has a [http://sourceforge.net/tracker/index.php?func=detail&aid=1424436&group_id=45693&atid=443739 bug] that breaks Python syntax highlighting in Trac. Until an update is made available, we recommend using version 0.9.5.
   * [http://pytz.sf.net pytz] to get a complete list of time zones, otherwise Trac will fall back on a shorter list from an internal time zone implementation.

  '''Attention''': The various available versions of these dependencies are not necessarily interchangable, so please pay attention to the version numbers above. If you are having trouble getting Trac to work please double-check all the dependencies before asking for help on the MailingList or IrcChannel.

  Please refer to the documentation of these packages to find out how they are best installed. In addition, most of the [wiki:TracInstallPlatforms platform-specific instructions] also describe the installation of the dependencies. Keep in mind however that the information there ''probably concern older versions of Trac than the one you're installing'' (there are even some pages that are still talking about Trac 0.8!).

  == Installing Trac ==

  One way to install Trac is using `setuptools`.
  With setuptools you can install Trac from the subversion repository; for example,
  to install release version 0.11b2 do:
  {{{
  easy_install http://svn.edgewall.org/repos/trac/tags/trac-0.11b2
  }}}

  But of course the python-typical setup at the top of the source directory also works:
  {{{
  $ python ./setup.py install
  }}}

  ''Note: you'll need root permissions or equivalent for this step.''

  This will byte-compile the python source code and install it as an .egg file or folder in the `site-packages` directory
  of your Python installation. The .egg will also contain all other resources needed by standard Trac, such as htdocs and templates.

  The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments], as well as the [wiki:TracStandalone tracd] standalone server.

  === Advanced Options ===

  To install Trac to a custom location, or find out about other advanced installation options, run:
  {{{
  easy_install --help
  }}}

  Also see [http://docs.python.org/inst/inst.html Installing Python Modules] for detailed information.

  Specifically, you might be interested in:
  {{{
  easy_install --prefix=/path/to/installdir
  }}}
  or, if installing Trac to a Mac OS X system:
  {{{
  easy_install --prefix=/usr/local --install-dir=/Library/Python/2.5/site-packages
  }}}

  The above will place your `tracd` and `trac-admin` commands into `/usr/local/bin` and will install the Trac libraries and dependencies into `/Library/Python/2.5/site-packages`, which is Apple's preferred location for third-party Python application installations.

  == Creating a Project Environment ==

  A [wiki:TracEnvironment Trac environment] is the backend storage where Trac stores information like wiki pages, tickets, reports, settings, etc. An environment is basically a directory that contains a human-readable configuration file and various other files and directories.

  A new environment is created using [wiki:TracAdmin trac-admin]:
  {{{
  $ trac-admin /path/to/myproject initenv
  }}}

  [wiki:TracAdmin trac-admin] will prompt you for the information it needs to create the environment, such as the name of the project, the type and the path to an existing [wiki:TracEnvironment#SourceCodeRepository source code repository], the [wiki:TracEnvironment#DatabaseConnectionStrings database connection string], and so on. If you're not sure what to specify for one of these options, just leave it blank to use the default value. The database connection string in particular will always work as long as you have SQLite installed. Leaving the path to the source code repository empty will disable any functionality related to version control, but you can always add that back when the basic system is running.

  Also note that the values you specify here can be changed later by directly editing the [wiki:TracIni] configuration file.

  ''Note: The user account under which the web server runs will require write permissions to the environment directory and all the files inside.  On Linux, with the web server running as user apache and group apache, enter:''

    chown -R apache.apache /path/to/myproject


  == Running the Standalone Server ==

  After having created a Trac environment, you can easily try the web interface by running the standalone server [wiki:TracStandalone tracd]:
  {{{
  $ tracd --port 8000 /path/to/myproject
  }}}

  Then, fire up a browser and visit `http://localhost:8000/`. You should get a simple listing of all environments that tracd knows about. Follow the link to the environment you just created, and you should see Trac in action. If you only plan on managing a single project with trac you can have the standalone server skip the environment list by starting it like this:
  {{{
  $ tracd -s --port 8000 /path/to/myproject
  }}}


  == Running Trac on a Web Server ==

  Trac provides three options for connecting to a "real" web server: [wiki:TracCgi CGI], [wiki:TracFastCgi FastCGI] and [wiki:TracModPython mod_python]. For decent performance, it is recommended that you use either FastCGI or mod_python.

  If you're not afraid of running development code, you can also try running Trac on [wiki:TracModWSGI mod_wsgi]. This should deliver even better performance than mod_python, but the module is not considered stable just yet.

  == Configuring Authentication ==

  The process of adding, removing, and configuring user accounts for authentication depends on the specific way you run Trac. The basic procedure is described in the [wiki:TracCgi#AddingAuthentication "Adding Authentication"] section on the TracCgi page. To learn how to setup authentication for the frontend you're using, please refer to one of the following pages:

   * TracStandalone if you use the standalone server, `tracd`.
   * TracCgi if you use the CGI or FastCGI methods.
   * TracModPython if you use the mod_python method.

  == Trac 0.11 & SVN on Mac OS X Leopard (10.5) ==

   * TracOnLeopardServer

  == Using Trac ==

  Once you have your Trac site up and running, you should be able to browse your subversion repository, create tickets, view the timeline, etc.

  Keep in mind that anonymous (not logged in) users can by default access most but not all of the features. You will need to configure authentication and grant additional [wiki:TracPermissions permissions] to authenticated users to see the full set of features.

  '' Enjoy! ''

  [wiki:TracTeam The Trac Team]

  ----
  See also:  TracGuide, TracCgi, TracFastCgi, TracModPython, [wiki:TracModWSGI], TracUpgrade, TracPermissions


name: TracInterfaceCustomization
author: trac
ipnr: 127.0.0.1
text:
  = Customizing the Trac Interface =
  [[TracGuideToc]]

  == Introduction ==
  This page is meant to give users suggestions on how they can customize the look of Trac.  Topics on this page cover editing the HTML templates and CSS files, but not the program code itself.  The topics are intended to show users how they can modify the look of Trac to meet their specific needs.  Suggestions for changes to Trac's interface applicable to all users should be filed as tickets, not listed on this page.

  == Project Logo and Icon ==
  The easiest parts of the Trac interface to customize are the logo and the site icon.  Both of these can be configured with settings in [wiki:TracIni trac.ini].

  The logo or icon image should be put in a folder named "htdocs" in your project's environment folder.  (''Note: in projects created with a Trac version prior to 0.9 you will need to create this folder'')

   ''Note: you can actually put the logo and icon anywhere on your server (as long as it's accessible through the web server), and use their absolute or server-relative URLs in the configuration.''

  Now configure the appropriate section of your [wiki:TracIni trac.ini]:

  === Logo ===
  Change the `src` setting to `site/` followed by the name of your image file.  The `width` and `height` settings should be modified to match your image's dimensions (the Trac chrome handler uses "`site/`" for files within the project directory `htdocs` and "`common/`" for the common ones).

  {{{
  [header_logo]
  src = site/my_logo.gif
  alt = My Project
  width = 300
  height = 100
  }}}

  === Icon ===
  Icons should be a 16x16 image in `.gif` or `.ico` format.  Change the `icon` setting to `site/` followed by the name of your icon file.  Icons will typically be displayed by your web browser next to the site's URL and in the `Bookmarks` menu.

  {{{
  [project]
  icon = site/my_icon.ico
  }}}

  Note though that this icon is ignored by Internet Explorer, which only accepts a file named ``favicon.ico`` at the root of the host. To make the project icon work in both IE and other browsers, you can store the icon in the document root of the host, and reference it from ``trac.ini`` as follows:

  {{{
  [project]
  icon = /favicon.ico
  }}}

  == Custom Navigation Entries ==
  The new [mainnav] and [metanav] can now be used to customize the text and link used for the navigation items, or even to disable them (but not for adding new ones).

  In the following example, we rename the link to the Wiki start "Home", and hide the "Help/Guide". We also make the "View Tickets" entry link to a specific report .
  {{{
  [mainnav]
  wiki.label = Home
  tickets.href = /report/24

  [metanav]
  help = disabled
  }}}

  See also TracNavigation for a more detailed explanation of the mainnav and metanav terms.

  == Site Appearance ==

  Trac is using [http://genshi.edgewall.org Genshi] as the templating engine. Documentation is yet to be written, in the meantime the following tip should work.

  Say you want to add a link to a custom stylesheet, and then your own
  header and footer.  Create a file {{{/path/to/env/templates/site.html}}} or {{{/path/to/inherit/option/templates_dir/site.html}}}, with contents like this:

  {{{
  #!xml
  <html xmlns="http://www.w3.org/1999/xhtml"
        xmlns:py="http://genshi.edgewall.org/"
        py:strip="">

    <!--! Add site-specific style sheet -->
    <head py:match="head" py:attrs="select('@*')">
      ${select('*|comment()|text()')}
      <link rel="stylesheet" type="text/css"
            href="${href.chrome('site/style.css')}" />
    </head>

    <body py:match="body" py:attrs="select('@*')">
      <!--! Add site-specific header -->
      <div id="siteheader">
        <!--! Place your header content here... -->
      </div>

      ${select('*|text()')}

      <!--! Add site-specific footer -->
      <div id="sitefooter">
        <!--! Place your footer content here... -->
      </div>
    </body>
  </html>
  }}}
  Note that this references your environment's `htdocs/style.css`.

  Example snippet of adding introduction text to the new ticket form (hide when preview):

  {{{
  #!xml
  <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')">
    <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)">
      <p>Please make sure to search for existing tickets before reporting a new one!</p>
    </py:if>
    ${select('*')} 
  </form>
  }}}

  If the environment is upgraded from 0.10 and a `site_newticket.cs` file already exists, it can actually be loaded by using a workaroud - providing it contains no ClearSilver processing. In addition, as only one element can be imported, the content needs some sort of wrapper such as a `<div>` block or other similar parent container. The XInclude namespace must be specified to allow includes, but that can be moved to document root along with the others:
  {{{
  #!xml
  <form py:match="div[@id='content' and @class='ticket']/form" py:attrs="select('@*')"
          xmlns:xi="http://www.w3.org/2001/XInclude">
    <py:if test="req.environ['PATH_INFO'] == '/newticket' and (not 'preview' in req.args)"> 
      <xi:include href="site_newticket.cs"><xi:fallback /></xi:include>
    </py:if>
    ${select('*')} 
  </form>
  }}}

  Also note that the `site.html` (despite its name) can be put in a common templates directory - see the `[inherit] templates_dir` option. This could provide easier maintainence (and a migration path from 0.10 for larger installations) as one new global `site.html` file can be made to include any existing header, footer and newticket snippets.

  == Project List ==
  You can use a custom Genshi template to display the list of projects if you are using Trac with multiple projects.  

  The following is the basic template used by Trac to display a list of links to the projects.  For projects that could not be loaded it displays an error message. You can use this as a starting point for your own index template.

  {{{
  #!text/html
  <!DOCTYPE html
      PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml"
        xmlns:py="http://genshi.edgewall.org/"
        xmlns:xi="http://www.w3.org/2001/XInclude">
    <head>
      <title>Available Projects</title>
    </head>
    <body>
      <h1>Available Projects</h1>
      <ul>
        <li py:for="project in projects" py:choose="">
          <a py:when="project.href" href="$project.href"
             title="$project.description">$project.name</a>
          <py:otherwise>
            <small>$project.name: <em>Error</em> <br /> ($project.description)</small>
          </py:otherwise>
        </li>
      </ul>
    </body>
  </html>
  }}}

  Once you've created your custom template you will need to configure the webserver to tell Trac where the template is located (pls verify ... not yet changed to 0.11):

  For [wiki:TracFastCgi FastCGI]:
  {{{
  FastCgiConfig -initial-env TRAC_ENV_PARENT_DIR=/parent/dir/of/projects \
                -initial-env TRAC_ENV_INDEX_TEMPLATE=/path/to/template
  }}}

  For [wiki:TracModPython mod_python]:
  {{{
  PythonOption TracEnvIndexTemplate /path/to/template
  }}}

  For [wiki:TracCgi CGI]:
  {{{
  SetEnv TRAC_ENV_INDEX_TEMPLATE /path/to/template
  }}}

  For [wiki:TracStandalone], you'll need to set up the `TRAC_ENV_INDEX_TEMPLATE` environment variable in the shell used to launch tracd:
   - Unix
     {{{
  #!sh
  $ export TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     }}}
   - Windows
     {{{
  #!sh
  $ set TRAC_ENV_INDEX_TEMPLATE=/path/to/template
     }}}

  ----
  See also TracGuide, TracIni


name: TracLinks
author: trac
ipnr: 127.0.0.1
text:
  = Trac Links =
  [[TracGuideToc]]

  TracLinks are a fundamental feature of Trac, because they allow easy hyperlinking between the various entities in the system—such as tickets, reports, changesets, Wiki pages, milestones, and source files—from anywhere WikiFormatting is used.

  TracLinks are generally of the form '''type:id''' (where ''id'' represents the
  number, name or path of the item) though some frequently used kinds of items
  also have short-hand notations.

  == Where to use TracLinks ==
  You can use TracLinks in:

   * Source code (Subversion) commit messages
   * Wiki pages
   * Full descriptions for tickets, reports and milestones

  and any other text fields explicitly marked as supporting WikiFormatting.

  Some examples:
   * Tickets: '''!#1''' or '''!ticket:1'''
   * Ticket comments: '''!comment:ticket:1:2''' 
   * Reports: '''!{1}''' or '''!report:1'''
   * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''', '''![2:5/trunk]'''
   * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3'''
   * Diffs (requires [milestone:0.10 0.10]): '''!diff:@1:3''', '''!diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default''' or '''!diff:trunk/trac@3538//sandbox/vc-refactoring@3539'''
   * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase'''
   * Parent page: '''![..]'''
   * Milestones: '''!milestone:1.0'''
   * Attachment: '''!attachment:ticket:944:attachment.1073.diff'''
   * Files: '''!source:trunk/COPYING'''
   * A specific file revision: '''!source:/trunk/COPYING@200'''
   * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25'''
  Display:
   * Tickets: #1 or ticket:1
   * Ticket comments: comment:ticket:1:2 
   * Reports: {1} or report:1
   * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk, [2:5/trunk]
   * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3
   * Diffs (requires [milestone:0.10 0.10]): diff:@20:30, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539
   * Wiki pages: CamelCase or wiki:CamelCase
   * Parent page: '''[..]'''
   * Milestones: milestone:1.0
   * Attachment: attachment:ticket:944:attachment.1073.diff
   * Files: source:trunk/COPYING
   * A specific file revision: source:/trunk/COPYING@200
   * A particular line of a specific file revision: source:/trunk/COPYING@200#L25

  '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
  pages whose names do not follow WikiPageNames rules, i.e., single words,
  non-alphabetic characters, etc. See WikiPageNames for more about features specific
  to links to Wiki page names.

  Trac links using the full (non-shorthand) notation can also be given a custom
  link title like this:

  {{{
  [ticket:1 This is a link to ticket number one].
  }}}

  Display: [ticket:1 This is a link to ticket number one].

  If the title is omitted, only the id (the part after the colon) is displayed:

  {{{
  [ticket:1]
  }}}

  Display: [ticket:1]

  `wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''):

  {{{
  [SandBox the sandbox]
  }}}

  Display: [SandBox the sandbox]

  TracLinks are a very simple idea, but actually allow quite a complex network of information. In practice, it's very intuitive and simple to use, and we've found the "link trail" extremely helpful to better understand what's happening in a project or why a particular change was made.


  == Advanced use of TracLinks ==

  === Relative links ===

  To create a link to a specific anchor in a page, use '#':
  {{{
   [#Relativelinks relative links]
  }}}
  Displays:
    [#Relativelinks relative links]

  Hint: when you move your mouse over the title of a section, a '¶' character will be displayed. This is a link to that specific section and you can use this to copy the `#...` part inside a relative link to an anchor.

  To create a link to a SubWiki-page just use a '/':
  {{{
   WikiPage/SubWikiPage or ./SubWikiPage
  }}}

  To link from a SubWiki page to a parent, simply use a '..':
  {{{
    [..]
  }}}

  To link from a SubWiki page to a sibling page, use a '../':
  {{{
    [../Sibling see next sibling]
  }}}

  ''(Changed in 0.11)'' Note that in Trac 0.10, using e.g. `[../newticket]`  may have worked for linking to the /newticket top-level URL, but now in 0.11 it will stay in the wiki namespace and link to a sibling page. See [#Server-relativelinks] for the new syntax.

  === InterWiki links ===

  Other prefixes can be defined freely and made to point to resources in other Web applications. The definition of those prefixes as well as the URLs of the corresponding Web applications is defined in a special Wiki page, the InterMapTxt page. Note that while this could be used to create links to other Trac environments, there's a more specialized way to register other Trac environments which offers greater flexibility.

  === InterTrac links ===

  This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.

  Any type of Trac links could be written in one Trac environment and actually refer to resources present in another Trac environment, provided the Trac link is prefixed by the name of that other Trac environment followed by a colon. That other Trac environment must be registered, under its name or an alias. See InterTrac for details. 

  A distinctive advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links usually have a way to understand the InterTrac prefixes. For example, links to Trac tickets can be written #T234 (if T was set as an alias for Trac), links to Trac changesets can be written [trac 1508].

  === Server-relative links ===

  It is often useful to be able to link to objects in your project that
  have no built-in Trac linking mechanism, such as static resources, `newticket`,
  a shared `/register` page on the server, etc.

  To link to resources inside the project, use either an absolute path from the project root, 
  or a relative link from the URL of the current page (''Changed in 0.11''):

  {{{
  [/newticket Create a new ticket]
  [/ home]
  }}}

  Display: [../newticket newticket][[comment(FIXME that's the 0.10 syntax)]]  [/ home]

  To link to another location on the server (outside the project), use the '//location' link syntax (''Changed in 0.11''):

  {{{
  [//register Register Here]
  }}}

  Display: [//register Register Here]

  === Quoting space in TracLinks ===

  Immediately after a TracLinks prefix, targets containing space characters should
  be enclosed in a pair of quotes or double quotes.
  Examples:
   * !wiki:"The whitespace convention"
   * !attachment:'the file.txt' or
   * !attachment:"the file.txt" 
   * !attachment:"ticket:123:the file.txt" 

  === Escaping Links ===

  To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
  {{{
   !NoLinkHere.
   ![42] is not a link either.
  }}}

  Display:
   !NoLinkHere.
   ![42] is not a link either.


  === Parameterized Trac links ===

  The Trac links target Trac resources which have generally more than one way to be rendered, according to some extra parameters. For example, a Wiki page can accept a `version` or a `format` parameter, a report can make use of dynamic variables, etc.

  Any Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
   - `wiki:WikiStart?format=txt`
   - `ticket:1?version=1`
   - `[/newticket?component=module1 create a ticket for module1]`


  == TracLinks Reference ==
  The following sections describe the individual link types in detail, as well as several notes advanced usage of links.

  === attachment: links ===

  The link syntax for attachments is as follows:
   * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
   * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page
   * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753

  === query: links ===

  See TracQuery#UsingTracLinks and [#ticket:links].

  === search: links ===

  See TracSearch#SearchLinks 

  === ticket: links ===

  Besides the obvious `ticket:id` form, it is also possible to specify a list of tickets or even a range of tickets instead of the `id`. This generates a link to a custom query view containing this fixed set of tickets.

  Example: 
   - `ticket:5000-6000`
   - `ticket:1,150`

  ''(since Trac 0.11)''

  === timeline: links ===

  Links to the timeline can be created by specifying a date in the ISO:8601 format. The date can be optionally followed by a time specification. The time is interpreted as being UTC time, but alternatively you can specify your local time, followed by your timezone if you don't want to compute the UTC time.

  Examples:
   - `timeline:2008-01-29`
   - `timeline:2008-01-29T15:48`
   - `timeline:2008-01-29T16:48Z+01`

  ''(since Trac 0.11)''

  === wiki: links ===

  See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.

  === Version Control related links ===
  ==== source: links ====

  The default behavior for a source:/some/path link is to open the directory browser 
  if the path points to a directory and otherwise open the log view.

  It's also possible to link directly to a specific revision of a file like this:
   - `source:/some/file@123` - link to the file's revision 123
   - `source:/some/file@head` - link explicitly to the latest revision of the file

  If the revision is specified, one can even link to a specific line number:
   - `source:/some/file@123#L10`
   - `source:/tag/0.10@head#L10`

  Finally, one can also highlight an arbitrary set of lines:
   - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
  ''(since 0.11)''

  ==== export: links ====

  To force the download of a file in the repository, as opposed to displaying it in the browser, use the `export` link.  Several forms are available:
   * `export:/some/file` - get the HEAD revision of the specified file
   * `export:123:/some/file` - get revision 123 of the specified file
   * `export:/some/file@123` - get revision 123 of the specified file

  This can be very useful for displaying HTML documentation with correct stylesheets and images, in case that has been checked in the repository.

  If the path is to a directory in the repository instead of a specific file, the source browser will be used to display the directory (identical to the result of `source:/some/dir`.

  ==== log: links ====

  The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions from the specified path, but it can also support displaying an arbitrary set of revisions.
   - `log:/` - the latest revisions starting at the root of the repository
   - `log:/trunk/tools` - the latest revisions in `trunk/tools`
   - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
   - `log:@20788,20791:20795` - list revision 20788 and the 20791 to 20795 revision range
   - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from the 20791 to 20795 range which affect the given path

  There are short forms for revision ranges as well:
   - `[20788,20791:20795]`
   - `[20788,20791:20795/trunk/tools]`
   - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)

  Finally, note that in all of the above, a revision range can be written indifferently `x:y` or `x-y`.

  ----
  See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki
   


name: TracLogging
author: trac
ipnr: 127.0.0.1
text:
  = Trac Logging =
  [[TracGuideToc]]

  Trac supports logging of system messages using the standard [http://docs.python.org/lib/module-logging.html logging module] that comes with Python.

  Logging is configured in the `[logging]` section in [wiki:TracIni#logging-section trac.ini].

  == Supported Logging Methods ==

  The log method is set using the `log_type` option in [wiki:TracIni#logging-section trac.ini], which takes any of the following values:

   '''none'':: Suppress all log messages.
   '''file''':: Log messages to a file, specified with the `log_file` option in [wiki:TracIni#logging-section trac.ini]. 
   '''stderr''':: Output all log entries to console ([wiki:TracStandalone tracd] only).
   '''syslog''':: (UNIX) Send all log messages to the local syslogd via named pipe `/dev/log`. By default, syslog will write them to the file /var/log/messages.
   '''eventlog''':: (Windows) Use the system's NT Event Log for Trac logging.

  == Log Levels ==

  The verbosity level of logged messages can be set using the `log_level` option in [wiki:TracIni#logging-section trac.ini]. The log level defines the minimum level of urgency required for a message to be logged, and those levels are:

   '''CRITICAL''':: Log only the most critical (typically fatal) errors.
   '''ERROR''':: Log failures, bugs and errors. 
   '''WARN''':: Log warnings, non-interrupting events.
   '''INFO''':: Diagnostic information, log information about all processing.
   '''DEBUG''':: Trace messages, profiling, etc.

  == Log Format ==

  Starting with Trac 0.10.4 (see #2844), it is possible to set the output format for log entries. This can be done through the `log_format` option in [wiki:TracIni#logging-section trac.ini]. The format is a string which can contain any of the [http://docs.python.org/lib/node422.html Python logging Formatter variables]. Additonally, the following Trac-specific variables can be used:
   '''$(basename)s''':: The last path component of the current environment.
   '''$(path)s''':: The absolute path for the current environment.
   '''$(project)s''':: The originating project's name.

  Note that variables are identified using a dollar sign (`$(...)s`) instead of percent sign (`%(...)s`).

  The default format is:
  {{{
  log_format = Trac[$(module)s] $(levelname)s: $(message)s
  }}}

  In a multi-project environment where all logs are sent to the same place (e.g. `syslog`), it makes sense to add the project name. In this example we use `basename` since that can generally be used to identify a project:
  {{{
  log_format = Trac[$(basename)s:$(module)s] $(levelname)s: $(message)s
  }}}

  ----
  See also: TracIni, TracGuide, TracEnvironment


name: TracModPython
author: trac
ipnr: 127.0.0.1
text:
  = Trac and mod_python =
  [[TracGuideToc]]

  Trac supports [http://www.modpython.org/ mod_python], which speeds up Trac's response times considerably, especially compared to [TracCgi CGI], and permits use of many Apache features not possible with [wiki:TracStandalone tracd]/mod_proxy.

  These instructions are for Apache 2; if you are still using Apache 1.3, you may have some luck with [wiki:TracModPython2.7 TracModPython2.7].

  == Simple configuration ==

  If you just installed mod_python, you may have to add a line to load the module in the Apache configuration:
  {{{
  LoadModule python_module modules/mod_python.so
  }}}

   ''Note: The exact path to the module depends on how the HTTPD installation is laid out.''
  On Debian using apt-get
  {{{
  apt-get install libapache2-mod-python libapache2-mod-python-doc
  }}}
  (Still on Debian) after you have installed mod_python, you must enable the modules in apache2 (equivalent of the above Load Module directive):
  {{{
  a2enmod mod_python
  }}}
  On Fedora use, using yum:
  {{{
  yum install mod_python
  }}}
  You can test your mod_python installation by adding the following to your httpd.conf.  You should remove this when you are done testing for security reasons. Note: mod_python.testhandler is only available in mod_python 3.2+.
  {{{
  #!xml
  <Location /mpinfo>
     SetHandler mod_python
     PythonInterpreter main_interpreter
     PythonHandler mod_python.testhandler
  </Location>
  }}}

  A simple setup of Trac on mod_python looks like this:
  {{{
  #!xml
  <Location /projects/myproject>
     SetHandler mod_python
     PythonInterpreter main_interpreter
     PythonHandler trac.web.modpython_frontend 
     PythonOption TracEnv /var/trac/myproject
     PythonOption TracUriRoot /projects/myproject
  </Location>
  }}}

  The option '''`TracUriRoot`''' may or may not be necessary in your setup. Try your configuration without it; if the URLs produced by Trac look wrong, if Trac does not seem to recognize URLs correctly, or you get an odd "No handler matched request to..." error, add the '''`TracUriRoot`''' option.  You will notice that the `Location` and '''`TracUriRoot`''' have the same path.

  The options available are
  {{{
      # For a single project
      PythonOption TracEnv /var/trac/myproject
      # For multiple projects
      PythonOption TracEnvParentDir /var/trac/myprojects
      # For the index of multiple projects
      PythonOption TracEnvIndexTemplate /srv/www/htdocs/trac/project_list_tepmlate.html
      # A space delimitted list, with a "," between key and value pairs.
      PythonOption TracTemplateVars key1,val1 key2,val2
      # Useful to get the date in the wanted order
      PythonOption TracLocale en_GB.UTF8
      # See description above        
      PythonOption TracUriRoot /projects/myproject
      # Override default python egg cache location
      PythonOption PYTHON_EGG_CACHE /var/trac/myprojects/egg-cache
  }}}

  === Configuring Authentication ===

  Creating password files and configuring authentication works similar to the process for [wiki:TracCgi#AddingAuthentication CGI]:
  {{{
  #!xml
  <Location /projects/myproject/login>
    AuthType Basic
    AuthName "myproject"
    AuthUserFile /var/trac/myproject/.htpasswd
    Require valid-user
  </Location>
  }}}

  Configuration for mod_ldap authentication in Apache is a bit tricky (httpd 2.2.x and OpenLDAP: slapd 2.3.19)

  1. You need to load the following modules in Apache httpd.conf
  {{{
  LoadModule ldap_module modules/mod_ldap.so
  LoadModule authnz_ldap_module modules/mod_authnz_ldap.so
  }}}

  2. Your httpd.conf also needs to look something like:

  {{{
  #!xml
  <Location /trac/>
    SetHandler mod_python
    PythonInterpreter main_interpreter
    PythonHandler trac.web.modpython_frontend
    PythonOption TracEnv /home/trac/
    PythonOption TracUriRoot /trac/
    Order deny,allow
    Deny from all
    Allow from 192.168.11.0/24
    AuthType Basic
    AuthName "Trac"
    AuthBasicProvider "ldap"
    AuthLDAPURL "ldap://127.0.0.1/dc=example,dc=co,dc=ke?uid?sub?(objectClass=inetOrgPerson)"
    authzldapauthoritative Off
    require valid-user
  </Location>
  }}}

  Or the LDAP interface to a Microsoft Active Directory:

  {{{
  #!xml
  <Location /trac/>
    SetHandler mod_python
    PythonInterpreter main_interpreter
    PythonHandler trac.web.modpython_frontend
    PythonOption TracEnv /home/trac/
    PythonOption TracUriRoot /trac/
    Order deny,allow
    Deny from all
    Allow from 192.168.11.0/24
    AuthType Basic
    AuthName "Trac"
    AuthBasicProvider "ldap"
    AuthLDAPURL "ldap://adserver.company.com:3268/DC=company,DC=com?sAMAccountName?sub?(objectClass=user)"
    AuthLDAPBindDN       ldap-auth-user@company.com
    AuthLDAPBindPassword "the_password"
    authzldapauthoritative Off
    # require valid-user
    require ldap-group CN=Trac Users,CN=Users,DC=company,DC=com
  </Location>
  }}}

  Note 1: This is the case where the LDAP search will get around the multiple OUs, conecting to Global Catalog Server portion of AD (Notice the port is 3268, not the normal LDAP 389). The GCS is basically a "flattened" tree which allows searching for a user without knowing to which OU they belong.

  Note 2: Active Directory requires an authenticating user/password to access records (AuthLDAPBindDN and AuthLDAPBindPassword).

  Note 3: The directive "require ldap-group ..."  specifies an AD group whose members are allowed access.



  === Setting the !PythonPath ===

  If the Trac installation isn't installed in your Python path, you'll have to tell Apache where to find the Trac mod_python handler  using the `PythonPath` directive:
  {{{
  #!xml
  <Location /projects/myproject>
    ...
    PythonPath "sys.path + ['/path/to/trac']"
    ...
  </Location>
  }}}

  Be careful about using the !PythonPath directive, and ''not'' `SetEnv PYTHONPATH`, as the latter won't work.

  == Setting up multiple projects ==

  The Trac mod_python handler supports a configuration option similar to Subversion's `SvnParentPath`, called `TracEnvParentDir`:
  {{{
  #!xml
  <Location /projects>
    SetHandler mod_python
    PythonInterpreter main_interpreter
    PythonHandler trac.web.modpython_frontend 
    PythonOption TracEnvParentDir /var/trac
    PythonOption TracUriRoot /projects
  </Location>
  }}}

  When you request the `/projects` URL, you will get a listing of all subdirectories of the directory you set as `TracEnvParentDir` that look like Trac environment directories. Selecting any project in the list will bring you to the corresponding Trac environment.

  If you don't want to have the subdirectory listing as your projects home page you can use a
  {{{
  #!xml
  <LocationMatch "/.+/">
  }}}

  This will instruct Apache to use mod_python for all locations different from root while having the possibility of placing a custom home page for root in your !DocumentRoot folder.

  You can also use the same authentication realm for all of the projects using a `<LocationMatch>` directive:
  {{{
  #!xml
  <LocationMatch "/projects/[^/]+/login">
    AuthType Basic
    AuthName "Trac"
    AuthUserFile /var/trac/.htpasswd
    Require valid-user
  </LocationMatch>
  }}}

  == Virtual Host Configuration ==

  Below is the sample configuration required to set up your trac as a virtual server (i.e. when you access it at the URLs like
  !http://trac.mycompany.com):

  {{{
  #!xml
  <VirtualHost * >
      DocumentRoot /var/www/myproject
      ServerName trac.mycompany.com
      <Location />
          SetHandler mod_python
          PythonInterpreter main_interpreter
          PythonHandler trac.web.modpython_frontend
          PythonOption TracEnv /var/trac/myproject
          PythonOption TracUriRoot /
      </Location>
      <Location /login>
          AuthType Basic
          AuthName "MyCompany Trac Server"
          AuthUserFile /var/trac/myproject/.htpasswd
          Require valid-user
      </Location>
  </VirtualHost>
  }}}

  if you have issues with login try using `<LocationMatch>` instead of `<Location>`

  For a virtual host that supports multiple projects replace "`TracEnv`" /var/trac/myproject with "`TracEnvParentDir`" /var/trac/

  Note: !DocumentRoot should not point to your Trac project env. As Asmodai wrote on #trac: "suppose there's a webserer bug that allows disclosure of !DocumentRoot they could then leech the entire Trac environment".

  == Troubleshooting ==

  In general, if you get server error pages, you can either check the Apache error log, or enable the `PythonDebug` option:
  {{{
  #!xml
  <Location /projects/myproject>
    ...
    PythonDebug on
  </Location>
  }}}

  For multiple projects, try restarting the server as well.

  === Expat-related segmentation faults === #expat

  This problem will most certainly hit you on Unix when using Python 2.4.
  In Python 2.4, some version of Expat (an XML parser library written in C) is used, 
  and if Apache is using another version, this results in segmentation faults.
  As Trac 0.11 is using Genshi, which will indirectly use Expat, that problem
  can now hit you even if everything was working fine before with Trac 0.10.

  See Graham Dumpleton's detailed [http://www.dscpl.com.au/wiki/ModPython/Articles/ExpatCausingApacheCrash explanation and workarounds] for the issue.

  === Form submission problems ===

  If you're experiencing problems submitting some of the forms in Trac (a common problem is that you get redirected to the start page after submission), check whether your {{{DocumentRoot}}} contains a folder or file with the same path that you mapped the mod_python handler to. For some reason, mod_python gets confused when it is mapped to a location that also matches a static resource.

  === Problem with virtual host configuration ===

  If the <Location /> directive is used, setting the `DocumentRoot` may result in a ''403 (Forbidden)'' error. Either remove the `DocumentRoot` directive, or make sure that accessing the directory it points is allowed (in a corresponding `<Directory>` block).

  Using <Location /> together with `SetHandler` resulted in having everything handled by mod_python, which leads to not being able download any CSS or images/icons. I used <Location /trac> `SetHandler None` </Location> to circumvent the problem, though I do not know if this is the most elegant solution.

  === Using .htaccess ===

  Although it may seem trivial to rewrite the above configuration as a directory in your document root with a `.htaccess` file, this does not work. Apache will append a "/" to any Trac URLs, which interferes with its correct operation.

  It may be possible to work around this with mod_rewrite, but I failed to get this working. In all, it is more hassle than it is worth. Stick to the provided instructions. :)

  === Win32 Issues ===
  If you run trac with mod_python < 3.2 on Windows, uploading attachments will '''not''' work. This problem is resolved in mod_python 3.1.4 or later, so please upgrade mod_python to fix this.


  === OS X issues ===

  When using mod_python on OS X you will not be able to restart Apache using `apachectl restart`. This is apparently fixed in mod_python 3.2, but there's also a patch available for earlier versions [http://www.dscpl.com.au/projects/vampire/patches.html here].

  === SELinux issues ===

  If Trac reports something like: ''Cannot get shared lock on db.lock''
  The security context on the repository may need to be set:

  {{{
  chcon -R -h -t httpd_sys_content_t PATH_TO_REPOSITORY
  }}}

  See also [[http://subversion.tigris.org/faq.html#reposperms]]

  === FreeBSD issues ===
  Pay attention to the version of the installed mod_python and sqlite packages. Ports have both the new and old ones, but earlier versions of pysqlite and mod_python won't integrate as the former requires threaded support in python, and the latter requires a threadless install.

  If you compiled and installed apache2, apache wouldn´t support threads (cause it doesn´t work very well on FreeBSD). You could force thread support when running ./configure for apache, using --enable-threads, but this isn´t recommendable.
  The best option [[http://modpython.org/pipermail/mod_python/2006-September/021983.html seems to be]] adding to /usr/local/apache2/bin/ennvars the line 

  {{{
  export LD_PRELOAD=/usr/lib/libc_r.so
  }}}

  === Subversion issues ===

  If you get the following Trac Error `Unsupported version control system "svn"` only under mod_python, though it works well on the command-line and even with TracStandalone, chances are that you forgot to add the path to the Python bindings with the [TracModPython#ConfiguringPythonPath PythonPath] directive. (The better way is to add a link to the bindings in the Python `site-packages` directory, or create a `.pth` file in that directory.)

  If this is not the case, it's possible that you're using Subversion libraries that are binary incompatible with the apache ones (an incompatibility of the `apr` libraries is usually the cause). In that case, you also won't be able to use the svn modules for Apache (`mod_dav_svn`).

  You also need a recent version of `mod_python` in order to avoid a runtime error ({{{argument number 2: a 'apr_pool_t *' is expected}}}) due to the default usage of multiple sub-interpreters. 3.2.8 ''should'' work, though it's probably better to use the workaround described in #3371, in order to force the use of the main interpreter:
  {{{
  PythonInterpreter main_interpreter
  }}}
  This is anyway the recommended workaround for other well-known issues seen when using the Python bindings for Subversion within mod_python (#2611, #3455). See in particular Graham Dumpleton's comment in [comment:ticket:3455:9 #3455] explaining the issue.

  === Page layout issues ===

  If the formatting of the Trac pages look weird chances are that the style sheets governing the page layout are not handled properly by the web server. Try adding the following lines to your apache configuration:
  {{{
  #!xml
  Alias /myproject/css "/usr/share/trac/htdocs/css"
  <Location /myproject/css>
      SetHandler None
  </Location>
  }}}

  Note: For the above configuration to have any effect it must be put after the configuration of your project root location, i.e. {{{<Location /myproject />}}}.

  === HTTPS issues ===

  If you want to run Trac fully under https you might find that it tries to redirect to plain http. In this case just add the following line to your apache configuration:
  {{{
  #!xml
  <VirtualHost * >
      DocumentRoot /var/www/myproject
      ServerName trac.mycompany.com
      SetEnv HTTPS 1
      ....
  </VirtualHost>
  }}}

  === Fedora 7 Issues ===
  Make sure you install the 'python-sqlite2' package as it seems to be required for TracModPython but not for tracd


  === Segmentation fault with php5-mhash or other php5 modules ===
  You may encounter segfaults (reported on debian etch) if php5-mhash module is installed. Try to remove it to see if this solves the problem. See debian bug report [[http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=411487]]

  Some people also have troubles when using php5 compiled with its own 3rd party libraries instead of system libraries. Check here [[http://www.djangoproject.com/documentation/modpython/#if-you-get-a-segmentation-fault]]

  ----
  See also TracGuide, TracInstall, TracCgi, TracFastCgi


name: TracNavigation
author: trac
ipnr: 127.0.0.1
text:
  = Trac Navigation =

  Starting with Trac 0.11, it is now possible to customize the main and meta navigation entries in some basic ways.

  The new `[mainnav]` and `[metanav]` configuration sections can now be used to customize the text and link used for the navigation items, or even to disable them.

  `[mainnav]` corresponds to the '''main navigation bar''', the one containing entries such as ''Wiki'', ''Timeline'', ''Roadmap'', ''Browse Source'' and so on. This navigation bar is meant to access the default page of the main modules enabled in Trac and accessible for the current user.

  `[metanav]` corresponds to the '''meta navigation bar''', by default positioned above the main navigation bar and below the ''Search'' box. It contains the ''Log in'', ''Logout'', ''Help/Guide'' etc. entries. This navigation bar is meant to access some global information about the Trac project and the current user.

  Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.

  === Example ===

  In the following example, we rename the link to the Wiki start "Home", and hide the "Help/Guide" link. 
  We also make the "View Tickets" entry link to a specific report.

  Relevant excerpt from the TracIni:
  {{{
  [mainnav]
  wiki.label = Home
  tickets.href = /report/24

  [metanav]
  help = disabled
  }}}

  ----
  See also: TracInterfaceCustomization, the TracHacks:NavAddPlugin (still needed for adding entries)


name: TracNotification
author: trac
ipnr: 127.0.0.1
text:
  = Email Notification of Ticket Changes =
  [[TracGuideToc]]

  Trac supports notification about ticket changes via email. 

  Email notification is useful to keep users up-to-date on tickets/issues of interest, and also provides a convenient way to post all ticket changes to a dedicated mailing list. For example, this is how the [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] mailing list is set up.

  Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].

  == Receiving Notification Mails ==
  When reporting a new ticket or adding a comment, enter a valid email address in the ''reporter'', ''assigned to/owner'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket (depending on how notification is configured).

  This is useful to keep up-to-date on an issue or enhancement request that interests you.

  == Configuring SMTP Notification ==

  === Configuration Options ===
  These are the available options for the ''[notification]'' section in trac.ini.
   * '''smtp_enabled''': Enable email notification.
   * '''smtp_server''': SMTP server used for notification messages.
   * '''smtp_port''': (''since 0.9'') Port used to contact the SMTP server.
   * '''smtp_user''': (''since 0.9'') User name for authentication SMTP account.
   * '''smtp_password''': (''since 0.9'') Password for authentication SMTP account.
   * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails.
   * '''smtp_from_name''': Sender name to use for ''Sender''-headers in notification emails.
   * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails.
   * '''smtp_default_domain''': (''since 0.10'') Append the specified domain to addresses that do not contain one. Fully qualified addresses are not modified. The default domain is appended to all username/login for which an email address cannot be found from the user settings.
   * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
   * '''smtp_always_bcc''': (''since 0.10'') List of email addresses to always send notifications to, but keeps addresses not visible from other recipients of the notification email 
   * '''smtp_subject_prefix''': (''since 0.10.1'') Text that is inserted before the subject of the email. Set to "!__default!__" by default.
   * '''always_notify_reporter''':  Always send notifications to any address in the reporter field (default: false).
   * '''always_notify_owner''': (''since 0.9'') Always send notifications to the address in the owner field (default: false).
   * '''always_notify_updater''': (''since 0.10'') Always send a notification to the updater of a ticket (default: true).
   * '''use_public_cc''': (''since 0.10'') Addresses in To: (owner, reporter) and Cc: lists are visible by all recipients (default is ''Bcc:'' - hidden copy).
   * '''use_short_addr''': (''since 0.10'') Enable delivery of notifications to addresses that do not contain a domain (i.e. do not end with ''@<domain.com>'').This option is useful for intranets, where the SMTP server can handle local addresses and map the username/login to a local mailbox. See also `smtp_default_domain`. Do not use this option with a public SMTP server. 
   * '''use_tls''': (''since 0.10'') Toggle to send notifications via a SMTP server using [http://en.wikipedia.org/wiki/Transport_Layer_Security TLS], such as GMail.
   * '''mime_encoding''': (''since 0.10'') E-mail notifications are always sent in 7-bit mode. This option allows to select the MIME encoding scheme. Supported values:
     * `base64`: default value, works with any kind of content. May cause some issues with touchy anti-spam/anti-virus engines.
     * `qp` or `quoted-printable`: best for european languages (more compact than base64), not recommended for non-ASCII text (less compact than base64)
     * `none`: no encoding. Use with plain english only (ASCII). E-mails with non-ASCII chars won't be delivered. 

  Either '''smtp_from''' or '''smtp_replyto''' (or both) ''must'' be set, otherwise Trac refuses to send notification mails.

  === Example Configuration ===

  {{{
  [notification]
  smtp_enabled = true
  smtp_server = mail.example.com
  smtp_from = notifier@example.com
  smtp_replyto = myproj@projects.example.com
  smtp_always_cc = ticketmaster@example.com, theboss+myproj@example.com
  }}}

  == Sample Email ==
  {{{
  #42: testing
  ---------------------------+------------------------------------------------
         Id:  42             |      Status:  assigned                
  Component:  report system  |    Modified:  Fri Apr  9 00:04:31 2004
   Severity:  major          |   Milestone:  0.9                     
   Priority:  lowest         |     Version:  0.6                     
      Owner:  anonymous      |    Reporter:  jonas@example.com               
  ---------------------------+------------------------------------------------
  Changes:
    * component:  changset view => search system
    * priority:  low => highest
    * owner:  jonas => anonymous
    * cc:  daniel@example.com =>
           daniel@example.com, jonas@example.com
    * status:  new => assigned

  Comment:
  I'm interested too!

  --
  Ticket URL: <http://example.com/trac/ticket/42>
  My Project <http://myproj.example.com/>
  }}}

  == Using GMail as the SMTP relay host ==

  Use the following configuration snippet
  {{{
  [notification]
  smtp_enabled = true
  use_tls = true
  mime_encoding = base64
  smtp_server = smtp.gmail.com
  smtp_port = 587
  smtp_user = user
  smtp_password = password
  }}}

  where ''user'' and ''password'' match an existing GMail account, ''i.e.'' the ones you use to log in on [http://gmail.com]

  Alternatively, you can use `smtp_port = 25`.[[br]]
  You should not use `smtp_port = 465`. It will not work and your ticket submission may deadlock. Port 465 is reserved for the SMTPS protocol, which is not supported by Trac. See [comment:ticket:7107:2 #7107] for details.
   
  == Filtering notifications for one's own changes ==
  In Gmail, use the filter:

  {{{
  from:(<smtp_from>) (("Reporter: <username>" -Changes) OR "Changes (by <username>)")
  }}}

  to delete these notifications.

  == Troubleshooting ==

  If you cannot get the notification working, first make sure the log is activated and have a look at the log to find if an error message has been logged. See TracLogging for help about the log feature.

  Notification errors are not reported through the web interface, so the user who submit a change or a new ticket never gets notified about a notification failure. The Trac administrator needs to look at the log to find the error trace.

  === ''Permission denied'' error ===

  Typical error message:
  {{{
    ...
    File ".../smtplib.py", line 303, in connect
      raise socket.error, msg
    error: (13, 'Permission denied')
  }}}

  This error usually comes from a security settings on the server: many Linux distributions do not let the web server (Apache, ...) to post email message to the local SMTP server.

  Many users get confused when their manual attempts to contact the SMTP server succeed:
  {{{
  telnet localhost 25
  }}}
  The trouble is that a regular user may connect to the SMTP server, but the web server cannot:
  {{{
  sudo -u www-data telnet localhost 25
  }}}

  In such a case, you need to configure your server so that the web server is authorize to post to the SMTP server. The actual settings depend on your Linux distribution and current security policy. You may find help browsing the Trac MailingList archive.

  Relevant ML threads:
   * SELinux: http://article.gmane.org/gmane.comp.version-control.subversion.trac.general/7518
   
  === ''Suspected spam'' error ===

  Some SMTP servers may reject the notification email sent by Trac.

  The default Trac configuration uses Base64 encoding to send emails to the recipients. The whole body of the email is encoded, which sometimes trigger ''false positive'' SPAM detection on sensitive email servers. In such an event, it is recommended to change the default encoding to "quoted-printable" using the `mime_encoding` option.

  Quoted printable encoding works better with languages that use one of the Latin charsets. For Asian charsets, it is recommended to stick with the Base64 encoding.

  ----
  See also: TracTickets, TracIni, TracGuide


name: TracPermissions
author: trac
ipnr: 127.0.0.1
text:
  = Trac Permissions =
  [[TracGuideToc]]

  Trac uses a simple, case sensitive, permission system to control what users can and can't access.

  Permission privileges are managed using the [TracAdmin trac-admin] tool or the ''General / Permissions'' panel in the ''Admin'' web interface.

  In addition to the default permission policy described in this page, it is possible to activate additional permission policies by enabling plugins and listing them in the `[trac] permission_policies` configuration entry in the TracIni. See TracFineGrainedPermissions for more details.

  Non-authenticated users accessing the system are assigned the name "anonymous". Assign permissions to the "anonymous" user to set privileges for anonymous/guest users. The parts of Trac that a user does not have the privileges for will not be displayed in the navigation.
  In addition to these privileges, users can be granted additional individual rights in effect when authenticated and logged into the system. All logged in users belong to the virtual group "authenticated", which inherits permissions from "anonymous".

  == Available Privileges ==

  To enable all privileges for a user, use the `TRAC_ADMIN` permission. Having `TRAC_ADMIN` is like being `root` on a *NIX system: it will allow you to perform any operation.

  Otherwise, individual privileges can be assigned to users for the various different functional areas of Trac ('''note that the privilege names are case-sensitive'''):

  === Repository Browser ===

  || `BROWSER_VIEW` || View directory listings in the [wiki:TracBrowser repository browser] ||
  || `LOG_VIEW` || View revision logs of files and directories in the [wiki:TracBrowser repository browser] ||
  || `FILE_VIEW` || View files in the [wiki:TracBrowser repository browser] ||
  || `CHANGESET_VIEW` || View [wiki:TracChangeset repository check-ins] ||

  === Ticket System ===

  || `TICKET_VIEW` || View existing [wiki:TracTickets tickets] and perform [wiki:TracQuery ticket queries] ||
  || `TICKET_CREATE` || Create new [wiki:TracTickets tickets] ||
  || `TICKET_APPEND` || Add comments or attachments to [wiki:TracTickets tickets] ||
  || `TICKET_CHGPROP` || Modify [wiki:TracTickets ticket] properties (priority, assignment, keywords, etc.) except description field, cc field add/remove when logged in or set email to pref ||
  || `TICKET_MODIFY` || Includes both `TICKET_APPEND` and `TICKET_CHGPROP`, and in addition allows resolving [wiki:TracTickets tickets] ||
  || `TICKET_EDIT_CC` || Full modify cc field ||
  || `TICKET_EDIT_DESCRIPTION` || Modify description field ||
  || `TICKET_ADMIN` || All `TICKET_*` permissions, plus the deletion of ticket attachments and modification of the description field ||

  Attention: the "view tickets" button appears with the `REPORT_VIEW` permission.

  === Roadmap ===

  || `MILESTONE_VIEW` || View a milestone ||
  || `MILESTONE_CREATE` || Create a new milestone ||
  || `MILESTONE_MODIFY` || Modify existing milestones ||
  || `MILESTONE_DELETE` || Delete milestones ||
  || `MILESTONE_ADMIN` || All `MILESTONE_*` permissions ||
  || `ROADMAP_VIEW` || View the [wiki:TracRoadmap roadmap] page, is not (yet) the same as MILESTONE_VIEW, see #4292 ||
  || `ROADMAP_ADMIN` || to be removed with #3022, replaced by MILESTONE_ADMIN ||

  === Reports ===

  || `REPORT_VIEW` || View [wiki:TracReports reports], i.e. the "view tickets" link. ||
  || `REPORT_SQL_VIEW` || View the underlying SQL query of a [wiki:TracReports report] ||
  || `REPORT_CREATE` || Create new [wiki:TracReports reports] ||
  || `REPORT_MODIFY` || Modify existing [wiki:TracReports reports] ||
  || `REPORT_DELETE` || Delete [wiki:TracReports reports] ||
  || `REPORT_ADMIN` || All `REPORT_*` permissions ||

  === Wiki System ===

  || `WIKI_VIEW` || View existing [wiki:TracWiki wiki] pages ||
  || `WIKI_CREATE` || Create new [wiki:TracWiki wiki] pages ||
  || `WIKI_MODIFY` || Change [wiki:TracWiki wiki] pages ||
  || `WIKI_DELETE` || Delete [wiki:TracWiki wiki] pages and attachments ||
  || `WIKI_ADMIN` || All `WIKI_*` permissions, plus the management of ''readonly'' pages. ||

  === Permissions ===

  || `PERMISSION_GRANT` || add/grant a permission ||
  || `PERMISSION_REVOKE` || remove/revoke a permission ||
  || `PERMISSION_ADMIN` || All `PERMISSION_*` permissions ||


  === Others ===

  || `TIMELINE_VIEW` || View the [wiki:TracTimeline timeline] page ||
  || `SEARCH_VIEW` || View and execute [wiki:TracSearch search] queries ||
  || `CONFIG_VIEW` || Enables additional pages on ''About Trac'' that show the current configuration or the list of installed plugins ||
  || `EMAIL_VIEW` || Shows email addresses even if [wiki:0.11/TracIni `trac show_email_addresses` configuration option is `false`] ||

  == Granting Privileges ==

  You grant privileges to users using [wiki:TracAdmin trac-admin]. The current set of privileges can be listed with the following command:
  {{{
    $ trac-admin /path/to/projenv permission list
  }}}

  This command will allow the user ''bob'' to delete reports:
  {{{
    $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
  }}}

  The `permission add` command also accepts multiple privilege names:
  {{{
    $ trac-admin /path/to/projenv permission add bob REPORT_DELETE WIKI_CREATE
  }}}

  Or add all privileges:
  {{{
    $ trac-admin /path/to/projenv permission add bob TRAC_ADMIN
  }}}

  == Permission Groups ==

  There are two built-in groups, "authenticated" and "anonymous".[[BR]]
  Any user who has not logged in is automatically in the "anonymous" group.[[BR]]
  Any user who has logged in is also in the "authenticated" group.[[BR]]
  The "authenticated" group inherits permissions from the "anonymous" group.[[BR]]
  eg. if the "anonymous" group has permission WIKI_MODIFY, it's not necessary to add the WIKI_MODIFY permisison to the "authenticated" group as well.

  Custom groups may be defined that inherit permissions from the two built-in groups.

  Permissions can be grouped together to form roles such as ''developer'', ''admin'', etc.
  {{{
    $ trac-admin /path/to/projenv permission add developer WIKI_ADMIN
    $ trac-admin /path/to/projenv permission add developer REPORT_ADMIN
    $ trac-admin /path/to/projenv permission add developer TICKET_MODIFY
    $ trac-admin /path/to/projenv permission add bob developer
    $ trac-admin /path/to/projenv permission add john developer
  }}}

  Group membership can be checked by doing a {{{permission list}}} with no further arguments; the resulting output will include group memberships. '''Use lowercase for group names, as uppercase is reserved for permissions'''.

  == Adding a New Group and Permissions ==
  Permission groups can be created by assigning a user to a group you wish to create, then assign permissions to that group.

  The following will add ''bob'' to the new group called ''beta_testers'' and then will assign WIKI_ADMIN permissions to that group. (Thus, ''bob'' will inherit the WIKI_ADMIN permission)
  {{{ 
     $ trac-admin /path/to/projenv permission add bob beta_testers
     $ trac-admin /path/to/projenv permission add beta_testers WIKI_ADMIN

  }}}

  == Removing Permissions ==

  Permissions can be removed using the 'remove' command. For example:

  This command will prevent the user ''bob'' from deleting reports:
  {{{
    $ trac-admin /path/to/projenv permission remove bob REPORT_DELETE
  }}}

  Just like `permission add`, this command accepts multiple privilege names.

  You can also remove all privileges for a specific user:
  {{{
    $ trac-admin /path/to/projenv permission remove bob '*'
  }}}

  Or one privilege for all users:
  {{{
    $ trac-admin /path/to/projenv permission remove '*' REPORT_ADMIN
  }}}

  == Default Permissions ==

  By default on a new Trac installation, the `anonymous` user will have ''view'' access to everything in Trac, but will not be able to create or modify anything.
  On the other hand, the `authenticated` users will have the permissions to ''create and modify tickets and wiki pages''.

   '''anonymous'''::
   BROWSER_VIEW 
   CHANGESET_VIEW 
   FILE_VIEW 
   LOG_VIEW 
   MILESTONE_VIEW 
   REPORT_SQL_VIEW 
   REPORT_VIEW 
   ROADMAP_VIEW 
   SEARCH_VIEW 
   TICKET_VIEW 
   TIMELINE_VIEW
   WIKI_VIEW 

   '''authenticated'''::
   TICKET_CREATE 
   TICKET_MODIFY 
   WIKI_CREATE 
   WIKI_MODIFY  

  ----
  See also: TracAdmin, TracGuide and TracFineGrainedPermissions


name: TracPlugins
author: trac
ipnr: 127.0.0.1
text:
  = Trac Plugins =
  [[TracGuideToc]]

  Since version 0.9, Trac supports [PluginList plugins] that extend the built-in functionality. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture].

  == Requirements ==

  To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed.

  To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows:
  {{{
  $ python ez_setup.py
  }}}

  If the `ez_setup.py` script fails to install the setuptools release, you can download it from [http://www.python.org/pypi/setuptools PyPI] and install it manually.

  Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''. See TracIni#GlobalConfiguration .

  == Installing a Trac Plugin ==

  === For a Single Project ===

  Plugins are packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are ZIP archives with the file extension `.egg`. 

  If you have downloaded a source distribution of a plugin, and want to build the `.egg` file, follow this instruction:
   * Unpack the source. It should provide a setup.py. 
   * Run:
  {{{
  $ python setup.py bdist_egg
  }}}

  Then you will have a *.egg file. Examine the output of running python to find where this was created.

  Once you have the plugin archive, you need to copy it into the `plugins` directory of the [wiki:TracEnvironment project environment]. Also, make sure that the web server has sufficient permissions to read the plugin egg.

  To uninstall a plugin installed this way, remove the egg from `plugins` directory and restart web server.

  Note that the Python version that the egg is built with must
  match the Python version with which Trac is run.  If for
  instance you are running Trac under Python 2.3, but have
  upgraded your standalone Python to 2.4, the eggs won't be
  recognized.

  Note also that in a multi-project setup, a pool of Python interpreter instances will be dynamically allocated to projects based on need, and since plugins occupy a place in Python's module system, the first version of any given plugin to be loaded will be used for all the projects. In other words, you cannot use different versions of a single plugin in two projects of a multi-project setup. It may be safer to install plugins for all projects (see below) and then enable them selectively on a project-by-project basis.

  === For All Projects ===

  ==== With an .egg file ====

  Some plugins (such as [trac:SpamFilter SpamFilter]) are downloadable as a `.egg` file which can be installed with the `easy_install` program:
  {{{
  easy_install TracSpamFilter
  }}}

  If `easy_install` is not on your system see the Requirements section above to install it.  Windows users will need to add the `Scripts` directory of their Python installation (for example, `C:\Python23\Scripts`) to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information).

  If Trac reports permission errors after installing a zipped egg and you would rather not bother providing a egg cache directory writable by the web server, you can get around it by simply unzipping the egg. Just pass `--always-unzip` to `easy_install`:
  {{{
  easy_install --always-unzip TracSpamFilter-0.2.1dev_r5943-py2.4.egg
  }}}
  You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents.

  Trac also searches for globally installed plugins ''(since 0.10)'', see TracIni#GlobalConfiguration.

  ==== From source ====

  `easy_install` makes installing from source a snap. Just give it the URL to either a Subversion repository or a tarball/zip of the source:
  {{{
  easy_install http://svn.edgewall.com/repos/trac/sandbox/spam-filter
  }}}

  ==== Enabling the plugin ====
  Unlike plugins installed per-environment, you'll have to explicitly enable globally installed plugins via [wiki:TracIni trac.ini]. This is done in the `[components]` section of the configuration file, for example:
  {{{
  [components]
  tracspamfilter.* = enabled
  }}}

  The name of the option is the Python package of the plugin. This should be specified in the documentation of the plugin, but can also be easily discovered by looking at the source (look for a top-level directory that contains a file named `__init__.py`.)

  Note: After installing the plugin, you need to restart your web server.

  ==== Uninstalling ====

  `easy_install` or `python setup.py` does not have an uninstall feature. Hower, it is usually quite trivial to remove a globally installed egg and reference:
   1. Do `easy_install -m [plugin name]` to remove references from `$PYTHONLIB/site-packages/easy-install.pth` when the plugin installed by setuptools.
   1. Delete executables from `/usr/bin`, `/usr/local/bin` or `C:\\Python*\Scripts`. For search what executables are there, you may refer to `[console-script]` section of `setup.py`.
   1. Delete the .egg file or folder from where it is installed, usually inside `$PYTHONLIB/site-packages/`.
   1. Restart web server.

  If you are uncertain about the location of the egg, here is a small tip to help locate an egg (or any package) - replace `myplugin` with whatever namespace the plugin uses (as used when enabling the plugin):
  {{{
  >>> import myplugin
  >>> print myplugin.__file__
  /opt/local/python24/lib/site-packages/myplugin-0.4.2-py2.4.egg/myplugin/__init__.pyc
  }}}

  == Setting up the Plugin Cache ==

  Some plugins will need to be extracted by the Python eggs runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory in which they are extracted defaults to the home directory of the current user, which may or may not be a problem. You can however override the default location using the `PYTHON_EGG_CACHE` environment variable.

  To do this from the Apache configuration, use the `SetEnv` directive as follows:
  {{{
  SetEnv PYTHON_EGG_CACHE /path/to/dir
  }}}

  This works whether you are using the [wiki:TracCgi CGI] or the [wiki:TracModPython mod_python] front-end. Put this directive next to where you set the path to the [wiki:TracEnvironment Trac environment], i.e. in the same `<Location>` block.

  For example (for CGI):
  {{{
   <Location /trac>
     SetEnv TRAC_ENV /path/to/projenv
     SetEnv PYTHON_EGG_CACHE /path/to/dir
   </Location>
  }}}

  or (for mod_python):
  {{{
   <Location /trac>
     SetHandler mod_python
     ...
     SetEnv PYTHON_EGG_CACHE /path/to/dir
   </Location>
  }}}

   ''Note: this requires the `mod_env` module''

  For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables. 

   ''Note: that if you already use -initial-env to set the project directory for either a single project or parent you will need to add atleast one environment variable inside trac.fcgi as expressed in the example on [wiki:TracFastCgi TracFastCgi].

  === About hook scripts ===

  If you have set up some subversion hook scripts that call the Trac engine - such as the post-commit hook script provided in the `/contrib` directory - make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts as well.

  == Troubleshooting ==

  === Is setuptools properly installed? ===

  Try this from the command line:
  {{{
  $ python -c "import pkg_resources"
  }}}

  If you get '''no output''', setuptools '''is''' installed. Otherwise, you'll need to install it before plugins will work in Trac.

  === Did you get the correct version of the Python egg? ===

  Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.4.egg` is an egg for Python 2.4, and will '''not''' be loaded if you're running a different Python version (such as 2.3 or 2.5).

  Also, verify that the egg file you downloaded is indeed a ZIP archive. If you downloaded it from a Trac site, chances are you downloaded the HTML preview page instead.

  === Is the plugin enabled? ===

  If you install a plugin globally (i.e. ''not'' inside the `plugins` directory of the Trac project environment) you will have to explicitly enable it in [TracIni trac.ini]. Make sure that:
   * you actually added the necessary line(s) to the `[components]` section
   * the package/module names are correct
   * the value is “enabled", not e.g. “enable”

  === Check the permissions on the egg file ===

  Trac must be able to read the file. 

  === Check the log files ===

  Enable [wiki:TracLogging logging] and set the log level to `DEBUG`, then watch the log file for messages about loading plugins.

  === Verify you have proper permissions ===

  Some plugins require you have special permissions in order to use them. WebAdmin, for example, requires the user to have TRAC_ADMIN permissions for it to show up on the navigation bar.

  === Is the wrong version of the plugin loading? ===

  If you put your plugins inside plugins directories, and certainly if you have more than one project, you need to make sure that the correct version of the plugin is loading. Here are some basic rules:
   * Only one version of the plugin can be loaded for each running Trac server (ie. each Python process). The Python namespaces and module list will be shared, and it cannot handle duplicates. Whether a plugin is `enabled` or `disabled` makes no difference.
   * A globally installed plugin (typically `setup.py install`) will override any version in global or project plugins directories. A plugin from the global plugins directory will be located before any project plugins directory.
   * If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), then having two versions of a plugin in two different projects will give uncertain results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first found - basically from the project that receives the first request.
   * Having more than one version listed inside Python site-packages is fine (ie. installed with `setup.py install`) - setuptools will make sure you get the version installed most recently. However, don't store more than one version inside a global or project plugins directory - neither version number nor installed date will matter at all. There is no way to determine which one will be located first when Trac searches the directory for plugins.

  === If all of the above failed ===

  OK, so the logs don't mention plugins, the egg is readable, the python version is correct ''and'' the egg has been installed globally (and is enabled in the trac.ini) and it still doesn't work or give any error messages or any other indication as to why? Hop on the IrcChannel and ask away.

  ----
  See also TracGuide, [trac:PluginList plugin list], [trac:TracDev/ComponentArchitecture component architecture]


name: TracQuery
author: trac
ipnr: 127.0.0.1
text:
  = Trac Ticket Queries =
  [[TracGuideToc]]

  In addition to [wiki:TracReports reports], Trac provides support for ''custom ticket queries'', used to display lists of tickets meeting a specified set of criteria. 

  To configure and execute a custom query, switch to the ''View Tickets'' module from the navigation bar, and select the ''Custom Query'' link.

  == Filters ==
  When you first go to the query page the default filters will display all open tickets, or if you're logged in it will display open tickets assigned to you.  Current filters can be removed by clicking the button to the right with the minus sign on the label.  New filters are added from the pulldown list in the bottom-right corner of the filters box.  Filters with either a text box or a pulldown menu of options can be added multiple times to perform an ''or'' of the criteria.

  You can use the fields just below the filters box to group the results based on a field, or display the full description for each ticket.

  Once you've edited your filters click the ''Update'' button to refresh your results.

  == Navigating Tickets ==
  Clicking on one of the query results will take you to that ticket.  You can navigate through the results by clicking the ''Next Ticket'' or ''Previous Ticket'' links just below the main menu bar, or click the ''Back to Query'' link to return to the query page.  

  You can safely edit any of the tickets and continue to navigate through the results using the ''Next/Previous/Back to Query'' links after saving your results.  When you return to the query ''any tickets which was edited'' will be displayed with italicized text.  If one of the tickets was edited such that [[html(<span style="color: grey">it no longer matches the query criteria </span>)]] the text will also be greyed. Lastly, if '''a new ticket matching the query criteria has been created''', it will be shown in bold. 

  The query results can be refreshed and cleared of these status indicators by clicking the ''Update'' button again.

  == Saving Queries ==

  While Trac does not yet allow saving a named query and somehow making it available in a navigable list, you can save references to queries in Wiki content, as described below.

  === Using TracLinks ===

  You may want to save some queries so that you can come back to them later.  You can do this by making a link to the query from any Wiki page.
  {{{
  [query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]

  }}}

  Which is displayed as:
    [query:status=new|assigned|reopened&version=1.0 Active tickets against 1.0]

  This uses a very simple query language to specify the criteria (see [wiki:TracQuery#QueryLanguage Query Language]).

  Alternatively, you can copy the query string of a query and paste that into the Wiki link, including the leading `?` character:
  {{{
  [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]

  }}}

  Which is displayed as:
    [query:?status=new&status=assigned&status=reopened&group=owner Assigned tickets by owner]

  === Using the `[[TicketQuery]]` Macro ===

  The TicketQuery macro lets you display lists of tickets matching certain criteria anywhere you can use WikiFormatting.

  Example:
  {{{
  [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]
  }}}

  This is displayed as:
    [[TicketQuery(version=0.6|0.7&resolution=duplicate)]]

  Just like the [wiki:TracQuery#UsingTracLinks query: wiki links], the parameter of this macro expects a query string formatted according to the rules of the simple [wiki:TracQuery#QueryLanguage ticket query language].

  A more compact representation without the ticket summaries is also available:
  {{{
  [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

  }}}

  This is displayed as:
    [[TicketQuery(version=0.6|0.7&resolution=duplicate, compact)]]

  Finally if you wish to receive only the number of defects that match the query using the ``count`` parameter.

  {{{
  [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]

  }}}

  This is displayed as:
    [[TicketQuery(version=0.6|0.7&resolution=duplicate, count)]]


  === Query Language ===

  `query:` TracLinks and the `[[TicketQuery]]` macro both use a mini “query language” for specifying query filters. Basically, the filters are separated by ampersands (`&`). Each filter then consists of the ticket field name, an operator, and one or more values. More than one value are separated by a pipe (`|`), meaning that the filter matches any of the values.

  The available operators are:
  || '''=''' || the field content exactly matches the one of the values ||
  || '''~=''' || the field content contains one or more of the values ||
  || '''!^=''' || the field content starts with one of the values ||
  || '''$=''' || the field content ends with one of the values ||

  All of these operators can also be negated:
  || '''!=''' || the field content matches none of the values ||
  || '''!~=''' || the field content does not contain any of the values ||
  || '''!!^=''' || the field content does not start with any of the values ||
  || '''!$=''' || the field content does not end with any of the values ||

  ----
  See also: TracTickets, TracReports, TracGuide


name: TracReports
author: trac
ipnr: 127.0.0.1
text:
  = Trac Reports =
  [[TracGuideToc]]

  The Trac reports module provides a simple, yet powerful reporting facility
  to present information about tickets in the Trac database.

  Rather than have its own report definition format, TracReports relies on standard SQL
  `SELECT` statements for custom report definition. 

    '''Note:''' ''The report module is being phased out in its current form because it seriously limits the ability of the Trac team to make adjustments to the underlying database schema. We believe that the [wiki:TracQuery query module] is a good replacement that provides more flexibility and better usability. While there are certain reports that cannot yet be handled by the query module, we intend to further enhance it so that at some point the reports module can be completely removed. This also means that there will be no major enhancements to the report module anymore.''

    ''You can already completely replace the reports module by the query module simply by disabling the former in [wiki:TracIni trac.ini]:''
    {{{
    [components]
    trac.ticket.report.* = disabled
    }}}
    ''This will make the query module the default handler for the “View Tickets” navigation item. We encourage you to try this configuration and report back what kind of features of reports you are missing, if any.''

    '''''You will almost definitely need to restart your httpd at this point.'''''

  A report consists of these basic parts:
   * '''ID''' -- Unique (sequential) identifier 
   * '''Title'''  -- Descriptive title
   * '''Description'''  -- A brief description of the report, in WikiFormatting text.
   * '''Report Body''' -- List of results from report query, formatted according to the methods described below.
   * '''Footer''' -- Links to alternative download formats for this report.

  == Changing Sort Order ==
  Simple reports - ungrouped reports to be specific - can be changed to be sorted by any column simply by clicking the column header. 

  If a column header is a hyperlink (red), click the column you would like to sort by. Clicking the same header again reverses the order.

  == Changing Report Numbering ==
  There may be instances where you need to change the ID of the report, perhaps to organize the reports better. At present this requires changes to the trac database. The ''report'' table has the following schema (as of 0.10):
   * id integer PRIMARY KEY
   * author text
   * title text
   * query text
   * description text
  Changing the ID changes the shown order and number in the ''Available Reports'' list and the report's perma-link. This is done by running something like:
  {{{
  update report set id=5 where id=3;
  }}}
  Keep in mind that the integrity has to be maintained (i.e., ID has to be unique, and you don't want to exceed the max, since that's managed by SQLite someplace).

  == Navigating Tickets ==
  Clicking on one of the report results will take you to that ticket. You can navigate through the results by clicking the ''Next Ticket'' or ''Previous Ticket'' links just below the main menu bar, or click the ''Back to Report'' link to return to the report page.

  You can safely edit any of the tickets and continue to navigate through the results using the Next/Previous/Back to Report links after saving your results, but when you return to the report, there will be no hint about what has changed, as would happen if you were navigating a list of tickets obtained from a query (see TracQuery#NavigatingTickets). ''(since 0.11)''

  == Alternative Download Formats ==
  Aside from the default HTML view, reports can also be exported in a number of alternative formats.
  At the bottom of the report page, you will find a list of available data formats. Click the desired link to 
  download the alternative report format.

  === Comma-delimited - CSV (Comma Separated Values) ===
  Export the report as plain text, each row on its own line, columns separated by a single comma (',').
  '''Note:''' Carriage returns, line feeds, and commas are stripped from column data to preserve the CSV structure.

  === Tab-delimited ===
  Like above, but uses tabs (\t) instead of comma.

  === RSS - XML Content Syndication ===
  All reports support syndication using XML/RSS 2.0. To subscribe to an RSS feed, click the orange 'XML' icon at the bottom of the page. See TracRss for general information on RSS support in Trac.

  ----

  == Creating Custom Reports ==

  ''Creating a custom report requires a comfortable knowledge of SQL.''

  A report is basically a single named SQL query, executed and presented by
  Trac.  Reports can be viewed and created from a custom SQL expression directly
  in from the web interface.

  Typically, a report consists of a SELECT-expression from the 'ticket' table,
  using the available columns and sorting the way you want it.

  == Ticket columns ==
  The ''ticket'' table has the following columns:
   * id
   * type
   * time
   * changetime
   * component
   * severity  
   * priority 
   * owner
   * reporter
   * cc
   * version
   * milestone
   * status
   * resolution
   * summary
   * description
   * keywords

  See TracTickets for a detailed description of the column fields.

  '''all active tickets, sorted by priority and time'''

  '''Example:''' ''All active tickets, sorted by priority and time''
  {{{
  SELECT id AS ticket, status, severity, priority, owner, 
         time as created, summary FROM ticket 
    WHERE status IN ('new', 'assigned', 'reopened')
    ORDER BY priority, time
  }}}


  ----


  == Advanced Reports: Dynamic Variables ==
  For more flexible reports, Trac supports the use of ''dynamic variables'' in report SQL statements. 
  In short, dynamic variables are ''special'' strings that are replaced by custom data before query execution.

  === Using Variables in a Query ===
  The syntax for dynamic variables is simple, any upper case word beginning with '$' is considered a variable.

  Example:
  {{{
  SELECT id AS ticket,summary FROM ticket WHERE priority=$PRIORITY
  }}}

  To assign a value to $PRIORITY when viewing the report, you must define it as an argument in the report URL, leaving out the leading '$'.

  Example:
  {{{
   http://trac.edgewall.org/reports/14?PRIORITY=high
  }}}

  To use multiple variables, separate them with an '&'.

  Example:
  {{{
   http://trac.edgewall.org/reports/14?PRIORITY=high&SEVERITY=critical
  }}}


  === Special/Constant Variables ===
  There is one ''magic'' dynamic variable to allow practical reports, its value automatically set without having to change the URL. 

   * $USER -- Username of logged in user.

  Example (''List all tickets assigned to me''):
  {{{
  SELECT id AS ticket,summary FROM ticket WHERE owner=$USER
  }}}


  ----


  == Advanced Reports: Custom Formatting ==
  Trac is also capable of more advanced reports, including custom layouts,
  result grouping and user-defined CSS styles. To create such reports, we'll use
  specialized SQL statements to control the output of the Trac report engine.

  == Special Columns ==
  To format reports, TracReports looks for 'magic' column names in the query
  result. These 'magic' names are processed and affect the layout and style of the 
  final report.

  === Automatically formatted columns ===
   * '''ticket''' -- Ticket ID number. Becomes a hyperlink to that ticket. 
   * '''created, modified, date, time''' -- Format cell as a date and/or time.

   * '''description''' -- Ticket description field, parsed through the wiki engine.

  '''Example:'''
  {{{
  SELECT id as ticket, created, status, summary FROM ticket 
  }}}

  === Custom formatting columns ===
  Columns whose names begin and end with 2 underscores (Example: '''`__color__`''') are
  assumed to be ''formatting hints'', affecting the appearance of the row.
   
   * '''`__group__`''' -- Group results based on values in this column. Each group will have its own header and table.
   * '''`__color__`''' -- Should be a numeric value ranging from 1 to 5 to select a pre-defined row color. Typically used to color rows by issue priority.
  {{{
  #!html
  <div style="margin-left:7.5em">Defaults: 
  <span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fdc; border-color: #e88; color: #a22">Color 1</span>
  <span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #ffb; border-color: #eea; color: #880">Color 2</span>
  <span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #fbfbfb; border-color: #ddd; color: #444">Color 3</span>
  <span style="border: none; color: #333; background: transparent; font-size: 85%; background: #e7ffff; border-color: #cee; color: #099">Color 4</span>
  <span style="border: none; color: #333; background: transparent;  font-size: 85%; background: #e7eeff; border-color: #cde; color: #469">Color 5</span>
  </div>
  }}}
   * '''`__style__`''' -- A custom CSS style expression to use for the current row. 

  '''Example:''' ''List active tickets, grouped by milestone, colored by priority''
  {{{
  SELECT p.value AS __color__,
       t.milestone AS __group__,
       (CASE owner WHEN 'daniel' THEN 'font-weight: bold; background: red;' ELSE '' END) AS __style__,
         t.id AS ticket, summary
    FROM ticket t,enum p
    WHERE t.status IN ('new', 'assigned', 'reopened') 
      AND p.name=t.priority AND p.type='priority'
    ORDER BY t.milestone, p.value, t.severity, t.time
  }}}

  '''Note:''' A table join is used to match ''ticket'' priorities with their
  numeric representation from the ''enum'' table.

  === Changing layout of report rows ===
  By default, all columns on each row are display on a single row in the HTML
  report, possibly formatted according to the descriptions above. However, it's
  also possible to create multi-line report entries.

   * '''`column_`''' -- ''Break row after this''. By appending an underscore ('_') to the column name, the remaining columns will be be continued on a second line.

   * '''`_column_`''' -- ''Full row''. By adding an underscore ('_') both at the beginning and the end of a column name, the data will be shown on a separate row.

   * '''`_column`'''  --  ''Hide data''. Prepending an underscore ('_') to a column name instructs Trac to hide the contents from the HTML output. This is useful for information to be visible only if downloaded in other formats (like CSV or RSS/XML).

  '''Example:''' ''List active tickets, grouped by milestone, colored by priority, with  description and multi-line layout''

  {{{
  SELECT p.value AS __color__,
         t.milestone AS __group__,
         (CASE owner 
            WHEN 'daniel' THEN 'font-weight: bold; background: red;' 
            ELSE '' END) AS __style__,
         t.id AS ticket, summary AS summary_,             -- ## Break line here
         component,version, severity, milestone, status, owner,
         time AS created, changetime AS modified,         -- ## Dates are formatted
         description AS _description_,                    -- ## Uses a full row
         changetime AS _changetime, reporter AS _reporter -- ## Hidden from HTML output
    FROM ticket t,enum p
    WHERE t.status IN ('new', 'assigned', 'reopened') 
      AND p.name=t.priority AND p.type='priority'
    ORDER BY t.milestone, p.value, t.severity, t.time
  }}}

  === Reporting on custom fields ===

  If you have added custom fields to your tickets (a feature since v0.8, see TracTicketsCustomFields), you can write a SQL query to cover them. You'll need to make a join on the ticket_custom table, but this isn't especially easy.

  If you have tickets in the database ''before'' you declare the extra fields in trac.ini, there will be no associated data in the ticket_custom table. To get around this, use SQL's "LEFT OUTER JOIN" clauses. See TracIniReportCustomFieldSample for some examples.

  '''Note that you need to set up permissions in order to see the buttons for adding or editing reports.'''

  ----
  See also: TracTickets, TracQuery, TracGuide, [http://www.sqlite.org/lang_expr.html Query Language Understood by SQLite]


name: TracRevisionLog
author: trac
ipnr: 127.0.0.1
text:
  = Viewing Revision Logs =
  [[TracGuideToc]]

  When you browse the repository, it's always possible to query the 
  ''Revision Log'' view corresponding to the path you're currently seeing.
  This will display a list of the most recent changesets in which the 
  current path or any other path below it has been modified.

  == The Revision Log Form ==

  It's possible to set the revision at which the revision log should
  start, using the ''View log starting at'' field. An empty value
  or a value of ''head'' is taken to be the newest changeset. 

  It's also possible to specify the revision at which the log should
  stop, using the ''back to'' field. By default, it's left empty, 
  which means the revision log will stop as soon as 100 revisions have 
  been listed.

  Also, there are three modes of operation of the revision log.

  By default, the revision log ''stops on copy'', which means that 
  whenever an ''Add'', ''Copy'' or ''Rename'' operation is detected, 
  no older revision will be shown. That's very convenient when working
  with branches, as one only sees the history corresponding to what
  has been done on the branch.

  It's also possible to indicate that one wants to see what happened
  before a ''Copy'' or ''Rename'' change, by selecting the 
  ''Follow copies'' mode. This will cross all copies or renames changes.
  Each time the name of the path changes, there will be an additional
  indentation level. That way, the changes on the different paths
  are easily grouped together visually.

  It's even possible to go past an ''Add'' change, in order to see 
  if there has been a ''Delete'' change on that path, before 
  that ''Add''. This mode corresponds to the mode called 
  ''Show only adds, moves and deletes''. 
  While quite useful at times, be aware that this operation is quite 
  resource intensive.

  Finally, there's also a checkbox ''Show full log messages'',
  which controls whether the full content of the commit log message
  should be displayed for each change, or only a shortened version of it.

  == The Revision Log Information ==

  For each revision log entry, there are 7 columns shown:
   1. The first column contains a pair of radio buttons and should used 
      for selecting the ''old'' and the ''new'' revisions that will be 
      used for [wiki:TracRevisionLog#viewingtheactualchanges viewing the actual changes].
   2. A color code (similar to the one used for the [wiki:TracChangeset#ChangesetHeader changesets]) 
      indicating kind of change.
      Clicking on this column refreshes the revision log so that it restarts
      with this change.
   3. The '''Date''' at which the change was made.
   4. The '''Revision''' number, displayed as `@xyz`. 
      This is a link to the TracBrowser, using that revision as the base line.
   5. The '''Changeset''' number, displayed as `[xyz]`.
      This is a link to the TracChangeset view.
   6. The '''Author''' of the change.
   7. The '''Log Message''', which contains either a summary or the full commit 
      log message, depending on the value of the ''Show full log messages'' 
      checkbox in the form above.
      

  == Inspecting Changes Between Revisions ==

  The ''View changes...'' buttons (placed above and below the list
  of changes, on the left side) will show the set of differences
  corresponding to the aggregated changes starting from the ''old''
  revision (first radio-button) to the ''new'' revision (second
  radio-button), in the TracChangeset view.

  Note that the ''old'' revision doesn't need to be actually 
  ''older'' than the ''new'' revision: it simply gives a base
  for the diff. It's therefore entirely possible to easily 
  generate a ''reverse diff'', for reverting what has been done
  in the given range of revisions.

  Finally, if the two revisions are identical, the corresponding
  changeset will be shown (same effect as clicking on column 5).

  == Alternative Formats ==

  === The ChangeLog Text ===

  At the bottom of the page, there's a ''ChangeLog'' link
  that will show the range of revisions as currently shown,
  but as a simple text, matching the usual conventions for
  !ChangeLog files.

  === RSS Support ===

  The revision log also provides a RSS feed to monitor the changes.
  To subscribe to a RSS feed for a file or directory, open its
  revision log in the browser and click the orange 'XML' icon at the bottom
  of the page. For more information on RSS support in Trac, see TracRss.

  ----
  See also: TracBrowser, TracChangeset, TracGuide


name: TracRoadmap
author: trac
ipnr: 127.0.0.1
text:
  = The Trac Roadmap =
  [[TracGuideToc]]

  The roadmap provides a view on the [wiki:TracTickets ticket system] that helps planning and managing the future development of a project.

  == The Roadmap View ==

  Basically, the roadmap is just a list of future milestones. You can add a description to milestones (using WikiFormatting) describing main objectives, for example. In addition, tickets targeted for a milestone are aggregated, and the ratio between active and resolved tickets is displayed as a milestone progress bar.

  == The Milestone View ==

  It is possible to drill down into this simple statistic by viewing the individual milestone pages. By default, the active/resolved ratio will be grouped and displayed by component. You can also regroup the status by other criteria, such as ticket owner or severity. Ticket numbers are linked to [wiki:TracQuery custom queries] listing corresponding tickets.

  == Roadmap Administration ==

  It is possible to add, modify and remove milestones using either TracAdmin or the web interface. 

  '''Note:''' Milestone descriptions can currently only be edited from the web interface. With appropriate permissions, you'll see buttons for milestone management on the roadmap and milestone pages.

  == iCalendar Support ==

  The Roadmap supports the [http://www.ietf.org/rfc/rfc2445.txt iCalendar] format to keep track of planned milestones and related tickets from your favorite calendar software. Calendar applications supporting the iCalendar specification include [http://www.apple.com/ical/ Apple iCal] for Mac OS X and the cross-platform [http://www.mozilla.org/projects/calendar/ Mozilla Calendar], and [http://chandlerproject.org Chandler]. [http://kdepim.kde.org/components/korganizer.php Korganizer] (the calendar application of the [http://www.kde.org/ KDE] project) and [http://www.novell.com/de-de/products/desktop/features/evolution.html Evolution] also support iCalendar.

  To subscribe to the roadmap, copy the iCalendar link from the roadmap (found at the bottom of the page) and choose the "Subscribe to remote calendar" action (or similar) of your calendar application, and insert the URL just copied.

  '''Note:''' For tickets to be included in the calendar as tasks, you need to be logged in when copying the link. You will only see tickets assigned to yourself, and associated with a milestone.

  More information about iCalendar can be found at [http://en.wikipedia.org/wiki/ICalendar Wikipedia].
  ----
  See also: TracTickets, TracReports, TracQuery, TracGuide


name: TracRss
author: trac
ipnr: 127.0.0.1
text:
  = Using RSS with Trac =
  [[TracGuideToc]]

  Several of the Trac modules support content syndication using the RSS (Really Simple Syndication) XML format.
  Using the RSS subscription feature in Trac, you can easily monitor progress of the project, a set of issues or even changes to a single file.

  Trac supports RSS feeds in:

   * TracTimeline --  Use the RSS feed to '''subscribe to project events'''.[[br]]Monitor overall project progress in your favorite RSS reader.
   * TracTickets, TracReports, and TracQuery -- Allows syndication of report and ticket query results.[[br]]Be notified about important and relevant issue tickets.
   * TracBrowser and TracRevisionLog -- Syndication of file changes.[[br]]Stay up to date with changes to a specific file or directory.

  == How to access RSS data ==
  Anywhere in Trac where RSS is available, you should find a small orange '''XML''' icon, typically placed at the bottom of the page. Clicking the icon will access the RSS feed for that specific resource.

  '''Note:''' Different modules provide different data in their RSS feeds. Usually, the syndicated information corresponds to the current view. For example, if you click the RSS link on a report page, the feed will be based on that report. It might be explained by thinking of the RSS feeds as an ''alternate view of the data currently displayed''.

  == Links ==
   * http://blogs.law.harvard.edu/tech/rss -- RSS 2.0 Specification
   * http://www.mozilla.org/products/firefox/ -- Mozilla Firefox supports [http://www.mozilla.org/products/firefox/live-bookmarks.html live bookmarks] using RSS
   * http://sage.mozdev.org -- Sage RSS and Atom feed aggregator for Mozilla Firefox
   * http://pim.kde.org/users.php -- [http://kde.org KDE] RSS Reader for Linux/BSD/*n*x systems
   * http://www.rssreader.com/ -- Free and powerful RSS Reader for Windows
   * http://liferea.sourceforge.net/ -- Open source GTK2 RSS Reader for Linux
   * http://akregator.sourceforge.net/ -- Open source KDE RSS Reader (part of KDE-PIM)
   * http://www.sharpreader.net/ -- A free RSS Reader written in .NET for Windows
   * http://ranchero.com/netnewswire/ -- An excellent RSS reader for Mac OS X (has both free and pay versions)
   * http://www.utsire.com/shrook/ -- An RSS reader for Max OS X that supports https (even with self signed certificates) and authenticated feeds.
   * http://vienna-rss.sourceforge.net/ -- Open source Feed Reader for Mac OS X with smart folders support
   * http://www.wizzrss.com/Welcome.php -- WizzRSS Feed Reader for Firefox
  ----
  See also: TracGuide, TracTimeline, TracReports, TracBrowser


name: TracSearch
author: trac
ipnr: 127.0.0.1
text:
  = Using Search =

  Trac has a built-in search engine to allow finding occurrences of keywords and substrings in wiki pages, tickets and changeset descriptions.

  Using the Trac search facility is straightforward and its interface should be familiar to most users.

  Apart from the [search: Search module], you will also find a small search field above the navigation bar at all time. It provides convenient access to the search module from all pages.

  == "Quickjump" searches ==
  For quick access to various project resources, the quick-search field at the top of every page can be used to enter a [TracLinks wiki link], which will take you directly to the resource identified by that link.

  For example:

   * ![42] -- Opens change set 42
   * !#42 -- Opens ticket number 42
   * !{1} -- Opens report 1
   * /trunk -- Opens the browser for the `trunk` directory

  == Advanced ==

  === Disabling Quickjumps ===
  To disable the quickjump feature for a search keyword - for example when searching for occurences of the literal word !TracGuide - begin the query with an exclamation mark (!).

  === Search Links ===
  From the Wiki, it is possible to link to a specific search, using
  `search:` links:
   * `search:?q=crash` will search for the string "crash" 
   * `search:?q=trac+link&wiki=on` will search for "trac" and "link" 
     in wiki pages only

  ----
  See also: TracGuide, TracLinks, TracQuery


name: TracStandalone
author: trac
ipnr: 127.0.0.1
text:
  = Tracd =

  Tracd is a lightweight standalone Trac web server. In most cases it's easier to setup and runs faster than the [wiki:TracCgi CGI script].

  == Pros ==

   * Fewer dependencies: You don't need to install apache or any other web-server.
   * Fast: Should be almost as fast as the [wiki:TracModPython mod_python] version (and much faster than the [wiki:TracCgi CGI]).
   * Automatic reloading: For development, Tracd can be used in ''auto_reload'' mode, which will automatically restart the server whenever you make a change to the code (in Trac itself or in a plugin).

  == Cons ==

   * Fewer features: Tracd implements a very simple web-server and is not as configurable or as scalable as Apache HTTPD.
   * No native HTTPS support: [http://www.rickk.com/sslwrap/ sslwrap] can be used instead,
     or [http://trac.edgewall.org/wiki/STunnelTracd stunnel -- a tutorial on how to use stunnel with tracd] or Apache with mod_proxy.

  == Usage examples ==

  A single project on port 8080. (http://localhost:8080/)
  {{{
   $ tracd -p 8080 /path/to/project
  }}}
  Stricly speaking this will make your Trac accessible to everybody from your network rather than ''localhost only''. To truly limit it use ''--hostname'' option.
  {{{
   $ tracd --hostname=localhost -p 8080 /path/to/project
  }}}
  With more than one project. (http://localhost:8080/project1/ and http://localhost:8080/project2/)
  {{{
   $ tracd -p 8080 /path/to/project1 /path/to/project2
  }}}

  You can't have the last portion of the path identical between the projects since Trac uses that name to keep the URLs of the
  different projects unique. So if you use `/project1/path/to` and `/project2/path/to`, you will only see the second project.

  An alternative way to serve multiple projects is to specify a parent directory in which each subdirectory is a Trac project, using the `-e` option. The example above could be rewritten:
  {{{
   $ tracd -p 8080 -e /path/to
  }}}

  To exit the server on Windows, be sure to use {{{CTRL-BREAK}}} -- using {{{CTRL-C}}} will leave a Python process running in the background.


  == Using Authentication ==

  Using tracd with Apache .htpasswd files:

  To create a .htpasswd file using htpasswd:

  {{{
  sudo htpasswd -c /path/to/env/.htpasswd username
  }}}
  then for additional users:
  {{{
  sudo htpasswd /var/www/html/.htpasswd-users username2
  }}}
  then for starting the tracd:
  {{{
  tracd -p 8080 --basic-auth=environmentname,/fullpath/environmentname/.htpasswd,/fullpath/environmentname /fullpath/environmentname
  }}}


  Tracd provides support for both Basic and Digest authentication. The default is to use Digest; to use Basic authentication, replace `--auth` with `--basic-auth` in the examples below. (You must still specify a dialogic "realm", which can be an empty string by trailing the BASICAUTH with a comma.)

    ''Support for Basic authentication was added in version 0.9.''

  The general format for using authentication is:

  {{{
   $ tracd -p port --auth=base_project_dir,password_file_path,realm project_path
  }}}

  where:

   * '''base_project_dir''' is the base directory of the project; note: this doesn't refer to the project name, and it is case-sensitive even for windows environments
   * '''password_file_path''' path of the password file
   * '''realm''' realm
   * '''project_path''' path of the project

  Example:

  {{{
   $ tracd -p 8080 \
     --auth=project1,/path/to/users.htdigest,mycompany.com /path/to/project1
  }}}
  Of course, the digest file can be be shared so that it is used for more than one project:
  {{{
   $ tracd -p 8080 \
     --auth=project1,/path/to/users.htdigest,mycompany.com \
     --auth=project2,/path/to/users.htdigest,mycompany.com \
     /path/to/project1 /path/to/project2
  }}}

  Another way to share the digest file is to specify "*"
  for the project name:
  {{{
   $ tracd -p 8080 \
     --auth=*,/path/to/users.htdigest,mycompany.com \
     /path/to/project1 /path/to/project2
  }}}

  == How to set up an htdigest password file ==

  If you have Apache available, you can use the htdigest command to generate the password file. Type 'htdigest' to get some usage instructions, or read [http://httpd.apache.org/docs/2.0/programs/htdigest.html this page] from the Apache manual to get precise instructions.  You'll be prompted for a password to enter for each user that you create.  For the name of the password file, you can use whatever you like, but if you use something like `users.htdigest` it will remind you what the file contains. As a suggestion, put it in your <projectname>/conf folder along with the [TracIni trac.ini] file.

  Note that you can start tracd without the --auth argument, but if you click on the ''Login'' link you will get an error.

  == Generating Passwords Without Apache ==

  If you don't have Apache available, you can use this simple Python script to generate your passwords:

  {{{
  #!python
  from optparse import OptionParser
  import md5

  # build the options
  usage = "usage: %prog [options]"
  parser = OptionParser(usage=usage)
  parser.add_option("-u", "--username",action="store", dest="username", type = "string",
                    help="the username for whom to generate a password")
  parser.add_option("-p", "--password",action="store", dest="password", type = "string",
                    help="the password to use")
  (options, args) = parser.parse_args()

  # check options
  if (options.username is None) or (options.password is None):
     parser.error("You must supply both the username and password")
     
  # Generate the string to enter into the htdigest file
  realm = 'trac'
  kd = lambda x: md5.md5(':'.join(x)).hexdigest()
  print ':'.join((options.username, realm, kd([options.username, realm, options.password])))
  }}}

  Note: If you use the above script you must use the --auth option to tracd, not --basic-auth, and you must set the realm in the --auth value to 'trac' (without the quotes). Example usage (assuming you saved the script as trac-digest.py):

  {{{
  python trac-digest.py -u username -p password >> c:\digest.txt
  tracd --port 8000 --auth=proj_name,c:\digest.txt,trac c:\path\to\proj_name
  }}}

  Note: If you would like to use --basic-auth you need to use htpasswd tool from apache server to generate .htpasswd file. The remaining part is similar but make sure to use empty realm (i.e. coma after path). When using on Windows make sure to use -m option for it (did not tested it on *nix, so not sure if that is the case there).  If you do not have Apache, [trac:source:/tags/trac-0.11b2/contrib/htpasswd.py htpasswd.py] may help.  (Note that it requires a `crypt` or `fcrypt` module; see the source comments for details.)

  It is possible to use md5sum utility to generate digest-password file using such method:
  {{{
  echo -e "${user}:trac:${password}\c" | md5sum - >>to-file
  }}}
  and manually delete " -" from the end and add "${user}:trac:" to the start of line from 'to-file'. You can see attachment:trac-digest-corrected.sh for detail.

  == Tips ==

  === Serving static content ===

  If `tracd` is the only webserver used for the project, 
  it can also be used to distribute static content 
  (tarballs, Doxygen documentation, etc.)

  This static content should be put in the `$TRAC_ENV/htdocs` folder,
  and is accessed by URLs like `<project_URL>/chrome/site/...`.

  Example: given a `$TRAC_ENV/htdocs/software-0.1.tar.gz` file,
  the corresponding relative URL would be `/<project_name>/chrome/site/software-0.1.tar.gz`, 
  which in turn can be written using the relative link syntax
  in the Wiki: `[/<project_name>/chrome/site/software-0.1.tar.gz]` 

  The development version of Trac supports a new `htdocs:` TracLinks 
  syntax for the above. With this, the example link above can be written simply 
  `htdocs:software-0.1.tar.gz`. 

  === Using apache rewrite rules ===
  In some situations when you choose to use tracd behind apache, you might experience issues with redirects, like being redirected to URLs with the wrong host or protocol. In this case (and only in this case), setting the `[trac] use_base_url_for_redirect` to `true` can help, as this will force Trac to use the value of `[trac] base_url` for doing the redirects.

  === Serving a different base path than / ===
  Tracd supports serving projects with different base urls then /<project>. The parameter name to change this is
  {{{
  tracd --base-path=/some/path
  }}}

  ----
  See also: TracInstall, TracCgi, TracModPython, TracGuide


name: TracSupport
author: trac
ipnr: 127.0.0.1
text:
  = Trac Support =

  Like in most [http://www.opensource.org/ open source projects], "free" Trac support is available primarily through the community itself, mainly through the [http://trac.edgewall.org/wiki/MailingList mailing list] and the project wiki.

  There is also an [http://trac.edgewall.org/wiki/IrcChannel IRC channel], where people might be able to help out. Much of the 'live' development discussions also happen there.

  Before you start a new support query, make sure you've done the appropriate searching:
   * in the project's [http://trac.edgewall.org/wiki/TracFaq FAQ]
   * in past messages to the Trac [http://blog.gmane.org/gmane.comp.version-control.subversion.trac.general?set_user_css=http%3A%2F%2Fwww.edgewall.com%2Fcss%2Fgmane.css&do_set_user_css=t Mailing List]
   * in the Trac ticket system, using either a [http://trac.edgewall.org/search?q=&ticket=on&wiki=on full search] or a [http://trac.edgewall.org/query?summary=~&keywords=~" ticket query].

  Please '''don't''' create a ticket in this Trac for asking a support question about Trac. Only use it when you face a ''real'' and ''new'' bug in Trac, and do so only after having read the NewTicketGuidelines. The more a bug report or enhancement request complies with those guidelines, the higher the chances are that it will be fixed or implemented promptly!

  ----
  See also: [http://trac.edgewall.org/wiki/MailingList MailingList], TracTroubleshooting, [http://trac.edgewall.org/wiki/CommercialServices CommercialServices]


name: TracSyntaxColoring
author: trac
ipnr: 127.0.0.1
text:
  = Syntax Coloring of Source Code =
  Trac supports language-specific syntax highlighting of source code in [wiki:WikiFormatting wiki formatted] text and the [wiki:TracBrowser repository browser].

  To do this, Trac uses external libraries with support for a great number of programming languages.

  Currently Trac supports syntax coloring using one or more of the following packages:

   * [http://www.codento.com/people/mtr/genscript/ GNU Enscript] 
   * [http://silvercity.sourceforge.net/ SilverCity]
   * [http://pygments.pocoo.org/ Pygments] (but needs a plugin for 0.10, see [#AboutPygments below])

  To activate syntax coloring, simply install either one (or more) of these packages. No additional configuration is required, however to modify the colors, have a look at `trac/htdocs/css/code.css`.

  If you don't know why trac isnt detecting an installed library, try turning on Trac logging. It actually appears that Trac is broken with SilverCity 0.9.6. Either use the current 0.9.7 or the older 0.9.5 http://trac.edgewall.org/wiki/TracFaq#why-is-my-css-code-not-being-highlighted-even-though-i-have-silvercity-installed

  When in use, Trac will automatically prioritize !SilverCity highlighting over Enscript if possible, (see note below). 

  If neither package is available, Trac will display the data as plain text. 

  '''Note:''' Enscript supports a greater number of languages, however !SilverCity is generally faster since it is a library and isn't executed in an external process.

  === About SilverCity ===
  !SilverCity uses the lexer from [http://www.scintilla.org/ Scintilla]. Scintilla supports more languages than !SilverCity implements. If you want to add a language to !SilverCity supported by Scintilla, it's not very difficult. See [http://trac.edgewall.org/wiki/SilverCityAddLanguage SilverCityAddLanguage] for some information how.

  === About Pygments ===

  Starting with trac 0.11 [http://pygments.org/ pygments] will be the new default highlighter. It's a highlighting library implemented in pure python, very fast, easy to extend and [http://pygments.org/docs/ well documented]. While it does not support as many languages as Enscript or Scintilla the overall output quality is much better.

  To use pygments trac 0.11 you just have to install pygments 0.5.1 or higher. If you want to use it in trac 0.10 too you have to install the [http://trac-hacks.org/wiki/TracPygmentsPlugin TracPygmentsPlugin] from trac hacks. If you encounter any bugs, please file tickets regarding Pygments in [http://dev.pocoo.org/projects/pygments/ the pygments trac].

  It's very likely that the list below is outdated because the list of supported pygments lexers is growing weekly. Just have a look at the page of [http://pygments.org/docs/lexers/ supported lexers] on the pygments webpage.


  == Syntax Coloring Support ==

  || || !SilverCity || Enscript || Pygments ||
  || Ada      ||   || X || ||
  || Asm      ||   || X || ||
  || Apache Conf (htaccess)) || || || X ||
  || * ASP    || X || X || ||
  || * C      || X || X || X ||
  || * C#     ||   || X(2) || X ||
  || * C++    || X || X || X ||
  || * Java   || X(4)|| X || X ||
  || Awk      ||   || X || ||
  || Boo || || || X ||
  || CSS      || X ||   || X ||
  || Python Doctests || || || X ||
  || Diff     ||   || X || X ||
  || Eiffel   ||   || X || ||
  || Elisp    ||   || X || ||
  || Fortran  ||   || X(3) || ||
  || Haskell  ||   || X || X ||
  || Genshi || || || X ||
  || HTML     || X || X || X ||
  || IDL      ||   || X || ||
  || INI || || || X ||
  || Javascript || X || X || X ||
  || Lua || || || X ||
  || m4       ||   || X || ||
  || Makefile ||   || X || X ||
  || Mako || || || X ||
  || Matlab   ||   || X (5) || ||
  || Mygthy || || || X ||
  || Objective-C|| || X || ||
  || OCaml    ||   ||   || X ||
  || Pascal   ||   || X || X ||
  || * Perl   || X || X || X ||
  || * PHP    || X ||   || X ||
  || PSP      || X ||   || ||
  || Pyrex    ||   || X || ||
  || * Python || X || X || X ||
  || * Ruby   || X || X (1) || X ||
  || Scheme   ||   || X || X ||
  || Shell    ||   || X || X ||
  || Smarty || || || X ||
  || SQL      || X || X || X ||
  || Troff    ||   || X || X ||
  || TCL      ||   || X || ||
  || Tex      ||   || X || X ||
  || Verilog  || X(4) || X || ||
  || VHDL     ||   || X || ||
  || Visual Basic |||| X || X ||
  || VRML     ||   || X || ||
  || XML      || X ||  || X ||

  ''(*) Supported as inline code blocks in [wiki:WikiFormatting Wiki text] using WikiProcessors.''

  ''(1) Ruby highlighting is not included in the Enscript distribution.  Highlighting rules for Ruby can be obtained from: http://neugierig.org/software/ruby/

  ''(2) C# highlighting is not included in the Enscript distribution.  Highlighting rules for C# can be obtained from: http://wiki.hasno.info/index.php/Csharp.st

  ''(3) Fortran: as packaged, Enscript only supports the fixed source form. Highlighting rules for Fortran 90x/2003 can be obtained from: http://wiki.hasno.info/index.php/F90.st

  ''(4) since Silvercity 0.9.7 released on 2006-11-23

  ''(5) By default `.m` files are considered Objective-C files. In order to treat `.m` files as MATLAB files, add "text/x-matlab:m" to the "mime_map" setting in the [wiki:TracIni#mimeviewer-section "[mimeviewer] section of trac.ini"].

  == Extra Software ==
   * GNU Enscript -- http://directory.fsf.org/GNU/enscript.html
   * GNU Enscript for Windows -- http://gnuwin32.sourceforge.net/packages/enscript.htm
   * !SilverCity -- http://silvercity.sf.net/
   * Pygments -- http://pygments.org/

  ----
  See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser


name: TracTickets
author: trac
ipnr: 127.0.0.1
text:
  = The Trac Ticket System =
  [[TracGuideToc]]

  The Trac ticket database provides simple but effective tracking of issues and bugs within a project.

  As the central project management element of Trac, tickets are used for '''project tasks''', '''feature requests''', '''bug reports''' and '''software support issues'''. 

  As with the TracWiki, this subsystem has been designed with the goal of making user contribution and participation as simple as possible. It should be as easy as possible to report bugs, ask questions and suggest improvements.

  An issue is assigned to a person who must resolve it or reassign the ticket to someone else.
  All tickets can be edited, annotated, assigned, prioritized and discussed at any time.

  == Ticket Fields ==

  A  ticket contains the following information attributes:
   
   * '''Reporter''' - The author of the ticket.
   * '''Type''' - The nature of the ticket (for example, defect or enhancement request)

   * '''Component''' - The project module or subsystem this ticket concerns.
   * '''Version''' - Version of the project that this ticket pertains to.
   * '''Keywords''' - Keywords that a ticket is marked with.  Useful for searching and report generation.

   * '''Priority''' - The importance of this issue, ranging from ''trivial'' to ''blocker''.
   * '''Milestone''' - When this issue should be resolved at the latest.
   * '''Assigned to/Owner''' - Principal person responsible for handling the issue.
   * '''Cc''' - A comma-separated list of other users or E-Mail addresses to notify. ''Note that this does not imply responsiblity or any other policy.''
   
   * '''Resolution''' - Reason for why a ticket was closed. One of {{{fixed}}}, {{{invalid}}}, {{{wontfix}}}, {{{duplicate}}}, {{{worksforme}}}.
   * '''Status''' - What is the current status? One of {{{new}}}, {{{assigned}}}, {{{closed}}}, {{{reopened}}}.
   * '''Summary''' - A brief description summarizing the problem or issue.
   * '''Description''' - The body of the ticket. A good description should be specific, descriptive and to the point.

  '''Note:''' Versions of Trac prior to 0.9 did not have the ''type'' field, but instead provided a ''severity'' field and different default values for the ''priority'' field. This change was done to simplify the ticket model by removing the somewhat blurry distinction between ''priority'' and ''severity''. However, the old model is still available if you prefer it: just add/modify the default values of the ''priority'' and ''severity'', and optionally hide the ''type'' field by removing all the possible values through [wiki:TracAdmin trac-admin].

  '''Note:''' the [wiki:TicketTypes type], [wiki:TicketComponent component], version, priority and severity fields can be managed with [wiki:TracAdmin trac-admin] or with the WebAdmin plugin.

  '''Note:''' Description of the builtin ''priority'' values is available at [wiki:TicketTypes#Whyistheseverityfieldgone]

  == Changing and Commenting Tickets ==

  Once a ticket has been entered into Trac, you can at any time change the
  information by '''annotating''' the bug. This means changes and comments to
  the ticket are logged as a part of the ticket itself.

  When viewing a ticket, the history of changes will appear below the main ticket area.

  ''In the Trac project, we use ticket comments to discuss issues and tasks. This makes
  understanding the motivation behind a design- or implementation choice easier,
  when returning to it later.''

  '''Note:''' An important feature is being able to use TracLinks and
  WikiFormatting in ticket descriptions and comments. Use TracLinks to refer to
  other issues, changesets or files to make your ticket more specific and easier
  to understand.

  '''Note:''' See TracNotification for how to configure email notifications of ticket changes.

  '''Note:''' See TracWorkflow for information about the state transitions (ticket lifecycle), and how this workflow can be customized.

  == Default Values for Drop-Down Fields ==

  The option selected by default for the various drop-down fields can be set in [wiki:TracIni trac.ini], in the `[ticket]` section:

   * `default_component`: Name of the component selected by default
   * `default_milestone`: Name of the default milestone
   * `default_priority`: Default priority value
   * `default_severity`: Default severity value
   * `default_type`: Default ticket type
   * `default_version`: Name of the default version

  If any of these options are omitted, the default value will either be the first in the list, or an empty value, depending on whether the field in question is required to be set.


  == Hiding Fields and Adding Custom Fields ==

  Many of the default ticket fields can be hidden from the ticket web interface simply by removing all the possible values through [wiki:TracAdmin trac-admin]. This of course only applies to drop-down fields, such as ''type'', ''priority'', ''severity'', ''component'', ''version'' and ''milestone''.

  Trac also lets you add your own custom ticket fields. See TracTicketsCustomFields for more information.


  == Assign-to as Drop-Down List ==

  If the list of possible ticket owners is finite, you can change the ''assign-to'' ticket field from a text input to a drop-down list. This is done by setting the `restrict_owner` option of the `[ticket]` section in [wiki:TracIni trac.ini] to “true”. In that case, Trac will use the list of all users who have accessed the project to populate the drop-down field.

  To appear in the dropdown list, a user needs be registered with the project, ''i.e.'' a user session should exist in the database. Such an entry is automatically created in the database the first time the user submits a change in the project, for example when editing the user's details in the ''Settings'' page, or simply by authenticating if the user has a login. Also, the user must have `TICKET_MODIFY` [TracPermissions permissions].

  == Preset Values for New Tickets ==

  To create a link to the new-ticket form filled with preset values, you need to call the `/newticket?` URL with variable=value separated by &. 

  Possible variables are :

   * '''type''' - The type droplist
   * '''reporter''' - Name or email of the reporter
   * '''summary''' - Summary line for the ticket
   * '''description''' - Long description of the ticket
   * '''component''' - The component droplist
   * '''version''' - The version droplist
   * '''severity''' - The severity droplist
   * '''keywords''' - The keywords 
   * '''priority''' - The priority droplist
   * '''milestone''' - The milestone droplist
   * '''owner''' - The person responsible for the ticket
   * '''cc''' - The list of emails for notifying about the ticket change

  '''Example:''' ''/trac/newticket?summary=Compile%20Error&version=1.0&component=gui''[[BR]]

  ----
  See also:  TracGuide, TracWiki, TracTicketsCustomFields, TracNotification, TracReports, TracQuery


name: TracTicketsCustomFields
author: trac
ipnr: 127.0.0.1
text:
  = Custom Ticket Fields =
  Trac supports adding custom, user-defined fields to the ticket module. Using custom fields, you can add typed, site-specific properties to tickets.

  == Configuration ==
  Configuring custom ticket fields is done in the [wiki:TracIni trac.ini] file. All field definitions should be under a section named `[ticket-custom]`.

  The syntax of each field definition is:
  {{{
   FIELD_NAME = TYPE
   (FIELD_NAME.OPTION = VALUE)
   ...
  }}}
  The example below should help to explain the syntax.

  === Available Field Types and Options ===
   * '''text''': A simple (one line) text field.
     * label: Descriptive label.
     * value: Default value.
     * order: Sort order placement. (Determines relative placement in forms with respect to other custom fields.)
   * '''checkbox''': A boolean value check box.
     * label: Descriptive label.
     * value: Default value (0 or 1).
     * order: Sort order placement.
   * '''select''': Drop-down select box. Uses a list of values.
     * label: Descriptive label.
     * options: List of values, separated by '''|''' (vertical pipe).
     * value: Default value (one of the values from options).
     * order: Sort order placement.
   * '''radio''': Radio buttons. Essentially the same as '''select'''.
     * label: Descriptive label.
     * options: List of values, separated by '''|''' (vertical pipe).
     * value: Default value (one of the values from options).
     * order: Sort order placement.
   * '''textarea''': Multi-line text area.
     * label: Descriptive label.
     * value: Default text.
     * cols: Width in columns.
     * rows: Height in lines.
     * order: Sort order placement.

  === Sample Config ===
  {{{
  [ticket-custom]

  test_one = text
  test_one.label = Just a text box

  test_two = text
  test_two.label = Another text-box
  test_two.value = Just a default value

  test_three = checkbox
  test_three.label = Some checkbox
  test_three.value = 1

  test_four = select
  test_four.label = My selectbox
  test_four.options = one|two|third option|four
  test_four.value = two

  test_five = radio
  test_five.label = Radio buttons are fun
  test_five.options = uno|dos|tres|cuatro|cinco
  test_five.value = dos

  test_six = textarea
  test_six.label = This is a large textarea
  test_six.value = Default text
  test_six.cols = 60
  test_six.rows = 30
  }}}

  ''Note: To make entering an option for a `select` type field optional, specify a leading `|` in the `fieldname.options` option.''

  === Reports Involving Custom Fields ===

  Custom ticket fields are stored in the `ticket_custom` table, not in the `ticket` table. So to display the values from custom fields in a report, you will need a join on the 2 tables. Let's use an example with a custom ticket field called `progress`.

  {{{
  #!sql
  SELECT p.value AS __color__,
     id AS ticket, summary, owner, c.value AS progress
    FROM ticket t, enum p, ticket_custom c
    WHERE status IN ('assigned') AND t.id = c.ticket AND c.name = 'progress'
  AND p.name = t.priority AND p.type = 'priority'
    ORDER BY p.value
  }}}
  '''Note''' that this will only show tickets that have progress set in them, which is '''not the same as showing all tickets'''. If you created this custom ticket field ''after'' you have already created some tickets, they will not have that field defined, and thus they will never show up on this ticket query. If you go back and modify those tickets, the field will be defined, and they will appear in the query. If that's all you want, you're set.

  However, if you want to show all ticket entries (with progress defined and without), you need to use a `JOIN` for every custom field that is in the query.
  {{{
  #!sql
  SELECT p.value AS __color__,
     id AS ticket, summary, component, version, milestone, severity,
     (CASE status WHEN 'assigned' THEN owner||' *' ELSE owner END) AS owner,
     time AS created,
     changetime AS _changetime, description AS _description,
     reporter AS _reporter,
    (CASE WHEN c.value = '0' THEN 'None' ELSE c.value END) AS progress
    FROM ticket t
       LEFT OUTER JOIN ticket_custom c ON (t.id = c.ticket AND c.name = 'progress')
       JOIN enum p ON p.name = t.priority AND p.type='priority'
    WHERE status IN ('new', 'assigned', 'reopened')
    ORDER BY p.value, milestone, severity, time
  }}}

  Note in particular the `LEFT OUTER JOIN` statement here.

  === Updating the database ===

  As noted above, any tickets created before a custom field has been defined will not have a value for that field. Here's a bit of SQL (tested with SQLite) that you can run directly on the Trac database to set an initial value for custom ticket fields. Inserts the default value of 'None' into a custom field called 'request_source' for all tickets that have no existing value:

  {{{
  #!sql
  INSERT INTO ticket_custom
     (ticket, name, value)
     SELECT 
        id AS ticket,
        'request_source' AS name,
        'None' AS value
     FROM ticket 
     WHERE id NOT IN (
        SELECT ticket FROM ticket_custom
     );
  }}}

  If you added multiple custom fields at different points in time, you should be more specific in the subquery on table {{{ticket}}} by adding the exact custom field name to the query:

  {{{
  #!sql
  INSERT INTO ticket_custom
     (ticket, name, value)
     SELECT 
        id AS ticket,
        'request_source' AS name,
        'None' AS value
     FROM ticket 
     WHERE id NOT IN (
        SELECT ticket FROM ticket_custom WHERE name = 'request_source'
     );
  }}}

  ----
  See also: TracTickets, TracIni


name: TracTimeline
author: trac
ipnr: 127.0.0.1
text:
  = The Trac Timeline =
  [[TracGuideToc]]

  The timeline provides a historic view of the project in a single report.

  It lists all Trac events that have occurred in chronological order, a
  brief description of each event and if applicable, the person responsible for
  the change.

  The timeline lists these kinds of events:
   * '''Wiki page events''' -- Creation and changes
   * '''Ticket events''' -- Creation and resolution/closing (and optionally other changes)
   * '''Source code changes ''' -- Repository check-ins
   * '''Milestone ''' -- Milestone completed

  Each event entry provides a hyperlink to the specific event in question, as well as
  a brief excerpt of the actual comment or text, if available.

  See [wiki:TracIni#timeline TracIni] for timeline configuration options.

  == RSS Support ==

  The Timeline module supports subscription using RSS 2.0 syndication. To subscribe to project events, click the orange '''XML''' icon at the bottom of the page. See TracRss for more information on RSS support in Trac.

  ----
  See also: TracGuide, TracWiki, WikiFormatting, TracRss, TracNotification


name: TracUnicode
author: trac
ipnr: 127.0.0.1
text:
  = Unicode Support in Trac =
  [[TracGuideToc]]

  Trac stores all text using UTF-8 encoding, including text in tickets and wiki pages. Internal processing of text uses true Unicode representations.

  As such, it supports most (all?) commonly used character encodings.

  If your encoding is not UTF-8, you can use [wiki:TracModPython mod_python] to handle it.  For example, if your local encoding is gbk, you can set 
     default_charset = gbk
  in trac.ini.

  You also must make sure that your [wiki:DatabaseBackend database backend] stores its data in UTF-8; otherwise strange things will happen.

  To convert your database to UTF-8, the easiest way is to dump the database, convert the dump into UTF-8 and then import the converted dump back into the database.[[BR]]
  You can use [http://www.gnu.org/software/libiconv/documentation/libiconv/iconv.1.html iconv] to convert the dump.


  == Examples ==

  === Arabic ===
  تراك يقوم بحفظ كل الكلمات باستخدام صيغة UTF-8، بما في ذلك الكلمات المستخدمة في صفحات  التيكت والويكي.

  === Bulgarian ===
  Българският език работи ли?

  === Česky ===
  Čeština v kódování UTF-8, žádný problém.

  === Chinese ===
  Traditional: 繁體中文, 漢字測試; Simplified: 简体中文，汉字测试

  === Croatian ===
  Ako podržava srpski i slovenski mora podržavati i Hrvatski - čćžšđ ČĆŽŠĐ 

  === English ===
  Yes indeed, Trac supports English. Fully.

  === Français ===
  Il est possible d'écrire en Français : à, ç, û, ...

  === German ===
  Trac-Wiki muß auch deutsche Umlaute richtig anzeigen: ö, ä, ü, Ä, Ö, Ü; und das scharfe ß

  === Greek ===
  Τα Ελληνικά υποστηρίζονται επαρκώς επίσης.

  === Hebrew ===
  אני יכול לאכול זכוכית וזה לא מזיק לי

  === Hindi ===
  अब हिन्दी में।

  === Hungarian ===
  Árvíztűrő tükörfúrógép

  === Icelandic ===
  Ævar sagði við ömmu sína: Sjáðu hvað ég er stór!

  === Japanese ===
  漢字 ひらがな カタカナ ﾊﾝｶｸｶﾅ 日本語試験

  === Korean ===
  이번에는 한글로 써보겠습니다. 잘 보이나요? 한글

  === Latvian ===

  Latviešu valoda arī strādā!

  === Lithuanian ===
  Sudalyvaukime ir mes. Ar veikia lietuviškos raidės? ąčęėįšųūž ĄČĘĖĮŠŲŪŽ Žinoma, kad veikia :)
  Kas tie mes?

  === Persian (Farsi) ===
  این یک متن فارسی است ولی امکان نوشتن مستقیم فارسی نیست چون حالت متن از راست به چپ و جود ندارد برای فارسی نوشتن باید از HTML استفاده کنید.
  {{{
  #!html
  <div dir="rtl">
  }}}
  این نمونه یک متن از راست به چپ فارسی است که در HTML نوشته شده تا اعداد 12345 و حروف لاتین ABCDEF در محل خودشان نمایش داده شوند.
  {{{
  #!html
  </div>
  }}}

  === Polish ===
  Pchnąć w tę łódź jeża lub osiem skrzyń fig; Nocna gżegżółka zawsze dzienną przekuka.

  === Portuguese ===
  É possível guardar caracteres especias da língua portuguesa, incluindo o símbolo da moeda européia '€', trema 'ü', crase 'à', agudos 'áéíóú', circunflexos 'âêô', til 'ãõ', cedilha 'ç', ordinais 'ªº', grau '°¹²³'.

  === Russian ===
  Проверка русского языка: кажется работает... И буква "ё" есть...

  === Serbian ===
  Podržan, uprkos činjenici da se za njegovo pisanje koriste чак два алфабета.

  === Slovenian ===
  Ta suhi škafec pušča vodo že od nekdaj!

  === Spanish ===
  Esto es un pequeño texto en Español, donde el veloz murciélago hindú comía cardlllo y kiwi

  === Swedish ===
  Räven raskar över isen med luva på.

  === Thai ===
  Trac แสดงภาษาไทยได้อย่างถูกต้อง!

  === Ukrainian ===
  Перевірка української мови...

  === Urdu ===
  ٹریک اردو بھی سپورٹ کرتا ہے۔

  === Vietnamese ===
  Viết tiếng Việt cũng được. Nhưng search từ tiếng Việt thì không bôi vàng được. (Keyword(s) in Vietnamese search result can not be hightlighted !!!!).


name: TracUpgrade
author: trac
ipnr: 127.0.0.1
text:
  = Upgrade Instructions =
  [[TracGuideToc]]

  A [TracEnvironment Trac environment] needs to be upgraded before it can be used with Trac 0.11. This document describes the steps necessary to upgrade an environment.

  Environment upgrades are not necessary for minor version releases unless otherwise noted. 

  == Instructions ==

  Typically, there are four steps involved in upgrading to a newer version of Trac:

  === Update the Trac Code ===

  Get the new version as described in TracInstall, or your operating system specific procedure.

  If you do a manual (not operating system specific) upgrade, you may also later on want to remove the existing Trac code by deleting the `trac` directory from the Python `lib/site-packages` directory.

  The location of the site-packages directory depends on the operating system, and the location in which Python was installed. However, the following locations are common:
   * If you’re using Linux: /usr/lib/python2.X/site-packages
   * If you’re using Windows: C:\Python2.X\lib\site-packages
   * If you’re using MacOSX: /Library/Python2.X/site-packages

  You may also want to remove the Trac `cgi-bin`, `htdocs`, `templates` and `wiki-default` directories that are commonly found in a directory called `share/trac` (the exact location depends on your platform).

  If you had the webadmin plugin installed, you can now uninstall it as it is now part of the Trac code base.

  === Upgrade the Trac Environment ===

  After restarting, Trac should show the instances which need a manual upgrade via the automated upgrade scripts to ease the pain. These scripts are run via [TracAdmin trac-admin]:
  {{{
  trac-admin /path/to/projenv upgrade
  }}}

  This command will do nothing if the environment is already up-to-date.

  Note that if you are using a PostgreSQL database, this command will fail with the message that the environment can only be backed up when you use an SQLite database. This means that you will have to backup the repository and the database manually. Then, to perform the actual upgrade, run:
  {{{
  trac-admin /path/to/projenv upgrade --no-backup
  }}}

  If you are using custom CSS styles or modified templates in the templates directory of the TracEnvironment, you will need to convert them to the Genshi way of doing things. To continue to use your style sheet, follow the instructions at TracInterfaceCustomization#SiteAppearance.

  === Update the Trac Documentation ===

  Every [TracEnvironment Trac environment] includes a copy of the Trac documentation for the installed version. As you probably want to keep the included documentation in sync with the installed version of Trac, [TracAdmin trac-admin] provides a command to upgrade the documentation:
  {{{
  trac-admin /path/to/projenv wiki upgrade
  }}}

  Note that this procedure will of course leave your `WikiStart` page intact.

  === Trac Macros, Plugins ===
  The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore (due to the drop of ClearSilver and the HDF); they need to be converted to the new-style macros, see WikiMacros. When they are converted to the new style, they need to be placed into the plugins directory instead and not wiki-macros, which is no longer scanned for macros or plugins.

  === Restart the Web Server ===
  If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server.

  == Known Issues ==
  === parent dir ===
  If you use a trac parent env configuration and one of the plugins in one child does not work, none of the children work.
  === some core modules won't load === 
  This can happen in particular with Python 2.3 on Windows when upgrading without uninstalling first.
  Some modules were previously capitalized and were changed to lower case, e.g. trac/About.py became trac/about.py. You may find such messages in the Trac log:
  {{{
  ERROR: Skipping "trac.about = trac.about": (can't import "No module named about")
  }}}
  Remove the `Lib/site-packages/trac` folder and reinstall.
  === Wiki Upgrade ===
  `trac-admin` will not delete or remove pages that were in version 0.10 but now are not in version 0.11, such as WikiMacros.

  == Changing Database Backend ==
  == SQLite to PostgreSQL ==

  The [http://trac-hacks.org/wiki/SqliteToPgScript sqlite2pg] script on [http://trac-hacks.org trac-hacks.org] has been written to assist in migrating a SQLite database to a PostgreSQL database

  == Older Versions ==

  For upgrades from former versions refer to wiki:0.10/TracUpgrade.

  -----
  See also: TracGuide, TracInstall


name: TracWiki
author: trac
ipnr: 127.0.0.1
text:
  = The Trac Wiki Engine =
  [[TracGuideToc]]

  Trac has a built-in wiki engine, used for text and documentation throughout the system. WikiFormatting is used in [wiki:TitleIndex wiki pages], [wiki:TracTickets tickets] and [wiki:TracChangeset check-in log messages].  This allows for formatted text and hyperlinks in and between all Trac modules.

  Editing wiki text is easy, using any web browser and a simple [WikiFormatting formatting system], rather than more complex markup languages like HTML.  The reasoning behind its design is that HTML, with its large collection of nestable tags, is too complicated to allow fast-paced editing, and distracts from the actual content of the pages. Note though that Trac also supports [wiki:WikiHtml HTML], [wiki:WikiRestructuredText reStructuredText] and [http://www.textism.com/tools/textile/ Textile] as alternative markup formats.

  The main goal of the wiki is to make editing text easier and ''encourage'' people to contribute and annotate text content for a project.

  The wiki itself does not enforce any structure, but rather resembles a stack of empty sheets of paper, where you can organize information and documentation as you see fit, and later reorganize if necessary.

  For more help on editing wiki text, see these pages:
   * WikiFormatting
   * WikiPageNames
   * WikiNewPage
   * TracLinks
   * WikiMacros
   * WikiProcessors
   * PageTemplates

  If you want to practice editing, please use the SandBox.

  Some more information about wiki on the web:
   * http://wikipedia.org/wiki/Wiki
   * http://c2.com/cgi/wiki?WikiHistory
   * http://www.usemod.com/cgi-bin/mb.pl?WhyWikiWorks

  ----
  See also: TracGuide


name: TracWorkflow
author: trac
ipnr: 127.0.0.1
text:
  = The Trac Ticket Workflow System =
  [[TracGuideToc]]

  The Trac issue database provides a configurable workflow.

  == The Default Ticket Workflow ==
  === Environments upgraded from 0.10 ===
  When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section.
  The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10.

  Graphically, that looks like this:

  [[Image(htdocs:../common/guide/original-workflow.png)]]

  There are some significant "warts" in this; such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state.  Perfectly obvious, right?
  So you will probably want to migrate to "basic" workflow; `contrib/workflow/migrate_original_to_basic.py` may be helpful.

  === Environments created with 0.11 ===
  When a new environment is created, a default workflow is configured in your trac.ini.  This workflow is the basic workflow (described in `basic-workflow.ini`), which is somewhat different from the workflow of the 0.10 releases.

  Graphically, it looks like this:

  [[Image(htdocs:../common/guide/basic-workflow.png)]]

  == Additional Ticket Workflows ==

  There are several example workflows provided in the Trac source tree; look in `contrib/workflow` for `.ini` config sections.  One of those may be a good match for what you want. They can be pasted into the `[ticket-workflow]` section of your `trac.ini` file.

  == Basic Ticket Workflow Customization ==

  Create a `[ticket-workflow]` section in `trac.ini`.
  Within this section, each entry is an action that may be taken on a ticket. 
  For example, consider the `accept` action from `simple-workflow.ini`:
  {{{
  accept = new,accepted -> accepted
  accept.permissions = TICKET_MODIFY
  accept.operations = set_owner_to_self
  }}}
  The first line in this example defines the `accept` action, along with the states the action is valid in (`new` and `accepted`), and the new state of the ticket when the action is taken (`accepted`).
  The `accept.permissions` line specifies what permissions the user must have to use this action.
  The `accept.operations` line specifies changes that will be made to the ticket in addition to the status change when this action is taken.  In this case, when a user clicks on `accept`, the ticket owner field is updated to the logged in user.  Multiple operations may be specified in a comma separated list.

  The available operations are:
   - del_owner -- Clear the owner field.
   - set_owner -- Sets the owner to the selected or entered owner.
     - ''actionname''`.set_owner` may optionally be set to a comma delimited list or a single value.
   - set_owner_to_self -- Sets the owner to the logged in user.
   - del_resolution -- Clears the resolution field
   - set_resolution -- Sets the resolution to the selected value.
     - ''actionname''`.set_resolution` may optionally be set to a comma delimited list or a single value.
  {{{
  Example:

  resolve_new = new -> closed
  resolve_new.name = resolve
  resolve_new.operations = set_resolution
  resolve_new.permissions = TICKET_MODIFY
  resolve_new.set_resolution = invalid,wontfix
  }}}
   - leave_status -- Displays "leave as <current status>" and makes no change to the ticket.
  '''Note:''' Specifying conflicting operations (such as `set_owner` and `del_owner`) has unspecified results.

  {{{
  resolve_accepted = accepted -> closed
  resolve_accepted.name = resolve
  resolve_accepted.permissions = TICKET_MODIFY
  resolve_accepted.operations = set_resolution
  }}}

  In this example, we see the `.name` attribute used.  The action here is `resolve_accepted`, but it will be presented to the user as `resolve`.

  For actions that should be available in all states, `*` may be used in place of the state.  The obvious example is the `leave` action:
  {{{
  leave = * -> *
  leave.operations = leave_status
  leave.default = 1
  }}}
  This also shows the use of the `.default` attribute.  This value is expected to be an integer, and the order in which the actions are displayed is determined by this value.  The action with the highest `.default` value is listed first, and is selected by default.  The rest of the actions are listed in order of decreasing `.default` values.
  If not specified for an action, `.default` is 0.  The value may be negative.

  There are a couple of hard-coded constraints to the workflow.  In particular, tickets are created with status `new`, and tickets are expected to have a `closed` state.  Further, the default reports/queries treat any state other than `closed` as an open state.

  While creating or modifying a ticket workfow, `contrib/workflow/workflow_parser.py` may be useful.  It can create `.dot` files that [http://www.graphviz.org GraphViz] understands to provide a visual description of the workflow.

  This can be done as follows (your install path may be different).
  {{{
  cd /var/local/trac_devel/contrib/workflow/
  sudo ./showworkflow /srv/trac/PlannerSuite/conf/trac.ini
  }}}
  And then open up the resulting `trac.pdf` file created by the script (it will be in the same directory as the `trac.ini` file).

  After you have changed a workflow, you need to restart apache for the changes to take effect. This is important, because the changes will still show up when you run your script, but all the old workflow steps will still be there until the server is restarted.

  == Example: Adding optional Testing with Workflow ==

  By adding the following to your [ticket-workflow] section of trac.ini you get optional testing.  When the ticket is in new, accepted or needs_work status you can choose to submit it for testing.  When it's in the testing status the user gets the option to reject it and send it back to needs_work, or pass the testing and send it along to closed.  If they accept it then it gets automatically marked as closed and the resolution is set to fixed.  Since all the old work flow remains, a ticket can skip this entire section.

  {{{
  testing = new,accepted,needs_work -> testing
  testing.name = Submit to reporter for testing
  testing.permissions = TICKET_MODIFY

  reject = testing -> needs_work
  reject.name = Failed testing, return to developer

  pass = testing -> closed
  pass.name = Passes Testing
  pass.operations = set_resolution
  pass.set_resolution = fixed
  }}}

  == Example: Limit the resolution options for a new ticket ==

  The above resolve_new operation allows you to set the possible resolutions for a new ticket.  By modifying the existing resolve action and removing the new status from before the `->` we then get two resolve actions.  One with limited resolutions for new tickets, and then the regular one once a ticket is accepted.

  {{{
  resolve_new = new -> closed
  resolve_new.name = resolve
  resolve_new.operations = set_resolution
  resolve_new.permissions = TICKET_MODIFY
  resolve_new.set_resolution = invalid,wontfix,duplicate

  resolve = assigned,accepted,reopened -> closed
  resolve.operations = set_resolution
  resolve.permissions = TICKET_MODIFY
  }}}

  == Advanced Ticket Workflow Customization ==

  If the customization above is not extensive enough for your needs, you can extend the workflow using plugins.  These plugins can provide additional operations for the workflow (like code_review), or implement side-effects for an action (such as triggering a build) that may not be merely simple state changes.  Look at [trac:source:trunk/sample-plugins/workflow sample-plugins/workflow] for a few simple examples to get started.

  But if even that is not enough, you can disable the !ConfigurableTicketWorkflow component and create a plugin that completely replaces it.

  == some ideas for next steps ==

  New enhancement ideas for the workflow system should be filed as enhancement tickets against the `ticket system` component.  If desired, add a single-line link to that ticket here.

  If you have a response to the comments below, create an enhancement ticket, and replace the description below with a link to the ticket.

   * the "operation" could be on the nodes, possible operations are:
     * '''preops''': automatic, before entering the state/activity
     * '''postops''': automatic, when leaving the state/activity
     * '''actions''': can be chosen by the owner in the list at the bottom, and/or drop-down/pop-up together with the default actions of leaving the node on one of the arrows.
  This appears to add complexity without adding functionality; please provide a detailed example where these additions allow something currently impossible to implement.

   * operations could be anything: sum up the time used for the activity, or just write some statistical fields like 
  A workflow plugin can add an arbitrary workflow operation, so this is already possible.

   * set_actor should be an operation allowing to set the owner, e.g. as a "preop":
     * either to a role, a person
     * entered fix at define time, or at run time, e.g. out of a field, or select.
  This is either duplicating the existing `set_owner` operation, or needs to be clarified.

   * Actions should be selectable based on the ticket type (different Workflows for different tickets)
  This is becoming a frequent request, with clear usecases.  The closest the current implementation will allow is to have a plugin provide a `triage` action that sets the next state based on the ticket type, so a `new` ticket would move to `new_task`, `new_defect`, etc., and the workflow graph would separate at that point.


name: WikiDeletePage
author: trac
ipnr: 127.0.0.1
text:
  = Deleting a Wiki Page =

  Existing wiki pages can be completely deleted using the ''Delete Page'' or the ''Delete this Version'' buttons at the bottom of the wiki page. These buttons are only visible for users with `WIKI_DELETE` permissions.

  '''Note:''' Deleting a wiki page is an irreversible operation.

  In general, it is recommended to create redirection pages instead of completely deleting an old page, as to not frustrate the visitor with broken links when coming to the site from a search engine. A redirection page is a short page that  contains a link such as  “See !SomeOtherPage”. However, deleting specific versions or even complete pages can make sense to remove spam or other abusive submissions.

  ----
  See also: TracWiki, TracPermissions


name: WikiFormatting
author: trac
ipnr: 127.0.0.1
text:
  = WikiFormatting =
  [[TracGuideToc]]

  Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.

  Trac has a built in small and powerful wiki rendering engine. This wiki engine implements an ever growing subset of the commands from other popular Wikis,
  especially [http://moinmoin.wikiwikiweb.de/ MoinMoin]. 


  This page demonstrates the formatting syntax available anywhere WikiFormatting is allowed.


  == Font Styles ==

  The Trac wiki supports the following font styles:
  {{{
   * '''bold''', '''!''' can be bold too''', and '''! '''
   * ''italic''
   * '''''bold italic'''''
   * __underline__
   * {{{monospace}}} or `monospace`
   * ~~strike-through~~
   * ^superscript^ 
   * ,,subscript,,
  }}}

  Display:
   * '''bold''', '''!''' can be bold too''', and '''! '''
   * ''italic''
   * '''''bold italic'''''
   * __underline__
   * {{{monospace}}} or `monospace`
   * ~~strike-through~~
   * ^superscript^ 
   * ,,subscript,,

  Notes:
   * `{{{...}}}` and {{{`...`}}} commands not only select a monospace font, but also treat their content as verbatim text, meaning that no further wiki processing is done on this text.
   * {{{ ! }}} tells wiki parser to not take the following characters as wiki format, so pay attention to put a space after !, e.g. when ending bold.

  == Headings ==

  You can create heading by starting a line with one up to five ''equal'' characters ("=")
  followed by a single space and the headline text. The line should end with a space 
  followed by the same number of ''='' characters.
  The heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.

  Example:
  {{{
  = Heading =
  == Subheading ==
  === About ''this'' ===
  === Explicit id === #using-explicit-id-in-heading
  }}}

  Display:
  = Heading =
  == Subheading ==
  === About ''this'' ===
  === Explicit id === #using-explicit-id-in-heading

  == Paragraphs ==

  A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.

  A forced line break can also be inserted, using:
  {{{
  Line 1[[BR]]Line 2
  }}}
  Display:

  Line 1[[BR]]Line 2


  == Lists ==

  The wiki supports both ordered/numbered and unordered lists.

  Example:
  {{{
   * Item 1
     * Item 1.1
        * Item 1.1.1   
        * Item 1.1.2
        * Item 1.1.3
     * Item 1.2
   * Item 2

   1. Item 1
     a. Item 1.a
     a. Item 1.b
        i. Item 1.b.i
        i. Item 1.b.ii
   1. Item 2
  And numbered lists can also be given an explicit number:
   3. Item 3
  }}}

  Display:
   * Item 1
     * Item 1.1
        * Item 1.1.1
        * Item 1.1.2
        * Item 1.1.3
     * Item 1.2
   * Item 2

   1. Item 1
     a. Item 1.a
     a. Item 1.b
        i. Item 1.b.i
        i. Item 1.b.ii
   1. Item 2
  And numbered lists can also be given an explicit number:
   3. Item 3

  Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.


  == Definition Lists ==


  The wiki also supports definition lists.

  Example:
  {{{
   llama::
     some kind of mammal, with hair
   ppython::
     some kind of reptile, without hair
     (can you spot the typo?)
  }}}

  Display:
   llama::
     some kind of mammal, with hair
   ppython::
     some kind of reptile, without hair
     (can you spot the typo?)

  Note that you need a space in front of the defined term.


  == Preformatted Text ==

  Block containing preformatted text are suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text to define a block quote. The curly braces need to be on a separate line.
    
  Example:
  {{{
   {{{
    def HelloWorld():
        print "Hello World"
   }}}
  }}}

  Display:
  {{{
   def HelloWorld():
       print "Hello World"
  }}}


  == Blockquotes ==

  In order to mark a paragraph as blockquote, indent that paragraph with two spaces.

  Example:
  {{{
    This text is a quote from someone else.
  }}}

  Display:
    This text is a quote from someone else.

  == Discussion Citations ==

  To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used.  

  Example:
  {{{
  >> Someone's original text
  > Someone else's reply text
  My reply text
  }}}

  Display:
  >> Someone's original text
  > Someone else's reply text
  My reply text

  ''Note: Some WikiFormatting elements, such as lists and preformatted text, are  lost in the citation area.  Some reformatting may be necessary to create a clear citation.''

  == Tables ==

  Simple tables can be created like this:
  {{{
  ||Cell 1||Cell 2||Cell 3||
  ||Cell 4||Cell 5||Cell 6||
  }}}

  Display:
  ||Cell 1||Cell 2||Cell 3||
  ||Cell 4||Cell 5||Cell 6||

  Note that more complex tables can be created using
  [wiki:WikiRestructuredText#BiggerReSTExample reStructuredText].


  == Links ==

  Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.

  Example:
  {{{
   TitleIndex, http://www.edgewall.com/, !NotAlink
  }}}

  Display:
   TitleIndex, http://www.edgewall.com/, !NotAlink

  Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.  If the descriptive title is omitted, then the explicit prefix is discarded, unless the link is an external link. This can be useful for wiki pages not adhering to the WikiPageNames convention.

  Example:
  {{{
   * [http://www.edgewall.com/ Edgewall Software]
   * [wiki:TitleIndex Title Index]
   * [wiki:ISO9000]
  }}}

  Display:
   * [http://www.edgewall.com/ Edgewall Software]
   * [wiki:TitleIndex Title Index]
   * [wiki:ISO9000]

  == Trac Links ==

  Wiki pages can link directly to other parts of the Trac system. Pages can refer to tickets, reports, changesets, milestones, source files and other Wiki pages using the following notations:
  {{{
   * Tickets: #1 or ticket:1
   * Reports: {1} or report:1
   * Changesets: r1, [1] or changeset:1
   * ...
  }}}

  Display:
   * Tickets: #1 or ticket:1
   * Reports: {1} or report:1
   * Changesets: r1, [1] or changeset:1
   * ... 

  There are many more flavors of Trac links, see TracLinks for more in-depth information.


  == Escaping Links and WikiPageNames ==

  You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).

  Example:
  {{{
   !NoHyperLink
   !#42 is not a link
  }}}

  Display:
   !NoHyperLink
   !#42 is not a link


  == Images ==

  Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.

  You now have to use the ![[Image]] macro. The simplest way to include an image is to upload it as attachment to the current page, and put the filename in a macro call like `[[Image(picture.gif)]]`.

  In addition to the current page, it is possible to refer to other resources:
   * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page)
   * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket)
   * `[[Image(htdocs:picture.gif)]]` (referring to a file inside project htdocs)
   * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository)

  Example display: [[Image(htdocs:../common/trac_logo_mini.png)]]


  See WikiMacros for further documentation on the `[[Image()]]` macro.


  == Macros ==

  Macros are ''custom functions'' to insert dynamic content in a page.

  Example:
  {{{
   [[RecentChanges(Trac,3)]]
  }}}

  Display:
   [[RecentChanges(Trac,3)]]

  See WikiMacros for more information, and a list of installed macros.


  == Processors ==

  Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in 
  [wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. 

  Example 1:
  {{{
  #!html
  <pre class="wiki">{{{
  #!html
  &lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt;
  }}}</pre>
  }}}

  Display:
  {{{
  #!html
  <h1 style="text-align: right; color: blue">HTML Test</h1>
  }}}

  Example:
  {{{
  #!html
  <pre class="wiki">{{{
  #!python
  class Test:

      def __init__(self):
          print "Hello World"
  if __name__ == '__main__':
     Test()
  }}}</pre>
  }}}

  Display:
  {{{
  #!python
  class Test:
      def __init__(self):
          print "Hello World"
  if __name__ == '__main__':
     Test()
  }}}

  Perl:
  {{{
  #!perl
  my ($test) = 0;
  if ($test > 0) {
      print "hello";
  }
  }}}

  See WikiProcessors for more information.


  == Comments ==

  Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
  {{{
  {{{
  #!comment
  Your comment here
  }}}
  }}}


  == Miscellaneous ==

  Four or more dashes will be replaced by a horizontal line (<HR>)

  Example:
  {{{
   ----
  }}}

  Display:
  ----



  ----
  See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.


name: WikiHtml
author: trac
ipnr: 127.0.0.1
text:
  = Using HTML in Wiki Text =

  Trac supports inserting HTML into any wiki context, accomplished using the HTML [wiki:WikiProcessors WikiProcessor].

  HTML support is built-in, and does not require installing any additional packages.

  == How to Use HTML ==
  To inform the wiki engine that a block of text should be treated as HTML, use the ''html'' processor. 

  This example should explain:
  {{{
  #!html
  <pre class="wiki">{{{
  #!html
  &lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt;
  }}}</pre>
  }}}

  Results in:
  {{{
  #!html
  <h1 style="text-align: right; color: blue">HTML Test</h1>
  }}}

  Note that Trac sanitizes your HTML code before displaying it. That means that if you try to use potentially dangerous constructs such as Javascript event handlers, those will be removed from the output. 

  Since 0.11, the filtering is done by Genshi, and as such, the produced out will be a well-formed fragment of HTML. In other words, this mean that you can no longer use two HTML blocks, one for opening a <div>, the second for closing it, in order to wrap arbitrary wiki text.
  To achieve this, you need now to use the ''div'' Wiki processor:

  {{{
  {{{
  #!div class=important style="border: 2pt solid; text-align: center"
  This is the ''only'' way to go in Trac 0.11
  }}}
  }}}

  Results in:
  {{{
  #!div class=important style="border: 2pt solid; text-align: center"
  This is the ''only'' way to go in Trac 0.11
  }}}

  For spans, you should rather use the Macro call syntax:
  {{{
   Hello [[span(''WORLD'' (click [#world-anchor here]), style=color: green; font-size: 120%, id=world-anchor)]]!
  }}}

  Results in:
   Hello [[span(''WORLD'' (click [#world-anchor here]), style=color: green; font-size: 120%, id=world-anchor)]]!


  == More Information ==

   * http://www.w3.org/ -- World Wide Web Consortium
   * http://www.w3.org/MarkUp/ -- HTML Markup Home Page

  ----
  See also:  WikiProcessors, WikiFormatting, WikiRestructuredText


name: WikiMacros
author: trac
ipnr: 127.0.0.1
text:
  = Trac Macros =

  [[PageOutline]]

  Trac macros are plugins to extend the Trac engine with custom 'functions' written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting.

  Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting).

  == Using Macros ==
  Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses. 

  Trac macros can also be written as TracPlugins. This gives them some capabilities that macros do not have, such as being able to directly access the HTTP request.

  === Example ===

  A list of 3 most recently changed wiki pages starting with 'Trac':

  {{{
   [[RecentChanges(Trac,3)]]
  }}}

  Display:
   [[RecentChanges(Trac,3)]]

  == Available Macros ==

  ''Note that the following list will only contain the macro documentation if you've not enabled `-OO` optimizations, or not set the `PythonOptimize` option for [wiki:TracModPython mod_python].''

  [[MacroList]]

  == Macros from around the world ==

  The [http://trac-hacks.org/ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you're looking for new macros, or have written one that you'd like to share with the world, please don't hesitate to visit that site.

  == Developing Custom Macros ==
  Macros, like Trac itself, are written in the [http://python.org/ Python programming language].

  For more information about developing macros, see the [wiki:TracDev development resources] on the main project site.


  == Implementation ==

  Here are 2 simple examples on how to create a Macro with [wiki:0.11 Trac 0.11] have a look at source:trunk/sample-plugins/Timestamp.py for an example that shows the difference between old style and new style macros and also source:trunk/wiki-macros/README which provides a little more insight about the transition.

  === Macro without arguments ===
  It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name
  {{{
  #!python
  from datetime import datetime
  # Note: since Trac 0.11, datetime objects are used internally

  from genshi.builder import tag

  from trac.util.datefmt import format_datetime, utc
  from trac.wiki.macros import WikiMacroBase

  class TimestampMacro(WikiMacroBase):
      """Inserts the current time (in seconds) into the wiki page."""

      revision = "$Rev$"
      url = "$URL$"

      def expand_macro(self, formatter, name, args):
          t = datetime.now(utc)
          return tag.b(format_datetime(t, '%c'))
  }}}

  === Macro with arguments ===
  It should be saved as `HelloWorld.py` (in the plugins/ directory) as Trac will use the module name as the Macro name
  {{{
  #!python
  from trac.wiki.macros import WikiMacroBase

  class HelloWorldMacro(WikiMacroBase):
      """Simple HelloWorld macro.

      Note that the name of the class is meaningful:
       - it must end with "Macro"
       - what comes before "Macro" ends up being the macro name

      The documentation of the class (i.e. what you're reading)
      will become the documentation of the macro, as shown by
      the !MacroList macro (usually used in the WikiMacros page).
      """

      revision = "$Rev$"
      url = "$URL$"

      def expand_macro(self, formatter, name, args):
          """Return some output that will be displayed in the Wiki content.

          `name` is the actual name of the macro (no surprise, here it'll be
          `'HelloWorld'`),
          `args` is the text enclosed in parenthesis at the call of the macro.
            Note that if there are ''no'' parenthesis (like in, e.g.
            [[HelloWorld]]), then `args` is `None`.
          """
          return 'Hello World, args = ' + unicode(args)
      
      # Note that there's no need to HTML escape the returned data,
      # as the template engine (Genshi) will do it for us.
  }}}


  === {{{expand_macro}}} details ===
  {{{expand_macro}}} should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use {{{from trac.util.html import Markup}}}).  {{{Markup(string)}}} just annotates the string so the renderer will render the HTML string as-is with no escaping. You will also need to import Formatter using {{{from trac.wiki import Formatter}}}.

  If your macro creates wiki markup instead of HTML, you can convert it to HTML like this:

  {{{
  #!python
    text = "whatever wiki markup you want, even containing other macros"
    # Convert Wiki markup to HTML, new style
    out = StringIO()
    Formatter(self.env, formatter.context).format(text, out)
    return Markup(out.getvalue())
  }}}


name: WikiNewPage
author: trac
ipnr: 127.0.0.1
text:
  = Steps to Add a New Wiki Page =
  [[TracGuideToc]]

   1. Choose a name for your new page. See WikiPageNames for naming conventions.
   2. Edit an existing page (or any other resources that support WikiFormatting and add a [TracLinks link] to your new page. Save your changes.
   3. Follow the link you created to take you to the new page. Trac will display a "describe !PageName here" message.
   4. Click the "Edit this page" button to edit and add content to your new page. Save your changes.
   5. All done. Your new page is published.

  You can skip the second step by entering the CamelCase name of the page in the quick-search field at the top of the page. But note that the page will effectively be "orphaned" unless you link to it from somewhere else.
  ----
  See also: TracWiki, PageTemplates, WikiFormatting, TracLinks, WikiDeletePage


name: WikiPageNames
author: trac
ipnr: 127.0.0.1
text:
  = Wiki Page Names =
  [[TracGuideToc]]

  Wiki page names commonly use the CamelCase convention. Within wiki text, any word in CamelCase automatically becomes a hyperlink to the wiki page with that name.

  CamelCase page names must follow these rules:

   1. The name must consist of '''alphabetic characters only'''. No digits, spaces, punctuation, or underscores are allowed.
   2. A name must have at least two capital letters.
   3. The first character must be capitalized.
   4. Every capital letter must be followed by one or more lower-case letters. 
   5. The use of slash ( / ) is permitted in page names (possibly representing a hierarchy).

  If you want to create a wiki page that doesn't follow CamelCase rules you can use the following syntax:
  {{{
   * [wiki:Wiki_page], [wiki:ISO9000]
   * [wiki:"Space Matters"] that page name embeds space characters
   * or simply: ["WikiPageName"]s (!MoinMoin's internal free links style)
  }}}

  This will be rendered as:
   * [wiki:Wiki_page], [wiki:ISO9000]
   * [wiki:"Space Matters"] that page name embeds space characters
   * or simply: ["WikiPageName"]s (!MoinMoin's internal free links style)

  Starting with Trac 0.11, it's also possible to link to a specific ''version'' of a Wiki page, as you would do for a specific version of a file, for example: WikiStart@1.

  See also TracLinks#QuotingspaceinTracLinks.

  Finally, and as exemplified in the line above, one can also append an anchor to a Wiki page name, in order to link to a specific section within that page. The anchor can easily be seen by hovering the mouse over a section heading, then clicking on the [[html(&para;)]] sign that appears at its end. The anchor is usually generated automatically, but it's also possible to specify it explicitly: see WikiFormatting#using-explicit-id-in-heading.
  ----
  See also: WikiNewPage, WikiFormatting, TracWiki, TracLinks


name: WikiProcessors
author: trac
ipnr: 127.0.0.1
text:
  = Wiki Processors =

  Processors are WikiMacros designed to provide alternative markup formats for the [TracWiki Wiki engine]. Processors can be thought of as ''macro functions to process user-edited text''. 

  The Wiki engine uses processors to allow using [wiki:WikiRestructuredText Restructured Text], [wiki:WikiHtml raw HTML] and [http://www.textism.com/tools/textile/ textile] in any Wiki text throughout Trac.


  == Using Processors ==

  To use a processor on a block of text, use a Wiki code block, selecting a processor by name using ''shebang notation'' (#!), familiar to most UNIX users from scripts.

  '''Example 1''' (''inserting raw HTML in a wiki text''):

  {{{
  #!html
  <pre class="wiki">{{{
  #!html
  &lt;h1 style="color: orange"&gt;This is raw HTML&lt;/h1&gt;
  }}}</pre>
  }}}

  '''Results in:'''
  {{{
  #!html
  <h1 style="color: orange">This is raw HTML</h1>
  }}}

  Note that since 0.11, such blocks of HTML have to be self-contained, i.e. you can't start an HTML element in one block and close it later in a second block. Use div or span processors for achieving similar effect (see WikiHtml).

  ----

  '''Example 2''' (''inserting Restructured Text in wiki text''):

  {{{
  #!html
  <pre class="wiki">{{{
  #!rst
  A header
  --------
  This is some **text** with a footnote [*]_.

  .. [*] This is the footnote.
  }}}</pre>
  }}}

  '''Results in:'''
  {{{
  #!rst
  A header
  --------
  This is some **text** with a footnote [*]_.

  .. [*] This is the footnote.
  }}}
  ----
  '''Example 3''' (''inserting a block of C source code in wiki text''):

  {{{
  #!html
  <pre class="wiki">{{{
  #!c
  int main(int argc, char *argv[])
  {
    printf("Hello World\n");
    return 0;
  }
  }}}</pre>
  }}}

  '''Results in:'''
  {{{
  #!c
  int main(int argc, char *argv[])
  {
    printf("Hello World\n");
    return 0;
  }
  }}}

  ----

  == Available Processors ==
  The following processors are included in the Trac distribution:
   * '''html''' -- Insert custom HTML in a wiki page. See WikiHtml.
   * '''div''' -- Wrap an arbitrary Wiki content in a <div> element (''since 0.11''). See WikiHtml.
   * '''span''' -- Wrap an arbitrary Wiki content in a <span> element (''since 0.11''). See also WikiHtml.
   * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText.
   * '''textile''' -- Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference].
   * '''comment''' -- Do not process the text in this section (i.e. contents exist only in the plain text - not in the rendered page).

  === Code Highlighting Support ===
  Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for the following languages:
   * '''c''' -- C
   * '''cpp''' -- C++
   * '''python''' -- Python
   * '''perl''' -- Perl
   * '''ruby''' -- Ruby
   * '''php''' -- PHP
   * '''asp''' -- ASP
   * '''java''' -- Java
   * '''js''' -- Javascript
   * '''sql''' -- SQL
   * '''xml''' -- XML
   * '''sh''' -- Bourne/Bash shell

  '''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.''

  By using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. For example, you can write:
  {{{
  {{{
  #!text/html
  <h1>text</h1>
  }}}
  }}}

  The result will be syntax highlighted HTML code:
  {{{
  #!text/html
  <h1>text</h1>
  }}}

  The same is valid for all other mime types supported.


  For more processor macros developed and/or contributed by users, visit: 
   * [trac:ProcessorBazaar]
   * [trac:MacroBazaar]
   * [th:WikiStart Trac Hacks] community site


  == Advanced Topics: Developing Processor Macros ==
  Developing processors is no different from Wiki macros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.


  ----
  See also: WikiMacros, WikiHtml, WikiRestructuredText, TracSyntaxColoring, WikiFormatting, TracGuide


name: WikiRestructuredText
author: trac
ipnr: 127.0.0.1
text:
  = reStructuredText Support in Trac =

  Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context WikiFormatting is used.

  From the reStucturedText webpage:
   "''reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser   system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating  simple web pages, and for standalone documents. reStructuredText is designed for extensibility for  specific application domains. ''"

  === Requirements ===
  Note that to activate RST support in Trac, the python docutils package must be installed. 
  If not already available on your operating system, you can download it at the [http://docutils.sourceforge.net/rst.html RST Website].

  === More information on RST ===

   * reStructuredText Website -- http://docutils.sourceforge.net/rst.html
   * RST Quick Reference -- http://docutils.sourceforge.net/docs/rst/quickref.html

  ----

  == Using RST in Trac ==
  To specify that a block of text should be parsed using RST, use the ''rst'' processor. 

  === TracLinks in reStructuredText ===

   * Trac provides a custom RST reference-directive 'trac' to allow TracLinks from within RST text.

   Example:
   {{{
   {{{
   #!rst
   This is a reference to |a ticket|

   .. |a ticket| trac:: #42
   }}}
   }}}

   For a complete example of all uses of the ''trac''-directive, please see WikiRestructuredTextLinks. 


   * Trac allows an even easier way of creating TracLinks in RST, using the custom '':trac:'' link naming scheme.

   Example:
   {{{
   {{{
   #!rst
   This is a reference to ticket `#12`:trac:

   To learn how to use Trac, see `TracGuide`:trac:
   }}}
   }}}

  === Syntax highlighting in reStructuredText ===

  There is a directive for doing TracSyntaxColoring in ReST as well. The directive is called
  code-block

  Example

  {{{
  {{{
  #!rst

  .. code-block:: python

   class Test:

      def TestFunction(self):
          pass

  }}}
  }}}

  Will result in the below.

  {{{
  #!rst

  .. code-block:: python

   class Test:

      def TestFunction(self):
          pass

  }}}

  === Wiki Macros in reStructuredText ===

  For doing [WikiMacros Wiki Macros] in ReST you use the same directive as for syntax highlighting i.e
  code-block. To work you must use a version of trac that has #801 applied. 

  === Wiki Macro Example ===

  {{{
  {{{
  #!rst

  .. code-block:: RecentChanges

     Trac,3

  }}}
  }}}

  Will result in the below:

       [[RecentChanges(Trac,3)]]

  Or a more concise Wiki Macro like syntax is also available:

  {{{
  {{{
  #!rst

  :code-block:`RecentChanges:Trac,3`
  }}}
  }}}

  === Bigger ReST Example ===
  The example below should be mostly self-explanatory:
  {{{
  #!html
  <pre class="wiki">{{{
  #!rst
  FooBar Header
  =============
  reStructuredText is **nice**. It has its own webpage_.

  A table:

  =====  =====  ======
     Inputs     Output
  ------------  ------
    A      B    A or B
  =====  =====  ======
  False  False  False
  True   False  True
  False  True   True
  True   True   True
  =====  =====  ======

  RST TracLinks
  -------------

  See also ticket `#42`:trac:.

  .. _webpage: http://docutils.sourceforge.net/rst.html
  }}}</pre>
  }}}


  Results in:
  {{{
  #!rst
  FooBar Header
  =============
  reStructuredText is **nice**. It has its own webpage_.

  A table:

  =====  =====  ======
     Inputs     Output
  ------------  ------
    A      B    A or B
  =====  =====  ======
  False  False  False
  True   False  True
  False  True   True
  True   True   True
  =====  =====  ======

  RST TracLinks
  -------------

  See also ticket `#42`:trac:.

  .. _webpage: http://docutils.sourceforge.net/rst.html
  }}}


  ----
  See also: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting


name: WikiRestructuredTextLinks
author: trac
ipnr: 127.0.0.1
text:
  = TracLinks in reStructuredText =

  This document illustrates how to use the ``..trac::`` directive in reStructureThe page is written like

  {{{
  {{{
  #!rst 

  Examples:
   * Tickets: :trac:`#1` or :trac:`ticket:1`
   * Ticket comments: :trac:`comment:ticket:1:2`
   * Reports: :trac:`{1}` or :trac:`report:1`
   * Changesets: :trac:`r1`, :trac:`[1]` or :trac:`changeset:1`
   * Revision log: :trac:`r1:3`, :trac:`[1:3]` or :trac:`log:@1:3`, :trac:`log:trunk@1:3`
   * Diffs (since version 0.10): :trac:`diff:@20:30`, :trac:`diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` or :trac:`diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539`
   * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
   * Milestones: :trac:`milestone:1.0`
   * Attachment: :trac:`attachment:ticket:944:attachment.1073.diff`
   * Files: :trac:`source:trunk/COPYING`
   * A specific file revision: :trac:`source:/trunk/COPYING@200`
   * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`

  }}}
  }}}

  Provided you have docutils installed, the above block will render as:
  ----
  {{{
  #!rst 

  Examples:
   * Tickets: :trac:`#1` or :trac:`ticket:1`
   * Ticket comments: :trac:`comment:ticket:1:2`
   * Reports: :trac:`{1}` or :trac:`report:1`
   * Changesets: :trac:`r1`, :trac:`[1]` or :trac:`changeset:1`
   * Revision log: :trac:`r1:3`, :trac:`[1:3]` or :trac:`log:@1:3`, :trac:`log:trunk@1:3`
   * Diffs (since version 0.10): :trac:`diff:@20:30`, :trac:`diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default` or :trac:`diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539`
   * Wiki pages: :trac:`CamelCase` or :trac:`wiki:CamelCase`
   * Milestones: :trac:`milestone:1.0`
   * Attachment: :trac:`attachment:ticket:944:attachment.1073.diff`
   * Files: :trac:`source:trunk/COPYING`
   * A specific file revision: :trac:`source:/trunk/COPYING@200`
   * A particular line of a specific file revision: :trac:`source:/trunk/COPYING@200#L25`

  }}}
  ----

  Note also that any of the above could have been written using the alternate syntax for roles:
  {{{
  {{{
  #!rst

  See _`ticket:123`

   .. trac:: ticket:123 Ticket 123
  }}}
  }}}
  ----

  {{{
  #!rst

  See _`ticket:123`

  .. trac:: ticket:123 Ticket 123
  }}}
  ----
  The above form has the additional benefit of allowing you to specify an explicit label for the link.

  ----
  See also: WikiRestructuredText, TracLinks


name: WikiStart
author: trac
ipnr: 127.0.0.1
text:
  = Welcome to Trac 0.11.1 =

  Trac is a '''minimalistic''' approach to '''web-based''' management of
  '''software projects'''. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress.

  All aspects of Trac have been designed with the single goal to 
  '''help developers write great software''' while '''staying out of the way'''
  and imposing as little as possible on a team's established process and
  culture.

  As all Wiki pages, this page is editable, this means that you can
  modify the contents of this page simply by using your
  web-browser. Simply click on the "Edit this page" link at the bottom
  of the page. WikiFormatting will give you a detailed description of
  available Wiki formatting commands.

  "[wiki:TracAdmin trac-admin] ''yourenvdir'' initenv" created
  a new Trac environment, containing a default set of wiki pages and some sample
  data. This newly created environment also contains 
  [wiki:TracGuide documentation] to help you get started with your project.

  You can use [wiki:TracAdmin trac-admin] to configure
  [http://trac.edgewall.org/ Trac] to better fit your project, especially in
  regard to ''components'', ''versions'' and ''milestones''. 


  TracGuide is a good place to start.

  Enjoy! [[BR]]
  ''The Trac Team''

  == Starting Points ==

   * TracGuide --  Built-in Documentation
   * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project
   * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions
   * TracSupport --  Trac Support

  For a complete list of local wiki pages, see TitleIndex.


name: WikiStart
author: ewencp
ipnr: 171.67.76.143
comment: Initial front page.
text:
  = Sirikata =

  Sirikata is an BSD licensed open source platform for games and virtual worlds. We aim to provide a set of libraries and protocols which can be used to deploy a virtual world, as well as fully featured sample implementations of services for hosting and deploying these worlds.

  If you're looking to file a bug report, request a feature, or find out the current status of development, you're in the right place.  For everything else, start at http://www.sirikata.com.


