Commits

Anonymous committed 8bb7049

Synched wiki-default with projects.edgewall.com

  • Participants
  • Parent commits 8b7dfc0
  • Branches trunk

Comments (0)

Files changed (51)

wiki-default/ModPython

-= Trac and mod_python =
-
-Trac 0.7.1 and later supports [http://www.modpython.org/ mod_python], which speeds up Trac's response times considerably and permits use of many Apache features not possible with tracd/mod_proxy.
-
-'''Note''': The mod_python support in 0.7.1 has a couple of bugs that have since been fixed in both the [http://projects.edgewall.com/trac/browser/branches/0.7-stable 0.7 branch] and [http://projects.edgewall.com/trac/browser/trunk trunk], and will be released with [http://projects.edgewall.com/trac/milestone/0.8 0.8].
-
-== Simple configuration ==
-
-Here's a typical Trac CGI/Apache setup:
-
-{{{
-ScriptAlias /trac/myproject /path/to/python/share/trac/cgi-bin/trac.cgi
-<Location /trac/myproject>
-   SetEnv TRAC_ENV /var/svn/trac/myproject
-</Location>
-}}}
-
-The equivalent mod_python setup is:
-
-{{{
-<Location /trac/myproject>
-   SetHandler mod_python
-   PythonHandler trac.ModPythonHandler
-   PythonOption TracUriRoot "/trac/myproject"
-   PythonOption TracEnv /var/svn/trac/myproject
-</Location>
-}}}
-
-Note that the option ''TracUriRoot'' may or may not be necessary in your setup. Try without first, and if the URLs produced by Trac look wrong, add the ''TracUriRoot'' option.
-
-== Setting up multiple projects ==
-
-=== The easy way ===
-
-The Trac mod_python handler handler supports a configuration option similar to Subversion's {{{SvnParentPath}}}, called {{{TracEnvParentDir}}}:
-
-{{{
-<LocationMatch /trac>
-  SetHandler mod_python
-  PythonHandler trac.ModPythonHandler
-  PythonOption TracUriRoot /trac
-  PythonOption TracEnvParentDir "/var/www/projects"
-</LocationMatch>
-}}}
-
-When you request the {{{/trac}}} URL, you will get a (currently very simple) listing of all subdirectories of the directory you set as {{{TracEnvParentDir}}}. Selecting any project in the list will bring you to the corresponding Trac instance. You should make sure that the configured directory only contains Trac environment directories that match the currently installed Trac version, because that is not checked prior the the generation of the project list.
-
-=== Or the hard way ===
-
-The Trac mod_python handler can be configured to serve multiple projects, as can be seen in the following simple example:
-
-{{{
-<LocationMatch /trac/[[:alnum:]]+>
-  SetHandler mod_python
-  PythonHandler trac.ModPythonHandler
-</LocationMatch>
-<Location /trac/exampleone>
-  PythonOption TracUriRoot "/trac/exampleone"
-  PythonOption TracEnv "/var/www/projects/exampleone"
-</Location>
-<Location /trac/exampletwo>
-  PythonOption TracUriRoot "/trac/exampletwo"
-  PythonOption TracEnv "/var/www/projects/exampletwo"
-</Location>
-}}}
-
-This sets up two projects. The disadvantage of the approach used here is that you need one additional {{{<Location>}}} directive per Trac instance. You may be able to eliminate this using some mod_rewrite tricks.
-
-=== Adding authentication ===
-
-Adding authentication is straightforward in both cases. For example:
-
-{{{
-<LocationMatch /trac/[[:alnum:]]+/login>
-  AuthType Basic
-  AuthName "Trac"
-  AuthUserFile /var/www/passwd
-  Require valid-user
-</LocationMatch>
-}}}
-
-=== Win32 Issues ===
-
-If you run trac with mod_python on Windows, attachments will not work.
-
-There is a (simple) workaround for this which is to apply the patch attached to 
-ticket [http://projects.edgewall.com/trac/ticket/554 #554].
-
-
-----
-See also TracGuide, TracInstall, TracMultipleProjects

wiki-default/RecentChanges

-= Recent Changes =
-
-[[RecentChanges]]
+= Recent Changes =
+
+[[RecentChanges]]

wiki-default/TitleIndex

-= Title Index =
-
-[[TitleIndex]]
+= Title Index =
+
+[[TitleIndex]]

wiki-default/TracAccessibility

-= 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.
-
-== Accessibility Keys ==
- * 1 - WikiStart
- * 2 - Timeline
- * 4 - Search
- * 5 - TracGuide / Documentation
- * 6 - TracGuide / Documentation
- * 7 - New Ticket
- * 8 - About Trac
- * 9 - New Ticket
- * 0 - TracAccessibility 
-
-----
+= 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.
+
+== Accessibility Keys ==
+ * 1 - WikiStart
+ * 2 - Timeline
+ * 3 - Roadmap
+ * 4 - Search
+ * 5 - TracFaq
+ * 6 - TracGuide / Documentation
+ * 7 - New Ticket
+ * 9 - About Trac
+ * 0 - TracAccessibility 
+
+----
 See also: TracGuide

wiki-default/TracAdmin

 = TracAdmin =
+[[TracGuideToc]]
 
 Trac is distributed with a powerful configuration tool. This tool can be used 
 to configure and customize your Trac-installation to better fit your needs.
 == Usage ==
 
 {{{
-Usage: trac-admin <dbfile> [command [subcommand] [option ...]]
+Usage: trac-admin </path/to/projenv> [command [subcommand] [option ...]]
 
 Invoking trac-admin without command starts interactive mode.
 
-about                               -- Shows information about trac-admin
-help                                -- Show documentation
-initdb                              -- Create and initializes a new database
-config list                         -- Show current configuration
-config set <option> <value>         -- Set config
-wiki list                           -- List wiki pages
-wiki export <page> [file]           -- Export wiki page to file or stdout
-wiki import <page> [file]           -- Import wiki page from file or stdin
-wiki dump <directory>               -- Export all wiki pages to files named by title
-permission list                     -- List permission rules
-permission add <user> <action>      -- Add a new permission rule
-permission remove <user> <action>   -- Remove permission rule
-component list                      -- Show available components
-component add <name> <owner>        -- Add a new component
-component rename <name> <newname>   -- Rename a component
-component remove <name>             -- Remove/uninstall component
-component chown <name> <owner>      -- Change component ownership
-priority list                       -- Show possible ticket priorities
-priority add <value>                -- Add a priority value option
-priority change <value> <newvalue>  -- Change a priority value
-priority remove <value>             -- Remove priority value
-severity list                       -- Show possible ticket priorities
-severity add <value>                -- Add a severity value option
-severity change <value> <newvalue>  -- Change a severity value
-severity remove <value>             -- Remove severity value
-version list                        -- Show versions
-version add <name> [time]           -- Add version
-version rename <name> <newname>     -- Rename version
-version time <name> <time>          -- Set version date/time
-version remove <name>               -- Remove version
-milestone list                      -- Show milestones
-milestone add <name> [time]         -- Add milestone
-milestone rename <name> <newname>   -- Rename milestone
-milestone time <name> <time>        -- Set milestone date/time
-milestone remove <name>             -- Remove milestone
+about                                             -- Shows information about trac-admin                    
+help                                              -- Show documentation                                    
+initenv                                           -- Create and initialize a new environment interactively 
+initenv <projectname> <repospath> <templatepath>  -- Create and initialize a new environment from arguments
+hotcopy <backupdir>                               -- Make a hot backup copy of an environment.             
+resync                                            -- Re-synchronize trac with the repository               
+upgrade                                           -- Upgrade database to current version.                  
+wiki list                                         -- List wiki pages                                       
+wiki export <page> [file]                         -- Export wiki page to file or stdout                    
+wiki import <page> [file]                         -- Import wiki page from file or stdin                   
+wiki dump <directory>                             -- Export all wiki pages to files named by title         
+wiki load <directory>                             -- Import all wiki pages from directory                  
+wiki upgrade                                      -- Upgrade default wiki pages to current version         
+permission list                                   -- List permission rules                                 
+permission add <user> <action> [action] [...]     -- Add a new permission rule                             
+permission remove <user> <action> [action] [...]  -- Remove permission rule                                
+component list                                    -- Show available components                             
+component add <name> <owner>                      -- Add a new component                                   
+component rename <name> <newname>                 -- Rename a component                                    
+component remove <name>                           -- Remove/uninstall component                            
+component chown <name> <owner>                    -- Change component ownership                            
+priority list                                     -- Show possible ticket priorities                       
+priority add <value>                              -- Add a priority value option                           
+priority change <value> <newvalue>                -- Change a priority value                               
+priority remove <value>                           -- Remove priority value                                 
+severity list                                     -- Show possible ticket priorities                       
+severity add <value>                              -- Add a severity value option                           
+severity change <value> <newvalue>                -- Change a severity value                               
+severity remove <value>                           -- Remove severity value                                 
+version list                                      -- Show versions                                         
+version add <name> [time]                         -- Add version                                           
+version rename <name> <newname>                   -- Rename version                                        
+version time <name> <time>                        -- Set version date (Format: "Jun 3, 2003")              
+version remove <name>                             -- Remove version                                        
+milestone list                                    -- Show milestones                                       
+milestone add <name> [time]                       -- Add milestone                                         
+milestone rename <name> <newname>                 -- Rename milestone                                      
+milestone time <name> <time>                      -- Set milestone date (Format: "Jun 3, 2003")            
+milestone remove <name>                           -- Remove milestone                                      
 }}}
 
-== Interactive mode ==
+== Interactive Mode ==
 
-'''trac-admin''' starts in an interactive mode when started with the database 
-filename as the only argument. Commands can then be executed on the selected 
-database using the tab-completing prompt.
+When passed the database filename as only argument, '''trac-admin''' starts in interactive mode.
+Commands can then be executed on the selected database using the prompt, which offers tab-completion
+(on non-Windows environments) and automatic repetition of the last command issued.
+
+== A Note on Configuration ==
+For configuration of the Trac environment, Trac 0.7 introduced a new storage format, including a separate config file used for settings. See TracIni for details.
+
+
+----
+See Also: TracGuide, TracBackup, TracPermissions. TracEnvironment, TracIni

wiki-default/TracBackup

-= Trac Backup =
-Since Trac uses a database backend, it requires some extra care to safely create a backup of a TracEnvironment. Luckily, TracAdmin 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 /some/where/mytracenv hotcopy /my/vault/mytracenv-backup
-}}}
-
-'''Note:''' TracAdmin will lock the database while copying.
-
-The resulting backup copy is safe to handle using standard file-based backup tools like tar or dump/restore.
-
-
-=== Restoring a Backup ===
-Backups are simply a copied snapshot of the entire TracEnvironment directory structure, including the SQLite database. 
-
-To restore an environment from a backup, simply shut down your Trac service (Web server or tracd), restore the directory structure from backup and restart the service.
-
-----
-See also: TracAdmin, TracGuide
+= Trac Backup =
+Since Trac uses a database backend, it requires some extra care to safely create a backup of a TracEnvironment. Luckily, TracAdmin 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 /some/where/mytracenv hotcopy /my/vault/mytracenv-backup
+}}}
+
+'''Note:''' TracAdmin will lock the database while copying.
+
+The resulting backup copy is safe to handle using standard file-based backup tools like tar or dump/restore.
+
+
+=== Restoring a Backup ===
+Backups are simply a copied snapshot of the entire TracEnvironment directory structure, including the SQLite database. 
+
+To restore an environment from a backup, simply shut down your Trac service (Web server or tracd), restore the directory structure from backup and restart the service.
+
+----
+See also: TracAdmin, TracGuide

