Commits

Anonymous committed f77e12a

Updating source:trunk/INSTALL and source:trunk/wiki-default/

  • Participants
  • Parent commits e7ceca3
  • Branches trunk

Comments (0)

Files changed (20)

 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 store it's
-data in a sqlite database.
+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.
 
-Dependencies
+Requirements
 ------------
-The following dependencies have to be installed:
+To install Trac, the following software packages must be installed:
 
   * Python, version >= 2.1.
+      + Please keep in mind, that for RPM-based systems you will also need
+        python-devel and python-xml packages.
   * Subversion, version >= 0.37. (>=1.0.1 recommended)
   * Subversion Python bindings.
-  * pysqlite, version >= 0.4.3 (>= 0.5 for better performance)
-  * ClearSilver, version >= 0.9.3
-  * A CGI-capable web server (We QA-test on Apache)
+  * PySQLite, version >= 0.4.3 (>= 0.5 for better performance)
+  * Clearsilver, version >= 0.9.3
+  * A CGI-capable web server (we QA-test on Apache2 )
 
 Installing Trac
 ---------------
-        $ python ./setup.py install
+    $ 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 will all be copied into
-$prefix/share/trac/ .
+site-packages directory of your python installation. The directories cgi-bin,
+templates, htdocs and wiki-default are all copied to $prefix/share/trac/ .
 
-For more install configuration options, run 'python ./setup.py --help'.
+The script will also install the 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.
+
+Advanced Users
+--------------
+To install Trac in a different location, and other advanced installation
+options, run:
+
+    $ python ./setup.py --help
 
 Installing Trac on Windows
 --------------------------
 After running the installer, configuration and installation is the same as
 for other platforms.
 
-Initializing the database
--------------------------
-Trac stores wiki pages, tickets and other information in a sqlite database.
-Sqlite databases are just ordinary files on the hard drive, no database server
-is required.
+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 database can be created like this:
+A new Trac environment is created with trac-admin:
 
-        $ trac-admin /path/to/mydatabase.db initdb
+    $ trac-admin /path/to/projectenv initenv
 
-NOTE: The database file have to be located in a directory where the web server
-user has write permission to both the file and the directory.
+Note: The web server user need write permission to the environment directory
+and all the files inside.
 
 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. Of course you can configure apache to use the "trac/cgi-bin/"
-directory directly if you like.
+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 adjust the filenames and add this config snippet to your web server:
+Finally edit the apache config and add this config snippet, with filenams
+edited to match your installation:
 
-Alias /trac/ "/where/you/put/trac/htdocs/"
+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_DB "/somewhere/myproject.db"
+        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"
         Require valid-user
 </location>
 
-What next?
+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 (before logging in)
-are only able to see/use a subset of all the features provided by Trac. Please
-read TracPermissions on how to grant additional privileges to authenticated
-users.
+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!
 

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 
+
+----
+See also: 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 =
+
+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.
+----
 See also: TracGuide, TracChangeset

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.
-   * 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.
-   * TracRss -- RSS content syndication in Trac.
-
-
- * [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 =
+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.
+   * 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.
+   * TracRss -- RSS content syndication in Trac.
+
+
+ * [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].

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.
- * [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 databases. Trac-admin is the ''command center'' of Trac.
-
-=== Advanced Users ===
-To install Trac in a different location, and other advanced installation options, run:
-{{{
-$ python ./setup.py --help
-}}}
-
-== Creating a Project Database ==
-
-Trac stores wiki pages, tickets and all other information in a single embedded SQLite database. 
-SQLite databases are stored as a single ordinary file on your filesystem, no separate database server
-or environment is required.
-
-A new trac database is created with {{{trac-admin}}}:
-
-{{{
-$ trac-admin /path/to/mydatabase.db initdb
-}}}
-'''Note:''' The database file have to be located in a directory where the web server
-user has write permission to both the file and the directory.
-
-[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/ "/where/you/put/trac/htdocs/"
-# Trac need to know where the database is located
-<Location "/cgi-bin/trac.cgi">
-	SetEnv TRAC_DB "/somewhere/myproject.db"
-</Location>
-
-# You need this to allow users to authenticate
-<Location "/cgi-bin/trac.cgi/login">
-	AuthType Basic
-	AuthName "trac"
-	AuthUserFile /somewhere/trac.htpasswd
-	Require valid-user
-</location>
-}}}
-
-'''Note:''' When creating a new database, {{{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, TracOnNetBsd, TracOnOsx
+= 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

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, TracConfiguration

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

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
- $ fink install svn-client svn-swig-py
-}}}
-
-Subversion is currently in fink's unstable tree (this will probably change soon).
-This means that you have to use fink to compile the packages instead of simply using
-apt-get to download the binaries directly. This will take some time but should work.
-
-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.
+= 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/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. 
-
-== 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.
-
-----
-== 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
-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
- * time
- * changetime
- * component
- * severity  
- * priority 
- * owner
- * reporter
- * cc
- * url
- * version
- * milestone
- * status
- * resolution
- * summary
- * description
-
-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 the leading '$'.
-
-Example:
-{{{
- http://projects.edgewall.com/trac/reports/14?PRIORITY=high
-}}}
-
-
-=== 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 name begins and ends with '__' (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.
- * '''___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 fore 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
-}}}
-
-
-----
+= 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
+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
+ * time
+ * changetime
+ * component
+ * severity  
+ * priority 
+ * owner
+ * reporter
+ * cc
+ * url
+ * version
+ * milestone
+ * status
+ * resolution
+ * summary
+ * description
+
+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 the leading '$'.
+
+Example:
+{{{
+ http://projects.edgewall.com/trac/reports/14?PRIORITY=high
+}}}
+
+
+=== 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 name begins and ends with '__' (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.
+ * '''___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
+}}}
+
+
+----
 See also: TracTickets, TracGuide

wiki-default/TracSearch

-= Using Search =
-
-Trac has a built-in search engine to allow finding occurrances 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 www users.
-
-Apart from the [search: Search module], you will also find a small search field above the navigation bar at all time. There is no 
-
-== Quickjumps ==
-However, for intermediate and advanced use, Trac has a useful way to quickly navigate to a given module and information item, called '''quickjumps'''.
-
-If you enter a [wiki:TracLinks TracLink] in the search field above the navigation bar, Trac will recognize this and assume you know where you're going. 
-
-'''Note:''' ''This is a particularly useful feature to quickly navigate to a specific issue ticket or changeset.''
-
-=== Advanced: Disabling quickjumps ===
-To disable the quickjump feature in a search - to for example search for all occurences of !TracGuide - begin the query with an exclamation mark (!).
-
-----
+= Using Search =
+
+Trac has a built-in search engine to allow finding occurrances 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 www users.
+
+Apart from the [search: Search module], you will also find a small search field above the navigation bar at all time. There is no 
+
+== Quickjumps ==
+However, for intermediate and advanced use, Trac has a useful way to quickly navigate to a given module and information item, called '''quickjumps'''.
+
+If you enter a [wiki:TracLinks TracLink] in the search field above the navigation bar, Trac will recognize this and assume you know where you're going. 
+
+'''Note:''' ''This is a particularly useful feature to quickly navigate to a specific issue ticket or changeset.''
+
+=== Advanced: Disabling quickjumps ===
+To disable the quickjump feature in a search - to for example search for all occurences of !TracGuide - begin the query with an exclamation mark (!).
+
+----
 See also: TracGuide, TracLinks

wiki-default/TracSyntaxColoring