wiki-default/TracBrowser

-= The Trac Browser =
-
-The Trac browser can be used to browse directories, change logs 
-and specific revisions of files stored in a subversion repository.
-
-Directory entries are displayed in a list with sortable columns. The list 
-entries can be sorted '''by name''', '''size''' or '''date''' by clicking on the column headers.
-The sorting 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 filenames on the other 
-hand will display the files change log.
-
-It's also possible to browse directories as they were at any given repository revision. 
-The default behavior is to use the information from the latest revision but
-another revision can easily be selected using the form at the top of the
-page.
-
-== RSS Support ==
-The browser module supports RSS 2.0 syndication of changes to a single file. To subscribe to an RSS version of the revision log for a file, open a file log in the browser, and click the orange 'XML' icon at the bottom of the page. See TracRss for more information on RSS support in Trac.
-----
+= The Trac Browser =
+[[TracGuideToc]]
+
+The Trac browser can be used to browse directories, change logs 
+and specific revisions of files stored in a subversion repository.
+
+Directory entries are displayed in a list with sortable columns. The list 
+entries can be sorted by '''name''', '''size''' or '''date''' 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 filenames on the other 
+hand will display the files change log.
+
+It's also possible to browse directories 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 form at the top of the
+page.
+
+'''Note:''' The browser does not use the Subversion access configuration so if you restrict read access to part of the repository in Subversion that same restriction will not be in place in the Trac browser. (Support for this functionality '''is''' being worked on for future Trac versions)
+
+== RSS Support ==
+
+The browser module supports RSS syndication to monitor changes to a file. To subscribe to an RSS feed of the revision log for a file, 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: TracGuide, TracChangeset

wiki-default/TracChangeset

 = Trac Changeset Module =
+[[TracGuideToc]]
+
 Trac has a built-in functionality for visualizing diffs - changes to files.
 
 == The Changeset View ==
 
 === Changeset Header ===
 
-The diff body shows an overview of the whole changeset.
+The header shows an overview of the whole changeset.
 Here you will find information such as:
 
- * Revision -- The unique revision ID for this changeset.
- * 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.
+ * 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
 
 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
- * Orange: Modified
+ * Yellow: Modified
 
 The color legend is located below the header as a reminder.
 
 === Diff View ===
-Below the header is the main part of the changeset, the diff view.
 
-Each file is shown in a separate section, divided by a dashed line in the
-center. This is a '''side-by-side''' view showing only the portions of the file
-affected by this changeset.
+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):
 
-On the left hand side are the contents of the old version of the file, on the
-right side the new. To visualize the difference between the old and new
-version, each block of lines altered by the changeset has a colored
-background. The color reflect the change, and the meaning the same as in the
-header (see above).
+ * The ''inline'' style shows the changed regions of a file underneath eachother. 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 of 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
+ * You can toggle whether blank lines, case changes and white space changes are ignored, thereby letting you find the functional changes more quickly
 
 ----
 See also: TracGuide, TracBrowser

wiki-default/TracEnvironment

-= Trac Storage - The Environment =
-Trac uses a directory structure and an embedded [http://www.sqlite.org/ SQLite] database as storage.
-
-
-== Directory Structure ==
-{{{
- EnvDir
-   |-- README
-   |-- VERSION
-   |-- attachments
-   |   |-- ticket
-   |   `-- wiki
-   |-- conf
-   |   `-- trac.ini
-   |-- db
-   |   `-- trac.db
-   |-- log
-   |   `-- trac.log
-   |-- templates
-   |   |-- site_css.cs
-   |   |-- site_footer.cs
-   |   `-- site_header.cs
-   `-- wiki-macros
-}}}
-
- * '''README''' - Brief description of the environment.
- * '''VERSION''' - Contains the environment version identifier.
- * '''attachments''' - All attached files go in here.
-   * '''ticket''' - Ticket attachments.
-   * '''wiki''' - Wiki attachments.
- * '''conf'''
-   * '''trac.ini''' - Main configuration file. See TracIni.
- * '''db'''
-   * '''trac.db''' - SQLite database.
- * '''templates''' - Custom (environment-specific) templates.
-   * '''site_css.cs''' - Custom CSS stylesheet.
-   * '''site_footer.cs''' - Custom footer.
-   * '''site_header.cs''' - Custom header.
- * '''wiki-macros''' - Environment-specific WikiMacros.
-
-----
-See also: TracBackup, TracIni, TracGuide
+= Trac Storage - The Environment =
+Trac uses a directory structure and an embedded [http://www.sqlite.org/ SQLite] database as storage.
+
+== Creating an Environment ==
+A new Trac environment is created using [wiki:TracAdmin trac-admin], like:
+
+{{{
+$ trac-admin /path/to/projectenv initenv
+}}}
+
+[wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and
+where it can find the trac templates directory (the default value should work for a typical install).
+
+'''Note:''' The web server user will require file system write permission to the environment
+directory and all the files inside. '''Remember to set the appropriate permissions.''
+
+The same applies for the subversion repository files (unless using the [http://svn.collab.net/repos/svn/trunk/notes/fsfs FSFS Subversion backend], something we highly recommend. 
+
+
+
+== Directory Structure ==
+{{{
+ EnvDir
+   |-- README
+   |-- VERSION
+   |-- attachments
+   |   |-- ticket
+   |   `-- wiki
+   |-- conf
+   |   `-- trac.ini
+   |-- db
+   |   `-- trac.db
+   |-- log
+   |   `-- trac.log
+   |-- templates
+   |   |-- site_css.cs
+   |   |-- site_footer.cs
+   |   `-- site_header.cs
+   `-- wiki-macros
+}}}
+
+ * '''README''' - Brief description of the environment.
+ * '''VERSION''' - Contains the environment version identifier.
+ * '''attachments''' - All attached files go in here.
+   * '''ticket''' - Ticket attachments.
+   * '''wiki''' - Wiki attachments.
+ * '''conf'''
+   * '''trac.ini''' - Main configuration file. See TracIni.
+ * '''db'''
+   * '''trac.db''' - SQLite database.
+ * '''templates''' - Custom (environment-specific) templates.
+   * '''site_css.cs''' - Custom CSS stylesheet.
+   * '''site_footer.cs''' - Custom footer.
+   * '''site_header.cs''' - Custom header.
+ * '''wiki-macros''' - Environment-specific WikiMacros.
+
+----
+See also: TracBackup, TracIni, TracGuide

wiki-default/TracGuide

-= The Trac User and Administration Guide =
-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://projects.edgewall.com/trac/ Trac Project] itself.
-
-== Table of Contents ==
-Currently available documentation:
- * TracGuide (This page)  -- Documentation starting point.
-   * TracInstall -- How to install and run Trac.
-   * TracAdmin -- Administrating a Trac project.
-   * TracIni -- Trac configuration file reference. 
-   * TracPermissions -- Access control and permissions.
-   * TracWiki -- How to use the built-in Wiki.
-   * TracBrowser -- Browsing source code with Trac.
-   * TracChangeset -- Viewing changes to source code.
-   * TracTickets -- Using the issue tracker.
-   * TracReports -- Writing and using reports.
-   * TracTimeline -- The timeline provides a historic perspective on a project.
-   * TracLogging -- The Trac logging facility.
-   * TracRss -- RSS content syndication in Trac.
-   * TracNotification -- Email notification.
-
- * [http://projects.edgewall.com/trac/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://projects.edgewall.com/trac/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.
-
-
-If you are interested in commercial support, please contact [http://www.edgewall.com/ Edgewall Software].
+= 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://projects.edgewall.com/trac/ Trac Project] itself.
+
+== Table of Contents ==
+Currently available documentation:
+ * TracGuide (This page)  -- Documentation starting point.
+   * TracInstall -- How to install and run Trac.
+   * TracUpgrade -- How to upgrade existing installations.
+   * TracMultipleProjects -- Multiple projects on a single host.
+   * TracAdmin -- Administrating a Trac project.
+   * TracImport -- Importing tickets from other bug databases.
+   * TracIni -- Trac configuration file reference. 
+   * TracPermissions -- Access control and permissions.
+   * TracWiki -- How to use the built-in Wiki.
+   * TracBrowser -- Browsing source code with Trac.
+   * TracChangeset -- Viewing changes to source code.
+   * TracTickets -- Using the issue tracker.
+   * TracReports -- Writing and using reports.
+   * TracQuery -- Executing custom ticket queries.
+   * TracRoadmap -- The roadmap helps tracking project progress.
+   * TracTimeline -- The timeline provides a historic perspective on a project.
+   * TracLogging -- The Trac logging facility.
+   * TracRss -- RSS content syndication in Trac.
+   * TracNotification -- Email notification.
+
+ * [http://projects.edgewall.com/trac/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://projects.edgewall.com/trac/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.
+
+If you are interested in commercial support, please [http://www.edgewall.com/contact/ contact Edgewall Software].

wiki-default/TracImport

+= Importing ticket data =
+
+== Bugzilla ==
+
+Ticket data can be imported from Bugzilla using the 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
+
+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 sourceforge2trac.py script, available in the contrib/ directory of the Trac distribution.

wiki-default/TracIni

 = trac.ini Reference =
-Trac 0.7 introduces an editable configuration file, ''trac.ini'', located in {{{<projectenv>/conf/trac.ini}}}.
+[[TracGuideToc]]
+
+Trac configuration is done by editing the ''trac.ini'' config file, located in {{{<projectenv>/conf/trac.ini}}}.
+
 This is a brief reference of available configuration options.
 
 == [project] ==
 || name   || Project name ||
 || descr  || Short project description ||
 || url    || URL to the main project website ||
+|| icon   || URL to icon file to use as shortcut icon (favicon) ||
 || footer || Page footer text (right-aligned) ||
 
 == [trac] ==
 || htdocs_location || Base URL for static Trac graphics and CSS files ||
 || database        || Database to use for this project ||
 || templates_dir   || Path of Clearsilver templates ||
+|| default_charset || Source files uses this charset ||
 
 == [logging] ==
 || log_type  || Logging facility to use. (none, file, stderr, syslog, winlog) ||
 || default_milestone || Default milestone for newly created tickets ||
 || default_component || Default component for newly created tickets ||
 
+See also: TracTicketsCustomFields
+
 == [attachment] ==
 || max_size || Maximum allowed file size for ticket and wiki attachments ||
 
-== [diff] ==
-|| tab_width || Displayed tab width in diffs (default is 8) ||
-
 == [notification] ==
 || smtp_enabled   || Enable SMTP (email) notification (true, false) ||
 || smtp_server    || SMTP server to use for email notifications ||
+|| smtp_from      || Sender address to use in notification emails ||
 || smtp_replyto   || Reply-To address to use in notification emails ||
 || smtp_always_cc || Email address(es) to always send notifications to ||
+|| always_notify_reporter || Always send notifications to any address in the ''reporter'' field ||
 
 See also: TracNotification
 
 
 == [mimeviewer] ==
 || enscript_path || Path to Enscript program ||
- 
+
+== [timeline] ==
+|| changeset_show_files || Number of files to show (-1 for unlimited, 0 to disable) ||
+
+== [diff] ==
+|| tab_width || Displayed tab width in changeset diffs ||
+
 [[BR]]
 ----
 See also: TracGuide, TracAdmin

wiki-default/TracInstall

-= Trac Installation Guide =
-
-The Trac web-based project management tool is implemented as a server
-side cgi-program. Trac is written in the Python programming language
-and uses SQLite as an embedded database. For HTML rendering, Trac uses the Clearsilver template system.
-
-
-== Requirements ==
-
-To install Trac, the following software packages must be installed:
-
- * [http://www.python.org/ Python], version >= 2.1.
-   * Please keep in mind, that for RPM-based systems you will also need python-devel and python-xml packages.
- * [http://subversion.tigris.org/ Subversion], version >= 0.37. (>=1.0.1 recommended)
- * [http://subversion.tigris.org/ Subversion Python bindings].
- * [http://pysqlite.sf.net/ PySQLite], version >= 0.4.3 (>= 0.5 for better performance)
- * [http://clearsilver.net/ Clearsilver], version >= 0.9.3
- * A CGI-capable web server (we QA-test on [http://httpd.apache.org/ Apache2] )
-
-== Installing Trac ==
-{{{
-$ python ./setup.py install
-}}}
-
-This will byte-compile the python source code and install it in the {{{site-packages}}} directory
-of your python installation. The directories {{{cgi-bin}}}, {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}} are all copied to $prefix/share/trac/ . 
-
-The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain project 
-environments. Trac-admin is the ''command center'' of Trac.
-
-'''Note:''' you'll need root permissions or equivalent for this step.
-
-For more information on installing Trac on specific platforms, see:
-
- * TracOnOsx
- * TracOnMandrakelinux
- * TracOnGentoo
- * TracOnFreeBsd
- * TracOnNetBsd
- * TracOnDebian
- * TracOnWindows
- * TracOnRedhat
-
-=== Advanced Users ===
-To install Trac in a different location, and other advanced installation options, run:
-{{{
-$ python ./setup.py --help
-}}}
-
-== Creating a Project Environment ==
-
-''Trac Environment'' is the backend storage format where Trac stores
-information like wiki pages, tickets, reports, settings, etc.
-A Trac environment consist of a directory containing an SQLite database, 
-human-readable configuration file, log-files and attachments.
-
-A new Trac environment is created with {{{trac-admin}}}:
-
-{{{
-$ trac-admin /path/to/projectenv initenv
-}}}
-'''Note:''' The web server user need write permission to the environment
-directory and all the files inside.
-
-[wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and
-where it can find the trac templates directory (the default value should be fine).
-
-== Configuring Apache ==
-
-Copy (or symlink) "{{{trac/cgi-bin/trac.cgi}}}" to 
-you web servers {{{/cgi-bin/}}} directory. You can also configure apache
-to use the "{{{trac/cgi-bin/}}}" directory directly if you like, it's a matter of taste.
-
-Finally edit the apache config and add this config snippet, with filenams edited to match your installation:
- 
-{{{
-Alias /trac/ "/usr/share/trac/htdocs/" #or where you installed the trac docs
-#You have to allow people to read the files in htdocs
-<Directory "/usr/share/trac/htdocs/">
-	Options Indexes MultiViews
-	AllowOverride None
-	Order allow,deny
-	Allow from all
-</Directory>
-
-
-# Trac need to know where the database is located
-<Location "/cgi-bin/trac.cgi">
-	SetEnv TRAC_ENV "/path/to/projectenv"
-</Location>
-
-# You need this to allow users to authenticate
-# trac.htpasswd can be created with 
-# cmd 'htpasswd -c trac.htpasswd' (UNIX)
-# do 'man htpasswd' to see all the options
-<Location "/cgi-bin/trac.cgi/login">
-	AuthType Basic
-	AuthName "trac"
-	AuthUserFile /somewhere/trac.htpasswd
-	Require valid-user
-</location>
-}}}
-
-'''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project.
-
-== Using Trac ==
-
-You should now have a working Trac installation at:
-
-http://<yourhostname>/cgi-bin/trac.cgi
-
-There you should be able to browse your subversion repository, create tickets,
-view the timeline etc. Keep in mind that anonymous users (not logged in)
-can only access a restricted subset of all Trac features. 
-
-Please continue to TracPermissions to learn how to grant additional privileges to authenticated users.
-
-For further user-documentation, see TracGuide.
-
-''Enjoy!''
-
-----
-See also:  TracGuide, TracPermissions, TracOnFreeBsd, TracOnNetBsd, TracOnOsx, TracOnMandrakelinux, TracOnDebian, TracOnGentoo
+= Trac Installation Guide =
+[[TracGuideToc]]
+
+The Trac web-based project management tool is implemented as a CGI- or standalone program. Trac is written in the [http://www.python.org/ Python] programming language
+and uses the [http://www.sqlite.org/ SQLite] embedded database for persistant storage. For HTML rendering, Trac uses the [http://www.clearsilver.net/ Clearsilver] template system.
+
+
+== Requirements ==
+
+To install Trac, the following software packages must be installed:
+
+ * [http://www.python.org/ Python], version >= 2.1 (>=2.3 recommended).
+   * Please keep in mind, that for RPM-based systems you will also need python-devel and python-xml packages.
+ * [http://subversion.tigris.org/ Subversion], version >= 1.0. (>=1.1 recommended)
+ * [http://svnbook.red-bean.com/svnbook-1.1/ch08s02.html#svn-ch-8-sect-2.3 Subversion Python bindings] (Caveat: Trac uses the [http://www.swig.org/ SWIG] bindings included in the Subversion distribution,  '''not''' the  [http://pysvn.tigris.org/ PySVN] package!)
+ * [http://www.sqlite.org/ SQLite], version 2.8.x or 3.0.x
+ * [http://pysqlite.sf.net/ PySQLite], version >= 0.5 but < 1.1.0 (for SQLite 2.8.x), version >= 1.1.1 (for SQLite 3.0.x) 
+ * [http://clearsilver.net/ Clearsilver], version >= 0.9.3
+ * [http://docutils.sourceforge.net/ docutils], version >= 0.3.3 (??)
+ * A CGI-capable web server (tested on [http://httpd.apache.org/ Apache] )
+
+=== Optional Packages ===
+
+ * [http://www.modpython.org/ mod_python] (see TracModPython)
+
+== Installing Trac ==
+Like most Python programs, install the Trac python modules by running the following command at the top of the source directory:
+{{{
+$ python ./setup.py install
+}}}
+
+This will byte-compile the python source code and install it in the {{{site-packages}}} directory
+of your python installation. The directories {{{cgi-bin}}}, {{{templates}}}, {{{htdocs}}} and {{{wiki-default}}} are all copied to $prefix/share/trac/ . 
+
+The script will also install the [wiki:TracAdmin trac-admin] command-line tool, used to create and maintain [wiki:TracEnvironment project environments]. 
+
+The [wiki:TracAdmin trac-admin] program is the ''control center'' for Trac.
+
+'''Note:''' you'll need root permissions or equivalent for this step.
+
+For more information on installing Trac on specific platforms, see the [http://projects.edgewall.com/trac/wiki/TracInstallPlatforms TracInstallPlatforms] page (on the main project web site).
+
+=== Advanced Users ===
+To install Trac in a custom location, and view other advanced install options, run:
+{{{
+$ python ./setup.py --help
+}}}
+
+== Creating a Project Environment ==
+
+TracEnvironment is the backend storage format where Trac stores
+information like wiki pages, tickets, reports, settings, etc.
+An environment consist of a directory containing an SQLite database, 
+human-readable configuration file, log-files and attachments.
+
+A new Trac environment is created using [wiki:TracAdmin trac-admin], like:
+
+{{{
+$ trac-admin /path/to/projectenv initenv
+}}}
+
+[wiki:TracAdmin trac-admin] will ask you where your subversion repository is located and
+where it can find the trac templates directory (the default value should work for a typical install).
+
+'''Note:''' The web server user will require file system write permission to the environment
+directory and all the files inside. '''Remember to set the appropriate permissions.''
+
+The same applies for the subversion repository files (unless using the [http://svn.collab.net/repos/svn/trunk/notes/fsfs FSFS Subversion backend], something we highly recommend. 
+
+== Configuring Apache ==
+
+Make "{{{trac/cgi-bin/trac.cgi}}}" accessible to your web server at {{{/cgi-bin/}}}, either by copying/symlinking or use the "{{{trac/cgi-bin/}}}" directory directly.
+
+Edit the apache config and add this snippet, filenames edited to match your installation:
+ 
+{{{
+Alias /trac/ "/usr/share/trac/htdocs/" #or where you installed the trac htdocs
+#You have to allow people to read the files in htdocs
+<Directory "/usr/share/trac/htdocs">
+	Options Indexes MultiViews
+	AllowOverride None
+	Order allow,deny
+	Allow from all
+</Directory>
+
+
+# Trac need to know where the database is located
+<Location "/cgi-bin/trac.cgi">
+	SetEnv TRAC_ENV "/path/to/projectenv"
+</Location>
+
+# You need this to allow users to authenticate
+# trac.htpasswd can be created with 
+# cmd 'htpasswd -c trac.htpasswd' (UNIX)
+# do 'man htpasswd' to see all the options
+<Location "/cgi-bin/trac.cgi/login">
+	AuthType Basic
+	AuthName "trac"
+	AuthUserFile /somewhere/trac.htpasswd
+	Require valid-user
+</Location>
+}}}
+
+'''Note:''' If Apache complains about the Set''''''Env line make sure you have the Load''''''Module for mod_env uncommented (Apache 1.3).
+
+'''Note:''' When creating a new environment, {{{trac-admin}}} will print a config snippet customized for your project.
+
+'''Note:''' If you are using [http://httpd.apache.org/docs/suexec.html Apache suEXEC] feature see [http://projects.edgewall.com/trac/wiki/ApacheSuexec ApacheSuexec] (on the project web site).
+
+== Using Trac ==
+
+'''Congratulations!''' You should now have a running Trac installation at:
+
+http://<yourhostname>/cgi-bin/trac.cgi
+
+You should be able to browse your subversion repository, create tickets,
+view the timeline and use all the features of Trac.
+
+Keep in mind that anonymous users (not logged in) can only access a restricted subset of all Trac features by default. 
+
+'''Note:''' If you don't want long, and relatively ugly, URLs, you can prettify them by changing your Apache config. See [http://projects.edgewall.com/trac/wiki/TracPrettyUrls TracPrettyUrls] (on the project website).
+
+Please continue to TracPermissions to learn how to grant additional privileges to authenticated users.
+
+For user documentation, see TracGuide.
+
+''Enjoy!''
+
+[http://projects.edgewall.com/trac/wiki/TracTeam The Trac Team]
+
+----
+See also:  TracGuide, TracUpgrade, TracPermissions, TracInstallPlatforms, TracModPython

wiki-default/TracInstallPlatforms

+= Platform-specific Documentation =
+This is an index of pages describing how to install and run Trac on specific platforms and operating systems.
+
+All pages are on the [http://projects.edgewall.com/trac/wiki/TracProject TracProject] website, since they tend to be edited quite often.
+
+ * [http://projects.edgewall.com/trac/wiki/TracOnOsx TracOnOsx]
+ * [http://projects.edgewall.com/trac/wiki/TracOnMandrakelinux TracOnMandrakelinux]
+ * [http://projects.edgewall.com/trac/wiki/TracOnGentoo TracOnGentoo]
+ * [http://projects.edgewall.com/trac/wiki/TracOnFreeBsd TracOnFreeBsd]
+ * [http://projects.edgewall.com/trac/wiki/TracOnNetBsd TracOnNetBsd]
+ * [http://projects.edgewall.com/trac/wiki/TracOnDebian TracOnDebian]
+ * [http://projects.edgewall.com/trac/wiki/TracOnWindows TracOnWindows]
+ * [http://projects.edgewall.com/trac/wiki/TracOnWindowsIis TracOnWindowsIis]
+ * [http://projects.edgewall.com/trac/wiki/TracOnWindowsIis6 TracOnWindowsIis6]
+ * [http://projects.edgewall.com/trac/wiki/TracOnRedhat TracOnRedhat]
+ * [http://projects.edgewall.com/trac/wiki/TracOnFedoraCore TracOnFedoraCore]
+ * [http://projects.edgewall.com/trac/wiki/TracOnSuSE TracOnSuSE]
+ * [http://projects.edgewall.com/trac/wiki/TracOnSlackware TracOnSlackware]
+
+----
+See also: TracInstall, TracGuide, [http://projects.edgewall.com/trac/wiki/TracFaq TracFaq]

wiki-default/TracLogging

-= Trac Logging =
-Trac supports logging of system messages using the standard ''logging'' module part of Python 2.3 and newer.
-
-== Supported Methods ==
- * '''none''' -- Suppress all log messages.
- * '''file''' -- Log messages to a file, specified in the [wiki:TracConfiguration configuration] (Using the ''log_file'' directive in [wiki:TracIni trac.ini]). 
- * '''stderr''' -- Output all log entries to console. (tracd only)
- * '''syslog''' -- (UNIX) Send messages to local syslogd via named pipe '/dev/log'.
- * '''winlog''' -- (Windows) Use the system's NT eventlog for Trac logging.
-
-== Log Levels ==
-The level of verbosity of logged messages can be set using the ''log_level'' directive in [wiki:TracIni trac.ini]. The log level defines the minimum level of urgency required for a message to be logged.
-
-The levels are:
- * ''CRITICAL'' -- Log only the most critical, typically fatal, messages.
- * ''ERROR'' -- Request failures, bugs and errors. 
- * ''WARN'' -- Warnings, non-interrupting events.
- * ''INFO'' -- Diagnostic information, log information about all requests.
- * ''DEBUG'' -- Development messages, profiling, etc. Not for public consumption.
-
-----
-See also: TracIni, TracGuide
+= Trac Logging =
+[[TracGuideToc]]
+
+Trac supports logging of system messages using the standard ''logging'' module part of Python 2.3 and newer.
+
+'''Note:''' If you are using a Python version older than 2.3, the Trac logging mechanism will be silently disabled.
+
+Logging is configured in the {{{[logging]}}} section in [wiki:TracIni trac.ini].
+
+== Python 2.2 Workaround ==
+If you are using Python 2.2, however, note that the logging package from Python 2.3 works perfectly under 2.2 as well; you can just copy the entire {{{logging}}} directory from the Python 2.3 library into the Python 2.2 lib directory. Perhaps not the most elegant solution, but it works.
+
+
+== Supported Logging Methods ==
+ * '''none''' -- Suppress all log messages.
+ * '''file''' -- Log messages to a file, specified with the ''log_file'' directive in [wiki:TracIni trac.ini]. 
+ * '''stderr''' -- Output all log entries to console ([wiki:TracStandalone tracd] only).
+ * '''syslog''' -- (UNIX) Send messages to local syslogd via named pipe '/dev/log'.
+ * '''winlog''' -- (Windows) Use the system's NT eventlog for Trac logging.
+
+== Log Levels ==
+The level of verbosity of logged messages can be set using the ''log_level'' directive in [wiki:TracIni trac.ini]. The log level defines the minimum level of urgency required for a message to be logged.
+
+The levels are:
+ * ''CRITICAL'' -- Log only the most critical, typically fatal, messages.
+ * ''ERROR'' -- Request failures, bugs and errors. 
+ * ''WARN'' -- Warnings, non-interrupting events.
+ * ''INFO'' -- Diagnostic information, log information about all requests.
+ * ''DEBUG'' -- Development messages, profiling, etc. Not fit for human consumption.
+
+----
+See also: TracIni, TracGuide, TracEnvironment

wiki-default/TracModPython

+= Trac and mod_python =
+
+Trac 0.7.1 and later supports [http://www.modpython.org/ mod_python], which speeds up Trac's response times considerably and permits use of many Apache features not possible with tracd/mod_proxy.
+
+== Simple configuration ==
+
+Here's a typical Trac CGI/Apache setup:
+
+{{{
+ScriptAlias /projects/myproject /path/to/python/share/trac/cgi-bin/trac.cgi
+<Location /projects/myproject>
+   SetEnv TRAC_ENV /var/trac/myproject
+</Location>
+}}}
+
+The equivalent mod_python setup is:
+
+{{{
+<Location /projects/myproject>
+   SetHandler mod_python
+   PythonHandler trac.ModPythonHandler
+   PythonOption TracUriRoot "/projects/myproject"
+   PythonOption TracEnv /var/trac/myproject
+</Location>
+}}}
+
+Note that the option ''TracUriRoot'' may or may not be necessary in your setup. Try without first, and if the URLs produced by Trac look wrong, add the ''TracUriRoot'' option.
+
+== Setting up multiple projects ==
+
+The Trac mod_python handler handler supports a configuration option similar to Subversion's {{{SvnParentPath}}}, called {{{TracEnvParentDir}}}:
+
+{{{
+<Location /projects>
+  SetHandler mod_python
+  PythonHandler trac.ModPythonHandler
+  PythonOption TracUriRoot /projects
+  PythonOption TracEnvParentDir "/var/trac"
+</LocationMatch>
+}}}
+
+When you request the {{{/projects}}} URL, you will get a (currently very simple) listing of all subdirectories of the directory you set as {{{TracEnvParentDir}}}. Selecting any project in the list will bring you to the corresponding Trac instance. You should make sure that the configured directory only contains Trac environment directories that match the currently installed Trac version, because that is not checked prior the the generation of the project list.
+
+
+=== Adding authentication ===
+
+Adding authentication is straightforward in both cases. For example:
+
+{{{
+<LocationMatch /projects/[[:alnum:]]+/login>
+  AuthType Basic
+  AuthName "Trac"
+  AuthUserFile /var/www/passwd
+  Require valid-user
+</LocationMatch>
+}}}
+
+=== Win32 Issues ===
+
+If you run trac with mod_python on Windows, attachments will not work.
+
+There is a (simple) workaround for this which is to apply the patch attached to 
+ticket [http://projects.edgewall.com/trac/ticket/554 #554].
+
+
+----
+See also TracGuide, TracInstall, TracMultipleProjects

wiki-default/TracMultipleProjects

+= Configure Apache for multiple projects =
+
+By following these instructions, you will set up Apache to automatically serve multiple Trac projects for you. 
+
+Start out by creating a project directory in your documentroot (/var/www in this example). Projects will be accessed as http://hostname/projects/projectname. Copy (or symlink) trac.cgi to this directory together with a file named index.html. This will be shown when users try to access nonexistent projects.
+
+Then create your trac projects with trac-admin. It's important that they are all placed in the same directory. In this example we'll use /var/lib/trac. Add to your Apache configuration:
+
+{{{
+RewriteEngine on
+RewriteRule ^/projects/+$			/projects/index.html [L]
+RewriteCond /var/lib/trac/$1			-d
+RewriteRule ^/projects/([[:alnum:]]+)(/?.*)	/projects/trac.cgi$2 [S=1,E=TRAC_ENV:/var/lib/trac/$1]
+RewriteRule ^/projects/(.*)			/projects/index.html
+
+<Directory "/var/www/projects">
+	AllowOverride None
+	Options ExecCGI -MultiViews +SymLinksIfOwnerMatch
+	AddHandler cgi-script .cgi
+	Order allow,deny
+	Allow from all
+</Directory>
+
+<LocationMatch "/projects/[[:alnum:]]+/login">
+	AuthType Basic
+	AuthName "trac"
+	AuthUserFile /path/to/trac.htpasswd
+	Require valid-user
+</LocationMatch>
+}}}
+
+Make sure you have the rewrite module loaded or compiled in Apache.
+
+{{{LoadModule rewrite_module modules/mod_rewrite.so}}}
+
+Now, when you add another project, you don't need to edit any apache config. The only file you may want to edit is index.html to make it list the new project. If you think this is too much work, replace it with a python cgi script that does it for you.
+
+[wiki:TracStandalone tracd] and TracModPython can also serve multiple projects.
+
+
+----
+See also: TracGuide, TracInstall

wiki-default/TracNotification

-= Email Notification of Ticket Changes =
-Trac supports automatic email notification upon ticket changes. 
-
-'''Note:''' This feature is disabled by default, and must be configured to be activated.
-
-== Receiving Notification ==
-When reporting a new ticket or adding a comment, if you enter a valid email address in the ''reporter'', ''editor'' or ''cc'' field, you will automatically receive an email upon future changes to the ticket.
-
-This is useful to keep up-to-date on an issue or enhancement request that interests you.
-
-== Configuring SMTP Notification ==
-
-=== Config Options ===
-These are the available options for the ''[notification]'' section in trac.ini.
- * '''smtp_enabled''': Enable notification.
- * '''smtp_server''': SMTP server used for notification messages.
- * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails.
- * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
-
-=== Example Configuration ===
-
-{{{
-[notification]
-smtp_enabled = true
-smtp_server = mail.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/>
-}}}
-----
-See also: TracTickets
+= Email Notification of Ticket Changes =
+[[TracGuideToc]]
+
+Trac supports basic notification for ticket changes using email. 
+
+Email notification is useful to keep users up-to-date on tickets/issues of interest, and also provides a convenient way to post ticket changes to a dedicated mailing list. '''Note:''' As an example, this is how the [http://lists.edgewall.com/archive/trac-tickets/ Trac-tickets] mailing list works.
+
+Disabled by default, notification can be activated and configured in [wiki:TracIni trac.ini].
+
+== Receiving Notification ==
+When reporting a new ticket or adding a comment, enter a validing email address in the ''reporter'', ''editor'' or ''cc'' field. Trac will automatically send you an email when changes are made to the ticket.
+
+This is useful to keep up-to-date on an issue or enhancement request that interests you.
+
+== Configuring SMTP Notification ==
+
+=== Config Options ===
+These are the available options for the ''[notification]'' section in trac.ini.
+ * '''smtp_enabled''': Enable notification.
+ * '''smtp_server''': SMTP server used for notification messages.
+ * '''smtp_from''': Email address to use for ''Sender''-headers in notification emails.
+ * '''smtp_replyto''': Email address to use for ''Reply-To''-headers in notification emails.
+ * '''smtp_always_cc''': List of email addresses to always send notifications to. ''Typically used to post ticket changes to a dedicated mailing list.''
+ * '''always_notify_reporter''':  Always send notifications to any address in the reporter field.
+
+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/>
+}}}
+----
+See also: TracTickets, TracIni, TracGuide

wiki-default/TracOnDebian

-= Installing and Running Trac on Debian =
-
-== Notes from a debian sarge install ==
-
-As has been previously pointed out, a Debian package does not exist, hence you need to build it yourself. This isn't ''too'' onerous if you know where you might get bitten. Hopefully the following should be of some use.
-
-'''Warning''': The instructions within will modify your system from the standard Debian install. Some packages will be pulled from the unstable distribution, and some packages are installed manually on your system. This may make it difficult to uninstall the software, or upgrade it in the future as Debian packages arrive. But for what it's worth, this setup seems to work fine.
-
-First you need the SQLite, Subversion and the related python modules. Note that you need to use the version of subversion from unstable. Don't worry as Debians unstable is not really unstable, it's about as stable as typical redhat packages.
-
-You might want to use apt-pinning, which is basically a way of stopping unstable dependancies from getting installed all over the place (try this [http://jaqque.sbih.org/kplug/apt-pinning.html guide for beginners]). Create or edit '''{{{/etc/apt/preferences}}}''' and insert
-
-{{{
-Package: *
-Pin: release a=testing
-Pin-Priority: 650
-                                                                                                
-Package: *
-Pin: release a=unstable
-Pin-Priority: 600
-}}}
-
-You'll also need to add unstable to the '''{{{/etc/apt/sources.list}}}'''
-
-{{{
-deb http://security.debian.org/ stable/updates main
-deb http://ftp.uk.debian.org/debian/ testing non-free
-deb http://ftp.uk.debian.org/debian/ testing contrib
-deb http://ftp.uk.debian.org/debian/ testing main
-deb http://ftp.uk.debian.org/debian/ unstable main
-}}}
-
-Thats what mine looks like
-
-{{{
-apt-get install sqlite python2.3-subversion python2.3-sqlite 
-apt-get -t unstable install subversion
-}}}
-
-Clearsilver isn't available as a package so get clearsilver from http://www.clearsilver.net/ (tested [http://www.clearsilver.net/downloads/clearsilver-0.9.8.tar.gz 0.9.8])
-
-{{{
-tar xvfz clearsilver-0.9.8.tar.gz
-cd clearsilver-0.9.8
-./configure
-make
-make install
-cd python/
-ln -s /usr/bin/python2.3 /usr/bin/python
-make
-make install
-}}}
-
-This should then allow you to build and initialise trac.
-
-Note:  I found I needed to change the first line in scripts/document.py from '#!/usr/local/bin/python' to '#!/usr/bin/python' --Tom Hoffman
-
-When you come to running it though you'll also have to add the env_module using the following line in your '''{{{/etc/apache/modules.conf}}}'''
-
-{{{
-LoadModule env_module /usr/lib/apache/1.3/mod_env.so
-}}}
-
-I then set up a trac.conf in my '''{{{/etc/apache/conf.d}}}''' folder like so
-
-{{{
-<VirtualHost local.trac>
-    alias /trac/ "/usr/share/trac/htdocs/"
-    ServerAdmin youremail@yourdomain.tld
-    DocumentRoot /home/tim/myTrac
-    ServerName local.trac
-    ErrorLog /home/tim/myTrac/logs/error.log
-    CustomLog /home/tim/myTrac/logs/access_log common
-    AddHandler cgi-script cgi
-    <Location "/cgi-bin/trac.cgi">
-      SetEnv TRAC_DB "/home/tim/myTrac/tracdb/mydb"
-      Options FollowSymLinks +ExecCGI
-      AllowOverride None
-    </Location>
-</VirtualHost>
-}}}
-Don't forget to create those log folders though (apachectl configtest doesn't warn you about that one)
-
-
-
-

wiki-default/TracOnFreeBsd

-= Installing Trac on FreeBSD =
-
-Kuei-Feng Li, Rui Lopes and Pav Lucistnik kindly [http://www.freebsd.org/cgi/query-pr.cgi?pr=ports/65690 added] Trac to the [http://www.freebsd.org/ FreeBSD] ports collection.
-
-For more information:
- * http://www.freebsd.org/ports/
- * http://www.freebsd.org/cgi/cvsweb.cgi/ports/www/trac/
-
-= Having trouble using the ports ? =
-
-You may have to use some additional ports from [http://www.freshports.org freshports].
-I found these ones useful:
-
- * [http://www.freshports.org/devel/subversion-python subversion-python]
- * [http://www.freshports.org/www/clearsilver-python clearsilver-python]
- * [http://www.freshports.org/www/clearsilver clearsilver]
-
-Just add them to your /usr/ports tree before using the trac port mentioned above.

wiki-default/TracOnGentoo

-= Installing and Running Trac on Gentoo =
-
-Trac 0.6.1 is included in portage as of 2004/04/29.  The current ebuild is marked with ~x86, so you will have to emerge with ACCEPT_KEYWORDS=~x86 set, or include the following in your /etc/portage/package.keywords:
-
-{{{
-  net-www/trac ~x86
-}}}
-
-You may need to do the same thing for clearsilver because currently, clearsilver only has ~x86 ebuilds in the main portage tree.  Once that is done, installing is as simple as:
-
-{{{
-  emerge trac
-}}}
-
-Past that, normal Trac configuration should apply.

wiki-default/TracOnMandrakelinux

-= Installing and Running Trac on Mandrakelinux Cooker =
-
-Trac is included in [http://www.mandrakelinux.com Mandrakelinux ] contributions repository, only for cooker for the moment.
-It should be avaliable through urpmi or rpmdrake, if you have the proper source in you configuration file.
-
-{{{
-# urpmi trac
-}}}
-
-Once Trac is installed, you can use trac-admin to add a repository, and use the example config file provided to start using Trac.
-
-See also:
- * http://www.urpmi.org/
- * http://cvs.mandrakesoft.com/cgi-bin/cvsweb.cgi/contrib-SPECS/trac/
- * Easy URPMI: http://urpmi.org/easyurpmi. Choose version=cooker and source=contrib.

wiki-default/TracOnNetBsd

-= Installing and Running Trac on NetBSD =
-
-epg has kindly added Trac to the [http://www.netbsd.org/ NetBSD] package collection.
-
-It should install without trouble.
-
-See also:
- * http://www.netbsd.org/Documentation/software/packages.html
- * http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/www/trac/

wiki-default/TracOnOsx

-= Installing and running Trac on Mac OSX =
-
-Fink (http://fink.sf.net/) can be used to install most of Trac's dependencies:
-{{{
- $ apt-get install sqlite
- $ apt-get install svn-client svn-swig-py23
-}}}
-
-If you need to use a secure protocol with subversion, you need to install the -ssl variants:
-{{{
- $ apt-get install svn-client-ssl svn-ssl-swig-py23
-}}}
-
-The last two dependencies (pysqlite and clearsilver) can't be installed using fink, 
-you have to download and install them manually.
-
-== Clearsilver ==
-
-Download latest version from http://www.clearsilver.net/. Compile it with Python 
-support and install it in the fink prefix.
-{{{
- $ ./configure --prefix=/sw/ --with-python=/sw/bin/python2.3
- $ make install
-}}}
-You might have to modify some some hard coded /usr/local/bin/python path to /sw/bin/python2.3 
-in some file when running {{{make install}}}.
-
-== pysqlite ==
-
-The file {{{setup.py}}} in the pysqlite distribution doesn't recognize the darwin platform so you'll
-have to add the following lines to {{{setup.py}}} (it should be quite obvious where):
-{{{
-elif sys.platform == "darwin":
-    include_dirs = ['/sw/include/']
-    library_dirs = ['/sw/lib/']
-    libraries = [sqlite]
-    runtime_library_dirs = []
-    extra_objects = []
-}}}
-
-After that modification the installation should simply be:
-{{{
- $ /sw/bin/python2.3 ./setup.py install
-}}}
-
-== Installing Trac itself ==
-
-You should now be all set to install Trac using the TracInstall instructions. Make sure to use
-{{{/sw/bin/python2.3}}} when running the {{{setup.py}}} script.
-
-I had some problems getting apples personal web-server (apache 1.3) to run trac.cgi with the correct
-python interpreter (/sw/bin/python2.3) so I placed this dummy {{{trac.cgi}}} in
-{{{/Library/WebServer/CGI-Executables/}}}:
-{{{
-#! /bin/sh
-/sw/bin/python2.3 /somewhere/cgi-bin/trac.cgi
-}}}
-
-
-Keep in mind that these instructions were written from the top of my mind and might be
-incomplete and contain some errors. If you find any errors please correct them by
-editing this page and/or contacting me -- [http://projects.edgewall.com/trac/wiki/JonasBorgstrom JonasBorgstrom]
-
-== Alternative install method: pkgsrc ==
-
-As an alternative to fink and compiling by hand, you can install from pkgsrc (http://www.netbsd.org/Documentation/software/packages.html).  Yes, pkgsrc runs on Mac OS X just as well as it runs on NetBSD or Linux.
-
-See TracOnNetBsd for more information.

wiki-default/TracOnRedhat

-You can get packages for either Redhat or Fedora Core from:
-
-http://dag.wieers.com/packages/trac/
-
-Installation using either apt-rpm or yum is supported.

wiki-default/TracOnWindows

-== Windows Installation instructions for SVN w/TRAC ==
-
-Versions used in this example (Available 2004-05-13):
- * Apache 2.0.49
- * Python 2.3.3
- * SVN 1.0.2
- * SQLite 2.8.13
- * PySQLite 0.5.0-py2.3
- * Trac 0.6.1
-
-Email [mailto:Daragh@i2i-Tech.com Daragh Fitzpatrick] for more info, 
-or if you changed this page (since this Wiki does not support watch/subscription)
-----
-Note: This example installs to D:
-
-=== Arm Yourself ===
-1. Get & Read book
-  http://svnbook.red-bean.com
-
-=== Install SubVersioN Pre-Requisites ===
-2. Install Python
-  http://www.python.org
-  [[br]]Add D:\Python to path
-
-3. Install Apache
-  http://httpd.apache.org
-
-4. Install Subversion
-  http://subversion.tigris.org
-
-=== Create Repository ===
-5. Create Repository Directory
-{{{
-D:\> md d:\svn
-}}}
-
-6. Create Repository
-{{{
-D:\> svnadmin create d:\svn\repo1
-}}}
-
-7. Create skeleton repository structure in d:\temp\project
-  Example:
-{{{
-/project
-  /vendor
-    /tags
-    /trunk
-      files
-  /projectname
-    /branches
-    /tags
-    /trunk
-      files
-}}}
-
-8. Build Repository Tree
-{{{
-D:\> svn import d:\temp\project file:///d:/svn/repo1 -m "Initial Load"
-}}}
-
-9. Create local sandbox
-{{{
-D:\> svn checkout file:///d:/svn/repo1 d:\project
-}}}
-
-=== Configure Apache ===
-
-10. Copy files
-{{{
-D:\> copy d:\progra~1\subver~1\httpd\*.* d:\progra~1\apache~1\apache2\modules
-}}}
-
-11. Create password file (w/user 'admin')
-{{{
-D:\> d:\progra~1\apache~1\apache2\bin\htpasswd -cm d:\svn\.htaccess admin
-}}}
-
-12. Configure Apache (edit httpd.conf)
-  12.1. Restrict access/lockdown as appropriate
-
-  12.2. Add Modules to httpd.conf
-
-    12.1.1. Uncomment:
-{{{
-LoadModule dav_module modules/mod_dav.so
-}}}
-    12.1.2. Add (after):
-{{{
-# Subversion
-LoadModule dav_svn_module modules/mod_dav_svn.so
-}}}
-
-  12.3. Add location root for multiple repositories
-{{{
-# Subversion
-<Location /svn>
-  DAV svn
-  # any /svn/foo URL will map to a repository D:/svn/foo
-  SVNParentPath D:/svn
-  AuthType Basic
-  AuthName "Subversion repository"
-  AuthUserFile d:/svn/.htaccess
-  Require valid-user
-</Location>
-}}}
-
-13. Restart your MACHINE
-
-14. Test your install of Subversion
-  http://[hostname]:80/svn/repo1
-
-Phew! Subversion is installed and working - Grab a beverage for yourself.
-----
-
-=== Setup Users ===
-15. Add users to password file
-{{{
-D:\> d:\progra~1\apache~1\apache2\bin\htpasswd -m d:\svn\.htaccess user
-}}}
-
-=== Install TRAC Prerequisites ===
-16. Install Subversion Python Bindings
-  (Get from same download page as Subversion)
-  [[br]]Copy libsvn and svn directories to D:\Python23\Lib
-
-17. Install SQLite
-  http://www.sqlite.org
-  [[br]]Copy sqlite.exe to D:\Program Files\SQLite
-
-18. Install PySQLite
-  http://pysqlite.sourceforge.net
-
-19. Install TRAC
-  http://www.edgewall.com/products/trac/
-
-=== Fix a few things ===
-20. (BUG) Edit first line of D:\Python23\Scripts\trac-admin to have: 
-{{{
-
-#!D:\Python23\python.exe
-}}}
-
-21. (BUG) Edit first line of D:\Python23\share\trac\cgi-bin\trac.cgi to have: 
-{{{
-
-#!D:\Python23\python.exe
-}}}
-
-22. Copy CGI
-{{{
-D:\> copy d:\python23\share\trac\cgi-bin\trac.cgi d:\progra~1\apache~1\apache2\cgi-bin
-}}}
-
-23. (BUG) not able to run trac-admin initenv...  Not available in 0.6.1
-
-=== Configure TRAC DB ===
-
-24. Run trac-admin 
-{{{
-D:\Python23\Scripts> python trac-admin d:/svn/trac.db
-}}}
-
-25. Initialize DB
-{{{
-Trac [d:/svn/trac.db]> initdb
-}}}
-{{{
-  Enter project name
-    Project
-  Enter path to repository
-    d:\svn\repo1
-  Enter path to templates
-    d:\Python23\share\trac\templates
-  (BUG) Note error message regarding wiki-pages
-}}}
-
-26. (BUG) Load Wiki
-{{{
-Trac [d:/svn/trac.db]> wiki load d:/python23/share/trac/wiki-default
-}}}
-
-27. Add administrative permissions
-{{{
-Trac [d:/svn/trac.db]> permission add admin TICKET_ADMIN
-Trac [d:/svn/trac.db]> permission add admin REPORT_CREATE
-Trac [d:/svn/trac.db]> permission add admin REPORT_MODIFY
-Trac [d:/svn/trac.db]> permission add admin REPORT_DELETE
-Trac [d:/svn/trac.db]> permission add admin REPORT_ADMIN
-Trac [d:/svn/trac.db]> permission add admin WIKI_DELETE
-Trac [d:/svn/trac.db]> permission add admin WIKI_ADMIN
-Trac [d:/svn/trac.db]> permission add admin CONFIG_VIEW
-Trac [d:/svn/trac.db]> permission add admin TRAC_ADMIN
-}}}
-
-=== Add TRAC to Apache ===
-
-28. Edit httpd.conf:
-  Add: (copy this - there's a typo in Edgewall's version)
-{{{
-# TRAC
-Alias /trac "D:/Python23/share/trac/htdocs"
-<Directory "D:/Python23/share/trac/htdocs">
-  Options Indexes MultiViews
-  AllowOverride None
-  Order allow,deny
-  Allow from all
-</Directory>
-
-<Location "/cgi-bin/trac.cgi">
-  SetEnv TRAC_DB "d:/svn/trac.db"
-</Location>
-
-<Location "/cgi-bin/trac.cgi/login">
-  AuthType Basic
-  AuthName "Project"
-  AuthUserFile D:/svn/.htaccess
-  Require valid-user
-</Location>
-}}}
-
-29. Restart Apache
-
-30. Hold your breath, test TRAC install
-  http://[hostname]:80/cgi-bin/trac.cgi
-
-=== Finally... ===
-31. Install SVN Clients as necessary (try [http://rapidsvn.tigris.org Rapid SVN] & [http://tortoisesvn.tigris.org/ Tortoise SVN])
-
-32. Don't forget to lock down the security on the box!
-
-33. Now go get a *real* drink
-----
-Email [mailto:Daragh@i2i-Tech.com Daragh Fitzpatrick] with any questions!
-----

wiki-default/TracPermissions

 == Trac Permissions ==
+[[TracGuideToc]]
 
-Trac uses a flexible permission system to control what different users can do
-in the system.
+Trac uses a simple but flexible permission system to control what users can and can't access.
 
-When a user first uses a system he/she will be able to do certain things. 
-Exactly what he/she can do depend on which privileges you have granted to
-the special user {{{anonymous}}}.
-In addition to these privileges different users can be granted additional 
-rights as soon as they login into the system.
+Permission privilegies are managed using the [wiki:TracAdmin trac-admin] tool.
+
+Regular visitors, non-authenticated users, accessing the system are assigned the default 
+role (''user'') named {{{anonymous}}}. 
+Assign permissions to the {{{anonymous}}} user to set privilegies for non-authenticated/guest users.
+
+In addition to these privileges users can be granted additional individual 
+rights in effect when authenticated and logged into the system.
 
 === Available privileges ===
 
  * {{{CHANGESET_VIEW}}}
  * {{{BROWSER_VIEW}}}
  * {{{TICKET_VIEW, TICKET_CREATE, TICKET_MODIFY, TICKET_ADMIN}}}
- * {{{REPORT_VIEW, REPORT_CREATE, REPORT_MODIFY, REPORT_DELETE, REPORT_ADMIN}}}
+ * {{{REPORT_VIEW, REPORT_CREATE, REPORT_MODIFY, REPORT_DELETE, REPORT_ADMIN, REPORT_SQL_VIEW}}}
  * {{{WIKI_VIEW, WIKI_CREATE, WIKI_MODIFY, WIKI_DELETE, WIKI_ADMIN}}}
+ * {{{MILESTONE_VIEW, MILESTONE_CREATE, MILESTONE_MODIFY, MILESTONE_DELETE}}}
+ * {{{ROADMAP_VIEW, ROADMAP_ADMIN}}}
  * {{{TIMELINE_VIEW}}}
  * {{{SEARCH_VIEW}}}
  * {{{CONFIG_VIEW}}}
 with the following command:
 
 {{{
-  $ trac-admin /path/to/my.db permission list
+  $ trac-admin /path/to/projenv permission list
 }}}
 
-This command will let the user ''bob'' to delete reports:
+This command will let the user ''bob'' delete reports:
 
 {{{
-  $ trac-admin /path/to/my.db permission add bob REPORT_DELETE
+  $ trac-admin /path/to/projenv permission add bob REPORT_DELETE
+}}}
+
+=== Permission 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
 }}}
 
 === Default permissions ===
 Granting privileges to the special user ''anonymous'' can be used to control
 what an anonymous user can do before they have logged in.
 
-In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user.
+In the same way, privileges granted to the special user ''authenticated'' will apply to any authenticated (logged in) user.
+
+----
+See also: TracAdmin, TracGuide

wiki-default/TracQuery

-= Trac Ticket Queries =
-
-In addition to [wiki:TracReports reports], Trac provides support for custom ticket queries that can be used to display lists of tickets meeting specific criteria. To configure and execute a custom query, switch to the ''View Tickets'' module from the navigation bar, and select the ''Custom Query'' link.
-
-== Query Form ==
-
-You will be presented a form that lets you select or enter values for any of the ticket properties (both built-in and custom). Any value selected/entered in this form will be used to constrain the list of tickets to only those of which the properties have been set to the selected values.
-
-== Results Display ==
-
-After executing the search, you will be presented a list of tickets meeting the criteria just defined. By default, the list is sorted by priority, but you can change the sorting to any other visible column by clicking on the corresponding column header. Clicking on the same header again will reverse the sorting.
-
-You can also go back to the query form by clicking ''Refine Query''.
-
-----
-See also: TracTickets, TracReports, TracGuide
+= 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.
+
+== Query Form ==
+
+A form will be presented, letting you select or enter values for any of the ticket properties (both built-in and custom). Any value selected/entered in this form will be used to constrain the set of tickets displayed. Only tickets where properties match the criteria will be displayed.
+
+== Results Display ==
+
+After executing the search, a list of tickets meeting the selected criteria will show. By default, the list is sorted by priority. You can change the sorting to any other visible column by clicking on the corresponding column header. Clicking the same header again will reverse the sort order.
+
+You can edit the query by clicking ''Refine Query''.
+
+----
+See also: TracTickets, TracReports, TracGuide

wiki-default/TracReports

-= Trac Reports =
-The Trac reports module provides a simple, yet powerful reporting facility
-for presenting information about tickets from the Trac database.
-
-Rather than have its own report format, TracReports relies on standard SQL
-SELECT statements for custom report definition. 
-
-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.
-
-
-== Alternate Download Formats ==
-Aside from the default HTML view, reports can also be exported in a number of alternate formats.
-At the bottom of the report page, you will find a list of available data formats. Click the desired link to 
-download the alternate 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:''' Column data is stripped from carriage returns, line feeds and commas to preserve 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 a , click the the orange 'XML' icon at the bottom of the page. See TracRss for general information on RSS support in Trac.
-
-== 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.
-
-----
-== Creating Custom Reports ==
-
-Creating a custom report requires knowing and using the SQL query language.
-
-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