+= Syntax Coloring of Source Code =
+Trac supports language-specific colorization (syntax highlighting) of source code in [wiki:WikiFormatting WikiFormatted] text and the [wiki:TracBrowser Source Browser].
+
+To perform this, Trac relies on external software packages with support for a great number of programming languages.
+
+Currently Trac supports syntax coloring using [http://people.ssh.fi/mtr/genscript/ GNU Enscript] and [http://silvercity.sourceforge.net/ SilverCity]. 
+
+'''To activate syntax coloring, simply install !SilverCity and/or Enscript.'''
+
+Trac will automatically prioritize using !SilverCity before Enscript if possible. If neither 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, not having to execute an external process.''
+[[br]]'''Note:''' ''Syntax Coloring is only available on trac >= 0.7.''
+
+== Syntax Coloring Support ==
+
+|| || !SilverCity || Enscript ||
+|| Ada      ||   || X ||
+|| Asm      ||   || X ||
+|| * ASP    || X || X ||
+|| * C      || X || X ||
+|| * C++    || X || X ||
+|| * Java   ||   || X ||
+|| Awk      ||   || X ||
+|| CSS      || X ||   ||
+|| Diff     ||   || X ||
+|| Eiffel   ||   || X ||
+|| Elisp    ||   || X ||
+|| Fortran  ||   || X ||
+|| Haskell  ||   || X ||
+|| HTML     || X || X ||
+|| IDL      ||   || X ||
+|| Javascript || X || X ||
+|| m4       ||   || X ||
+|| Makefile ||   || X ||
+|| Matlab   ||   || X ||
+|| Objective-C|| || X ||
+|| Pascal   ||   || X ||
+|| * Perl   || X || X ||
+|| * PHP    || X || X ||
+|| PSP      || X ||   ||
+|| Pyrex    ||   || X ||
+|| * Python || X || X ||
+|| * Ruby   || X || X ||
+|| Scheme   ||   || X ||
+|| Shell    ||   || X ||
+|| SQL      || X || X ||
+|| Troff    ||   || X ||
+|| TCL      ||   || X ||
+|| Tex      ||   || X ||
+|| Verilog  ||   || X ||
+|| VHDL     ||   || X ||
+|| Visual Basic |||| X ||
+|| VRML     ||   || X ||
+|| XML      || X || X ||
+
+''(*) Supported as inline code blocks in [wiki:WikiFormatting Wiki text] using WikiProcessors.''
+
+== Extra Software ==
+ * GNU Enscript -- http://people.ssh.fi/mtr/genscript/
+ * !SilverCity -- http://silvercity.sf.net/
+
+----
+See also: WikiProcessors, WikiFormatting, TracWiki, TracBrowser.

wiki-default/TracTickets

-= The Trac Ticket System =
-
-The Trac issue database provides simple but effective tracking of issues and bugs within the project.
-
-As the central project management element of Trac, tickets are be used for '''bug reports''',  '''feature requests'''. '''software support issues''' and '''project tasks'''. 
-
-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 easy to report bugs, ask questions and suggest improvements.
-
-An issue is assigned 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.
- * '''Component''' - The project module or subsystem this ticket concerns.
- * '''Version''' - Version of the project that this ticket pertains to.
- * '''Severity''' - What are the effects the issue described? Ranges from an ''enhancement'' request to ''blocker'' (must be fixed before next milestone).
- * '''Priority''' - The importance of is the issue relative to other tasks.
- * '''Milestone''' - When this issue should be resolved at the latest.
- * '''Assigned to''' - Principal person responsible for handling the issue.
- * '''Cc''' - A list of other associated people. ''note: this does '''not''' imply responsiblity or any other policy. 
-
- * '''Status''' - What is the current status?
-
- * '''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'''.
-
-== 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, this log 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.
-
+= The Trac Ticket System =
+
+The Trac issue database provides simple but effective tracking of issues and bugs within the project.
+
+As the central project management element of Trac, tickets are used for '''bug reports''',  '''feature requests''', '''software support issues''' and '''project tasks'''. 
+
+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 easy 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.
+ * '''Component''' - The project module or subsystem this ticket concerns.
+ * '''Version''' - Version of the project that this ticket pertains to.
+ * '''Severity''' - What are the effects the issue described? Ranges from an ''enhancement'' request to ''blocker'' (must be fixed before next milestone).
+ * '''Priority''' - The importance of is the issue relative to other tasks.
+ * '''Milestone''' - When this issue should be resolved at the latest.
+ * '''Assigned to''' - Principal person responsible for handling the issue.
+ * '''Cc''' - A list of other associated people. ''note: this does '''not''' imply responsiblity or any other policy. 
+
+ * '''Status''' - What is the current status?
+
+ * '''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'''.
+
+== 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, this log 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.
+
 See also:  TracGuide, TracWiki

wiki-default/TracTimeline

  * '''Wiki page events''' -- Creation and changes
  * '''Ticket events''' -- Creation and resolution/closing
  * '''Source code changes ''' -- Subversion commits 
+ * '''Milestone ''' -- Milestone completed
 
 Each event entry provides a hyperlink to the specific event in question, and 
 in the case svn commit log messages, displays the commit message. 

wiki-default/TracUnicode

+= Unicode Support in Trac =
+Trac stores all text using UTF-8 encoding, including text in tickets and wiki pages. 
+
+As such, it supports most (all?) commonly used character encodings.
+
+
+== Examples ==
+
+=== Swedish ===
+
+''R�ven raskar �ver isen med luva p�.''
+
+=== Fran�ais ===
+
+''Il est possible d'�crire en Fran�ais : �, �, �, ...''
+
+=== Icelandic ===
+
+''�var sag�i vi� �mmu s�na: Sj��u hva� �g er st�r!''

wiki-default/TracWiki

-= The Trac Wiki Engine =
-
-Trac has a built-in wiki engine, used for text and documentation throughout the system. WikiFormatting is used for [wiki:TitleIndex wiki pages], '''tickets''' and '''commit 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 formatting system (see WikiFormatting), rather than more complex markups like HTML. 
-The reasoning behind its design is that HTML, with its large library of nested tags, is too complicated to allow fast-paced editing, and distracts from the actual content of the pages. Note tough, Trac also supports [wiki:WikiHtml HTML] and [wiki:WikiRestructuredText reStructuredText] as alternative markup formats.
-
-The main goal of the wiki  is making editing text easier and '''encourage''' people to contribute and annotate text content for a project. 
-
-Wiki itself does not enforce any structure, but rather resembles a stack of empty paper sheets, where you can organize information and documentation as you see fit, and later reorganize if necessary. 
-
-For more help on editing wiki text, see:
- * WikiFormatting
- * WikiPageNames
- * WikiNewPage
- * TracLinks
- * WikiMacros
- * WikiProcessors
-
-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
+= The Trac Wiki Engine =
+
+Trac has a built-in wiki engine, used for text and documentation throughout the system. WikiFormatting is used for [wiki:TitleIndex wiki pages], '''tickets''' and '''commit 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 formatting system (see WikiFormatting), rather than more complex markups like HTML. 
+The reasoning behind its design is that HTML, with its large library of nested tags, is too complicated to allow fast-paced editing, and distracts from the actual content of the pages. Note though, Trac also supports [wiki:WikiHtml HTML] and [wiki:WikiRestructuredText reStructuredText] as alternative markup formats.
+
+The main goal of the wiki  is making editing text easier and '''encourage''' people to contribute and annotate text content for a project. 
+
+Wiki itself does not enforce any structure, but rather resembles a stack of empty paper sheets, where you can organize information and documentation as you see fit, and later reorganize if necessary. 
+
+For more help on editing wiki text, see:
+ * WikiFormatting
+ * WikiPageNames
+ * WikiNewPage
+ * TracLinks
+ * WikiMacros
+ * WikiProcessors
+
+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

wiki-default/WikiFormatting

-= WikiFormatting =
-
-Wiki serves as the core component of Trac, which tightly integrates all the other parts of Trac into flexible and powerful system.
-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://moin.sf.net/ MoinWiki]. 
-
-This page demonstrates some of the formatting commands available in the Trac Wiki.
-
-== Font styles ==
-
-The Trac wiki support the following font styles: '''bold''', ''italic''
-and __underline__.
-
-{{{
-The Trac wiki support the following font styles: '''bold''', ''italic''
-and __underline__.
-}}}
-
-== Heading ==
-
-You can create heading by starting a line with one up to five equal signs
-followed by a space and the headline text. The line should end with a space 
-followed by the same number of equal signs. 
-
-=== Example: ===
-{{{
-= Heading =
-== Subheading ==
-}}}
-
-
-== Paragraphs ==
-
-A new text paragraph is created whenever two blocks of text are separated
-by an empty line. A newline can also be inserted like this:
-{{{
-Line 1[[BR]]Line 2
-}}}
-Display:
-
-Line 1[[BR]]Line 2
-
- Text paragraphs can also be indented by starting the lines with a few spaces.
-== Lists ==
-Example:
-{{{
- * Item 1
-   * Item 1.1
- * Item 2
-
- 1. Item 1
-   1. Item 1.1
- 1. Item 2
-}}}
-Display:
- * Item 1
-   * Item 1.1
- * Item 2
-
- 1. Item 1
-   1. Item 1.1
- 1. Item 2
-
-== Preformatted text ==
-Block quotes, also know as preformatted text, is suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text:
-  
-{{{
- {{{
-  def HelloWorld()
-      print "Hello World"
- }}}
-}}}
-
-Display:
-{{{
- def HelloWorld()
-     print "Hello World"
-}}}
-
-== 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||
-
-== Links ==
-
-Hyperlinks are automatically created for WikiPageNames and urls. 
-
-For example:
-
- TitleIndex, http://www.edgewall.com/.
-
-Links can be given a move descriptive title by writing the link followed by
-a space and a title and all this inside two square brackets. Like this:
-{{{
- * [http://www.edgewall.com/ Edgewall Software]
- * [wiki:TitleIndex Title Index]
-}}}
-Display:
-
- * [http://www.edgewall.com/ Edgewall Software]
- * [wiki:TitleIndex Title Index]
-
-=== Intra Trac Links ===
-
-Trac allows wiki pages to link directly to other parts of the Trac system.
-Pages can refer to tickets, reports and changesets by simply writing the
-ticket, report and changeset numbers in the following notation:
-{{{
- * Ticket #1 
- * Report {1}
- * Changeset [1]
- * File source:trunk/COPYING.
- * A specific file revision: source:/trunk/COPYING#200
-}}}
-Display:
- * Ticket #1 
- * Report {1}
- * Changeset [1]
- * File source:trunk/COPYING.
- * A specific file revision: source:/trunk/COPYING#200
-
-See TracLinks for more information about intra-trac linking.
-
-== Images ==
-
-Urls ending with .png, .gif or .jpg will be converted to an IMG-tag.
-
-Example:
-{{{
-http://www.edgewall.com/gfx/trac_example_image.png
-}}}
-Display:
-
-http://www.edgewall.com/gfx/trac_example_image.png
-
-== Macros ==
-Macros are ''custom functions'' to insert dynamic content in a page. See WikiMacros for usage.
-
-Example:
-{{{
- [[Timestamp]]
-}}}
-Display:
- [[Timestamp]]
-
-== Processors ==
-Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in [wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. See WikiProcessors for documentation.
-
-Example:
-{{{
-#!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>
-}}}
-
-== Miscellaneous ==
-
-Four or more dashes will be replaced by a horizontal line (<HR>)
-
-{{{
- ----
-}}}
-
-Display:
-----
-
-
-----
-See also: TracLinks, TracGuide, WikiMacros, WikiProcessors
+= WikiFormatting =
+
+Wiki serves as the core component of Trac, which tightly integrates all the other parts of Trac into flexible and powerful system.
+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://moin.sf.net/ MoinWiki]. 
+
+This page demonstrates some of the formatting commands available in the Trac Wiki.
+
+== Font styles ==
+
+The Trac wiki support the following font styles: '''bold''', ''italic''
+and __underline__.
+
+{{{
+The Trac wiki support the following font styles: '''bold''', ''italic''
+and __underline__.
+}}}
+
+== Heading ==
+
+You can create heading by starting a line with one up to five equal signs
+followed by a space and the headline text. The line should end with a space 
+followed by the same number of equal signs. 
+
+=== Example: ===
+{{{
+= Heading =
+== Subheading ==
+}}}
+
+
+== Paragraphs ==
+
+A new text paragraph is created whenever two blocks of text are separated
+by an empty line. A newline can also be inserted like this:
+{{{
+Line 1[[BR]]Line 2
+}}}
+Display:
+
+Line 1[[BR]]Line 2
+
+ Text paragraphs can also be indented by starting the lines with a few spaces.
+== Lists ==
+Example:
+{{{
+ * Item 1
+   * Item 1.1
+ * Item 2
+
+ 1. Item 1
+   1. Item 1.1
+ 1. Item 2
+}}}
+Display:
+ * Item 1
+   * Item 1.1
+ * Item 2
+
+ 1. Item 1
+   1. Item 1.1
+ 1. Item 2
+
+== Preformatted text ==
+Block quotes, also know as preformatted text, is suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text:
+  
+{{{
+ {{{
+  def HelloWorld()
+      print "Hello World"
+ }}}
+}}}
+
+Display:
+{{{
+ def HelloWorld()
+     print "Hello World"
+}}}
+
+== 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||
+
+== Links ==
+
+Hyperlinks are automatically created for WikiPageNames and urls. 
+
+For example:
+
+ TitleIndex, http://www.edgewall.com/.
+
+Links can be given a more descriptive title by writing the link followed by
+a space and a title and all this inside two square brackets. Like this:
+{{{
+ * [http://www.edgewall.com/ Edgewall Software]
+ * [wiki:TitleIndex Title Index]
+}}}
+Display:
+
+ * [http://www.edgewall.com/ Edgewall Software]
+ * [wiki:TitleIndex Title Index]
+
+=== Intra Trac Links ===
+
+Trac allows wiki pages to link directly to other parts of the Trac system.
+Pages can refer to tickets, reports and changesets by simply writing the
+ticket, report and changeset numbers in the following notation:
+{{{
+ * Ticket #1 
+ * Report {1}
+ * Changeset [1]
+ * File source:trunk/COPYING.
+ * A specific file revision: source:/trunk/COPYING#200
+}}}
+Display:
+ * Ticket #1 
+ * Report {1}
+ * Changeset [1]
+ * File source:trunk/COPYING.
+ * A specific file revision: source:/trunk/COPYING#200
+
+See TracLinks for more information about intra-trac linking.
+
+== Images ==
+
+Urls ending with .png, .gif or .jpg will be converted to an IMG-tag.
+
+Example:
+{{{
+http://www.edgewall.com/gfx/trac_example_image.png
+}}}
+Display:
+
+http://www.edgewall.com/gfx/trac_example_image.png
+
+== Macros ==
+Macros are ''custom functions'' to insert dynamic content in a page. See WikiMacros for usage.
+
+Example:
+{{{
+ [[Timestamp]]
+}}}
+Display:
+ [[Timestamp]]
+
+== Processors ==
+Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in [wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. See WikiProcessors for documentation.
+
+'''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 2:'''
+{{{
+#!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()
+}}}
+== Miscellaneous ==
+
+Four or more dashes will be replaced by a horizontal line (<HR>)
+
+{{{
+ ----
+}}}
+
+Display:
+----
+
+
+----
+See also: TracLinks, TracGuide, WikiMacros, WikiProcessors, TracSyntaxColoring.

wiki-default/WikiNewPage

-= How to Add a New Wiki Page =
-
-These are the steps to create a new wiki pages:
-
- 1. Choose a name for your new page. See WikiPageNames for naming conventions.
- 1. Edit an existing page, and add a hyperlink to your new page. Save your changes.
- 1. Follow the link you created to take you to the new page. Trac display a "describe PageName here" message.
- 1. Click the "Edit this page" link to edit and add content to your new page
- 1. All done. Your new page is published.
-
-
+= How to Add a New Wiki Page =
+
+These are the steps to create a new wiki pages:
+
+ 1. Choose a name for your new page. See WikiPageNames for naming conventions.
+ 1. Edit an existing page, and add a hyperlink to your new page. Save your changes.
+ 1. Follow the link you created to take you to the new page. Trac display a "describe !PageName here" message.
+ 1. Click the "Edit this page" link to edit and add content to your new page
+ 1. All done. Your new page is published.
+
+
 See also: TracWiki, WikiFormatting, TracLinks

wiki-default/WikiProcessors

-= Wiki Processors =
-Processors are WikiMacros designed to provide alternative markup formats for the Trac 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] and [wiki:WikiHtml raw HTML] in any wiki text throughout Trac.
-
-== Using Processors ==
-To use a processor on a block of text, use a wiki blockquote, selecting a processor by name using 'hashbang 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>
-}}}
-
-----
-
-'''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.
-}}}
-
-
-----
-== Available Processors ==
-The following processors are included in the Trac distribution:
- * '''html''' -- Insert custom HTML in a wiki page. See WikiHtml.
- * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText.
-
-For more processor macros developed and/or contributed by users, visit the processor bazaar: 
- http://projects.edgewall.com/trac/wiki/ProcessorBazaar
-
-----
-== Advanced Topics: Developing Processor Macros ==
-Developing processors is no different than WikiMacros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.
-
-'''Example:''' (''Restructured Text Processor''):
-{{{
-from docutils.core import publish_string
-
-def execute(hdf, text):
-    html = publish_string(text, writer_name = 'html')
-    return html[html.find('<body>')+6:html.find('</body>')].strip()
-}}}
-
-----
-See also: WikiMacros, WikiHtml, WikiRestructuredText, WikiFormatting, TracGuide
+= Wiki Processors =
+Processors are WikiMacros designed to provide alternative markup formats for the Trac 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] and [wiki:WikiHtml raw HTML] in any wiki text throughout Trac.
+
+== Using Processors ==
+To use a processor on a block of text, use a wiki blockquote, selecting a processor by name using 'hashbang 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>
+}}}
+
+----
+
+'''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.
+ * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText.
+
+=== Source Code Support ===
+Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for these languages:
+ * '''c''' -- C
+ * '''cpp''' -- C++
+ * '''python''' -- Python
+ * '''perl''' -- Perl
+ * '''ruby''' -- Ruby
+ * '''php''' -- PHP
+ * '''asp''' --- ASP
+ * '''sql''' -- SQL
+ * '''xml''' -- XML
+'''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.''
+
+
+For more processor macros developed and/or contributed by users, visit the processor bazaar: 
+ http://projects.edgewall.com/trac/wiki/ProcessorBazaar
+
+----
+== Advanced Topics: Developing Processor Macros ==
+Developing processors is no different than WikiMacros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.
+
+'''Example:''' (''Restructured Text Processor''):
+{{{
+from docutils.core import publish_string
+
+def execute(hdf, text):
+    html = publish_string(text, writer_name = 'html')
+    return html[html.find('<body>')+6:html.find('</body>')].strip()
+}}}
+
+----
+See also: WikiMacros, WikiHtml, WikiRestructuredText, TracSyntaxColoring, WikiFormatting, TracGuide

wiki-default/WikiRestructuredText

-= reStructuredText Support in Trac =
-
-Since 0.6, Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context where 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. ''"
-
-== Using RST in Trac ==
-To specify that a block of text should be parsed using RST, use the ''rst'' proceessor. The example below should be 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
-=====  =====  ======
-
-.. _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
-=====  =====  ======
-
-.. _webpage: http://docutils.sourceforge.net/rst.html
-}}}
-
-
-----
-== 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
-
-
-----
-See also: WikiProcessors, WikiFormatting
+= reStructuredText Support in Trac =
+
+Since 0.6, Trac supports using ''reStructuredText'' (RST) as an alternative to wiki markup in any context where 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].
+