Edgewall Software

Changes between Version 235 and Version 236 of 0.12/TracFaq


Ignore:
Timestamp:
Jun 22, 2006, 2:37:33 PM (18 years ago)
Author:
Christian Boos
Comment:

conversion to Trac WikiFormatting. reStructuredText is no longer necessary for having a Table of Content. This change will hopefully lower the barrier for user contributions and lead to a better maintained FAQ Note that during this conversion, I retained the previous text content, trying to not correct errors. This will be done in a second step.

Legend:

Unmodified
Added
Removed
Modified
  • 0.12/TracFaq

    v235 v236  
    11{{{
    2 #!rst
    3 ========
    4 Trac FAQ
    5 ========
    6 Here you can find the answer to some of the most frequently asked questions about Trac. If you have a question not answered by this page you can ask it on the `MailingList`:trac: or in the `IrcChannel`:trac:.  See the `TracSupport`:trac: page for more options on getting support for Trac.
    7 
    8 .. contents::
    9 .. sectnum::
    10 
    11 -----
    12 
    13 .. ** BEFORE INSTALLATION **
    14 
    15 Management Summary
    16 ==================
    17 
    18 Where is the bird's eye view documentation?
    19 -------------------------------------------
     2#!comment
     3Please FAQ authors, pay attention!
     4
     5That FAQ is no longer using reStructured text as its format.
     6For backward compatibility reasons, we have kept the old faq entries ids
     7generated by docutils.
     8
     9New FAQ entries don't need an explicit id, unless you think it would be
     10better that way.
     11}}}
     12
     13[[PageOutline]]
     14
     15= Trac FAQ =
     16
     17Here you can find the answer to some of the most frequently asked questions about Trac. If you have a question not answered by this page you can ask it on the MailingList or in the IrcChannel.  See the TracSupport page for more options on getting support for Trac.
     18
     19----
     20
     21== Management Summary == #management-summary
     22
     23=== Where is the bird's eye view documentation? === #where-is-the-bird-s-eye-view-documentation
    2024
    2125Where do I find the two-page summary on what Trac and its features are?  I'm looking for some kind of documentation that I can show my boss, so that he'll get interested enough to allow me to spend the time and resources to test-install and evaluate further.
     
    2428
    2529
    26 .. ** INSTALLING AND RUNNING TRAC **
    27 
    28 Installing and Running Trac
    29 ===========================
    30 
    31 What operating systems does Trac run on?
    32 ----------------------------------------
    33 Trac will run on any system supported by Python and the depending modules. Today we are aware of people running Trac on various Linux distributions, Mac OS X, FreeBSD, NetBSD and MS Windows.
    34 
    35 
    36   See also: `TracOnFreeBsd`:trac: , `TracOnNetBsd`:trac: , `TracOnOsx`:trac:, `TracOnMandrakelinux`:trac:, `TracOnGentoo`:trac:, `TracOnDebian`:trac:, `TracOnFedoraCore`:trac:, `TracOnRedhat`:trac:, `TracOnWindows`:trac: , `TracOnSLES9`:trac:
    37 
    38 What license governs the use of Trac?
    39 -------------------------------------
    40 Starting with version 0.9, Trac is released under the `modified BSD license`_. Versions of Trac prior to 0.9 were released under the GNU General Public License (GPL).
    41 
    42 .. _`modified BSD license`: http://trac.edgewall.com/license.html
    43 
    44 Can I migrate my bugs from Bugzilla?
    45 ------------------------------------
    46 There is a script to assist with the migration at http://projects.edgewall.com/trac/file/trunk/contrib/bugzilla2trac.py
    47 
    48 For more information see: `TracImport`:trac:
    49 
    50 What are the dependencies of Trac?
    51 ----------------------------------
    52 Trac depends on the following software: Subversion w/Python bindings, Clearsilver_, `SQLite w/Python bindings`_. Syntax coloring requires `GNU Enscript`_ and/or SilverCity_.
    53 
    54   See also: `TracInstall`:trac:, `TracSyntaxColoring`:trac:.
    55 
    56 .. _Clearsilver:  http://www.clearsilver.net/
    57 .. _`SQLite w/Python bindings`:  http://www.sqlite.org/
    58 .. _`GNU Enscript`:  http://people.ssh.fi/mtr/genscript/
    59 .. _SilverCity:  http://silvercity.sf.net/
    60 
    61 How do I install Clearsilver?
    62 -----------------------------
     30== Installing and Running Trac == #installing-and-running-trac
     31
     32=== What operating systems does Trac run on? === #what-operating-systems-does-trac-run-on
     33
     34Trac will run on any system supported by Python and the depending modules. Today we are aware of people running Trac on various Linux distributions, Mac OS X, FreeBSD, NetBSD and MS Windows.
     35
     36
     37  See also: TracOnFreeBsd , TracOnNetBsd , TracOnOsx, TracOnMandrakelinux, TracOnGentoo, TracOnDebian, TracOnFedoraCore, TracOnRedhat, TracOnWindows, ["TracOnSLES9"]
     38
     39=== What license governs the use of Trac? === #what-license-governs-the-use-of-trac
     40
     41Starting with version 0.9, Trac is released under the [http://trac.edgewall.com/license.html modified BSD license]. Versions of Trac prior to 0.9 were released under the GNU General Public License (GPL).
     42
     43=== Can I migrate my bugs from Bugzilla? === #can-i-migrate-my-bugs-from-bugzilla
     44
     45There is a script to assist with the migration at source:trunk/contrib/bugzilla2trac.py
     46
     47For more information see: TracImport
     48
     49=== What are the dependencies of Trac? === #what-are-the-dependencies-of-trac
     50
     51Trac depends on the following software: Subversion w/Python bindings, [http://www.clearsilver.net/ Clearsilver], [http://www.sqlite.org/ SQLite w/Python bindings]. Syntax coloring requires [http://people.ssh.fi/mtr/genscript GNU Enscript] and/or [http://silvercity.sf.net/ SilverCity].
     52
     53  See also: TracInstall, TracSyntaxColoring.
     54
     55=== How do I install Clearsilver? === #how-do-i-install-clearsilver
     56
    6357
    6458The following Trac error message indicates that Clearsilver is not installed correctly.
    65 Check first our :trac:`ClearSilver` wiki page. If this still doesn't work,
     59Check first our ClearSilver wiki page. If this still doesn't work,
    6660maybe the following tips can help:
    67 
    68 ::
    69 
     61{{{
    7062   TracError: ClearSilver not installed (No module named neo_cgi)
    71 
     63}}}
    7264Clearsilver has some bugs in its build process. The following process may help:
    7365
    74 ::
    75 
     66{{{
    7667   ./configure --disable-apache --disable-csharp --disable-ruby --prefix=/usr
    7768 
     
    8475   cd python
    8576   python setup.py install
    86 
     77}}}
    8778See also http://groups.yahoo.com/group/ClearSilver/message/589 - it appears that PYTHON_SITE is not being set properly in the clearsilver-0.10.2 makefile so neo_cgi.so is not installed. Try:
    8879
    89 ::
    90 
     80{{{
    9181   PYTHON_SITE=`/path/to/python -c \
    9282   "import sys; print [path for path in sys.path if path.find('site-packages') != -1][0]"` \
    9383   ./configure --with-python=/path/to/python --disable-ruby \
    9484   --disable-java --disable-apache --disable-csharp
    95 
    96 How can I install Trac in a specific directory?
    97 -----------------------------------------------
    98 ::
    99 
     85}}}
     86
     87=== How can I install Trac in a specific directory? === #how-can-i-install-trac-in-a-specific-directory
     88
     89{{{
    10090   ./setup.py install --prefix=/my/directory/for/trac
    101 
    102 Can I replace SQLite with MySQL or PostgreSQL?
    103 ----------------------------------------------
    104 See `#126`:trac: re Database Independence and `DatabaseBackend`:trac:.
    105 
    106 Can I manage multiple projects from a single installation of Trac?
    107 ------------------------------------------------------------------
     91}}}
     92
     93=== Can I replace SQLite with MySQL or PostgreSQL? === #can-i-replace-sqlite-with-mysql-or-postgresql
     94
     95Yes.
     96See #126 re Database Independence and DatabaseBackend.
     97
     98=== Can I manage multiple projects from a single installation of Trac? === #can-i-manage-multiple-projects-from-a-single-installation-of-trac
     99
    108100(or do I have to setup a different directory for each one?)
    109101
    110 Only one installation is required, then for each project create an Environment (using trac-admin <fooproj> initenv). They will be separate projects, all handled by the same installation of Trac.
    111 
    112 **Note:** Right now there is no support for sharing information between projects.
    113 
    114 The rationale for this is that the scope of Trac (1.0) is to manage a single project, and do it well. Support for larger multi-project management adds alot of complexity, but is planned for post-1.0 development, probably as a separate framework around Trac.
    115 
    116   See also: `TracMultipleProjects`:trac:
    117 
    118 How can I create a nice URL to access trac.cgi?
    119 -----------------------------------------------
     102Only one installation is required, then for each project create an Environment (using `trac-admin <fooproj> initenv`). They will be separate projects, all handled by the same installation of Trac.
     103
     104'''Note:''' Right now there is no support for sharing information between projects.
     105
     106The rationale for this is that the scope of Trac (1.0) is to manage a single project, and do it well. Support for larger multi-project management adds a lot of complexity, but is planned for post-1.0 development, probably as a separate framework around Trac.
     107
     108
     109
     110  See also: TracMultipleProjects
     111
     112=== How can I create a nice URL to access trac.cgi? === #how-can-i-create-a-nice-url-to-access-trac-cgi
    120113
    121114If you are serving Trac with Apache, you can use the following directives
     
    125118server, but it works just as well with Apache 1.3 or on Unix.
    126119
    127 ::
    128 
     120{{{
    129121   # Map the Trac CGI into /trac/
    130122   ScriptAliasMatch ^/trac(.*) "C:/Program Files/Apache Group/Apache2/cgi-bin/trac.cgi$1"
     
    154146     Allow from all
    155147   </Directory>
    156 
    157 See also: `TracPrettyUrls`:trac:
    158 
    159 Note: The ScriptAliasMatch on /trac.. masks the Alias /trac-static/, so this didn't worked well form me. Instead I used the alias /static-trac/.
    160 
    161 Great software. Is there a guide on hacking the templates?
    162 ------------------------------------------------------------------
    163 The templates are stored here::
    164 
    165     $PYTHON_HOME/share/trac: miscellaneous resources, including:
    166         htdocs: images and CSS;
    167         templates: ClearSilver templates; and
     148}}}
     149
     150See also: TracPrettyUrls
     151
     152Note: The !ScriptAliasMatch on /trac.. masks the Alias /trac-static/, so this didn't worked well form me. Instead I used the alias /static-trac/.
     153
     154=== Great software. Is there a guide on hacking the templates? === #great-software-is-there-a-guide-on-hacking-the-templates
     155
     156The templates are stored here
     157
     158    $PYTHON_HOME/share/trac:: miscellaneous resources, including:
     159        - htdocs: images and CSS;
     160        - templates: ClearSilver templates; and
    168161   
    169     $TRAC_DB/conf/trac.ini: settings, including (but not limited to):
    170         templates_dir: where page templates are stored;
    171         htdocs_location: the base URL for this Trac installation; and
     162    $TRAC_DB/conf/trac.ini:: settings, including (but not limited to):
     163        - templates_dir: where page templates are stored;
     164        - htdocs_location: the base URL for this Trac installation; and
    172165
    173166
    174167and you can read more about the clearsilver templating language at http://www.clearsilver.net/docs/.
    175168
    176 How do I reliably create backups of my Trac environment?
    177 ------------------------------------------------------------------
    178 With the `TracAdmin`:trac: command ''hotcopy''. See `TracBackup`:trac: for documentation.
    179 
    180 
    181 Can I use Trac with a remote subversion repository?
    182 ------------------------------------------------------------------
     169=== How do I reliably create backups of my Trac environment? === #how-do-i-reliably-create-backups-of-my-trac-environment
     170
     171With the TracAdmin command `hotcopy`. See TracBackup for documentation.
     172
     173
     174=== Can I use Trac with a remote subversion repository? === #can-i-use-trac-with-a-remote-subversion-repository
     175
     176
    183177You can't use Trac (not yet) with remote repository but you could mirror remote repository
    184178using this program: http://svk.elixus.org/
     
    186180If you're on Windows, the Python bindings support UNC paths, so you can use a repository that's shared out on another machine. Just use the UNC path instead of the local file path when setting up Trac.  (Note that this can be slow and that this usage is not recommended by the Subversion development team.)
    187181
    188 How do I change the format used for displaying date and time?
    189 ------------------------------------------------------------------
     182=== How do I change the format used for displaying date and time? === #how-do-i-change-the-format-used-for-displaying-date-and-time
     183
    190184You change the format by setting an appropriate 'locale' in the Apache config. You do this by adding
    191185
    192 ::
    193 
     186{{{
    194187  SetEnv LC_TIME "xx_YY"
    195 
    196 right after the line where you set TRAC_ENV.
     188}}}
     189
     190
     191Right after the line where you set TRAC_ENV.
    197192
    198193On a Linux/Un*x platform:
    199194
    200 :xx: The language code as defined in `ISO 639`_
    201 :YY: The upper case, two letter country code as defined in `ISO 3166`_
    202 
    203 Examples: *de_DE* is Germany, *en_GB* is Great Britain and *fr_FR* is France
     195 xx:: The language code as defined in [ftp://ftp.ilog.fr/pub/Users/haible/utf8/ISO_639 ISO 639]
     196 YY:: The upper case, two letter country code as defined in [ftp://ftp.ilog.fr/pub/Users/haible/utf8/ISO_3166 ISO 3166]
     197
     198Examples: `de_DE` is Germany, `en_GB` is Great Britain and `fr_FR` is France
    204199
    205200On a Windows platform:
    206201
    207 :xx: The language name as defined in `ISO 639`_
    208 :YY: The country name as defined in `ISO 3166`_
    209 
    210 Examples: 'German_Germany' is Germany, 'English_United Kingdom' is Great Britain and 'French_France' is France
    211 
    212 **When it does not work**
     202 xx:: The language name as defined in ISO 639
     203 YY:: The country name as defined in ISO 3166
     204
     205Examples: `German_Germany` is Germany, `English_United Kingdom` is Great Britain and `French_France` is France
     206
     207'''When it does not work'''
    213208
    214209First, you should check, if the chosen locale is installed on the system at all.
     
    216211On Linux, you can use
    217212
    218 ::
    219 
     213{{{
    220214  localedef --list-archive
    221 
     215}}}
    222216
    223217or
     
    225219On FreeBSD you can use
    226220
    227 ::
    228 
     221{{{
    229222  locale -a
    230 
     223}}}
    231224to list the installed locale definitions.
    232225
    233226If this is not the problem, then LC_TIME may be overridden by LC_ALL or LANGUAGE defined in the system environment. You may try one of them (LANGUAGE has highest priority) instead LC_TIME. Note that LC_TIME just affects the date and time display, whereas LC_ALL and LANGUAGE also affect handling of system messages, sorting and other country dependent output/input. So the conservative way is to stick to LC_TIME if possible. On RedHat change /etc/sysconfig/httpd and set
    234227
    235 ::
    236 
     228{{{
    237229  HTTPD_LANG=xx_YY
    238 
    239 On Debian, edit ``/etc/init.d/apache2`` and add ``LC_TIME=xx_YY`` to the ``ENV`` variable.  Run ``dpkg-reconfigure locales`` as root if   the locale you require is not available.
     230}}}
     231
     232On Debian, edit `/etc/init.d/apache2` and add `LC_TIME=xx_YY` to the `ENV` variable.  Run `dpkg-reconfigure locales` as root if   the locale you require is not available.
    240233
    241234Alternatively, to simply change the date and time when using mod_python with a Un*x-like system, simply do this...
    242235
    243 ::
    244 
     236{{{
    245237  <Location /projects>
    246238    SetHandler mod_python
     
    248240    ...
    249241  </Location>
    250 
    251 
    252 .. _`ISO 639`: ftp://ftp.ilog.fr/pub/Users/haible/utf8/ISO_639
    253 .. _`ISO 3166`: ftp://ftp.ilog.fr/pub/Users/haible/utf8/ISO_3166
    254 
    255 I am getting svn import errors with trac, what's going on?
    256 ------------------------------------------------------------------
    257 Make sure you install the Python bindings of Subversion, just having Subversion is not good enough.  To verify you should have a *libsvn* and *svn* directory underneath Python's *site-packages* directory.
     242}}}
     243
     244=== I am getting svn import errors with trac, what's going on? === #i-am-getting-svn-import-errors-with-trac-what-s-going-on
     245
     246Make sure you install the Python bindings of Subversion, just having Subversion is not good enough.  To verify you should have a `libsvn` and `svn` directory underneath Python's `site-packages` directory.
    258247
    259248If you do not have this use something like the following to fix this:
     
    261250On Gentoo Linux:
    262251
    263 ::
    264 
     252{{{
    265253  USE="python" emerge subversion
    266 
    267 On FreeBSD use the *ports/devel/subversion-python* port (preferred way) or *ports/devel/subversion* with
    268 
    269 ::
    270 
     254}}}
     255
     256On FreeBSD use the `ports/devel/subversion-python` port (preferred way) or `ports/devel/subversion` with
     257
     258{{{
    271259  WITH_PYTHON=true
    272 
    273 When using pkgsrc, please make sure to use the *pkgsrc/devel/py-subversion* pkg.
    274 
    275 Why is my CSS code not being highlighted even though I have Silvercity installed?
    276 ----------------------------------------------------------------------------------------
     260}}}
     261
     262When using pkgsrc, please make sure to use the `pkgsrc/devel/py-subversion` pkg.
     263
     264=== Why is my CSS code not being highlighted even though I have Silvercity installed? === #why-is-my-css-code-not-being-highlighted-even-though-i-have-silvercity-installed
     265
    277266(this has been confirmed with Trac version 0.9-1 on Ubuntu 5.10 (Breezy Badger))
    278267
    279268Check your version of Silvercity.  If you are using version 0.9.6 of Silvercity which was released on 2005/12/30 you will see an error in your trac.log file (assuming you have logging turned on) that looks like this:
    280269
    281 ::
    282 
     270{{{
    283271  09:00:33 Trac[api] DEBUG: Trying to render HTML preview using SilverCityRenderer
    284272  09:00:33 Trac[api] WARNING: HTML preview using <trac.mimeview.silvercity.SilverCityRenderer object at 0xb6dd4d8c> failed
     
    290278  File "/usr/lib/python2.4/site-packages/SilverCity/Lexer.py", line 8, in tokenize_by_style call_back
    291279  TypeError: expected sequence of 3 WordLists (2 provided)
     280}}}
    292281
    293282Steps to fix:
    294283
    295 ::
    296284
    297285 1. Uninstall Silvercity 0.9.6
     
    307295Css highlighting should now work!
    308296
    309 
    310 Can I use Trac with a subtree of my subversion repository?
    311 ------------------------------------------------------------------
     297=== Can I use Trac with a subtree of my subversion repository? === #can-i-use-trac-with-a-subtree-of-my-subversion-repository
     298
    312299When setting up your Trac environment simply append the subtree of interest to the
    313300repository path, eg, if your repository resides in '/var/svn' and you only want to
     
    316303setting in your 'conf/trac.ini' inside the trac instance directory.
    317304
    318 --------
    319 
    320 .. ** WIKI **
    321 
    322 Wiki
    323 ====
    324 
    325 
    326 What is a "Wiki"?
    327 -----------------
    328 The term Wiki is a shortened form of WikiWikiWeb_. A Wiki is a database of pages that can be collaboratively edited using a web browser.
    329 
    330 See also: `TracWiki`:trac:
    331 
    332 .. _WikiWikiWeb: http://c2.com/cgi/wiki?WikiWikiWeb
    333 
    334 
    335 Did you copy the previous question from the MoinMoin FAQ?
    336 ---------------------------------------------------------
     305----
     306
     307== Wiki == #wiki
     308
     309=== What is a "Wiki"? === #what-is-a-wiki
     310
     311The term Wiki is a shortened form of [http://c2.com/cgi/wiki?WikiWikiWeb WikiWikiWeb]. A Wiki is a database of pages that can be collaboratively edited using a web browser.
     312
     313See also: TracWiki
     314
     315
     316=== Did you copy the previous question from the MoinMoin FAQ? === #did-you-copy-the-previous-question-from-the-moinmoin-faq
     317
    337318Why yes, thanks for asking.
    338319
    339 How to add a new page to Wiki using the browser?
    340 ---------------------------------------------------------
     320=== How to add a new page to Wiki using the browser? === #how-to-add-a-new-page-to-wiki-using-the-browser
     321
    341322Just access the URL http://yourhost/trac/wiki/newpage
    342323and click on the "Edit This page link"
    343324
    344 How do I remove a page from the Wiki?
    345 ---------------------------------------------------------
     325
     326
     327=== How do I remove a page from the Wiki? === #how-do-i-remove-a-page-from-the-wiki
     328
    346329Users with the WIKI_DELETE permission can click the "Delete Page" button at the bottom of the page.
    347330
    348331The trac-admin utility can also remove Wiki pages like so:
    349332
    350 ::
    351 
     333{{{
    352334    trac-admin <yourprojenv> wiki remove PageName
    353 
    354 
    355 Does Trac support Unicode/UTF-8 or any other encodings?
    356 -------------------------------------------------------
    357 Yes, Trac uses UTF-8 internally for all text. See `TracUnicode`:trac: for a detailed description.
    358 
    359 How can I make links to files on the network via UNC path links?
    360 ----------------------------------------------------------------
    361 Make a wiki link that looks like [file:///%5C%5Cserver/path/to/file/readme.txt Readme].   In Mozilla or Firefox type about:config in your browser window and change security.checkloaduri to false.
     335}}}
     336
     337=== Does Trac support Unicode/UTF-8 or any other encodings? === #does-trac-support-unicode-utf-8-or-any-other-encodings
     338
     339Yes, Trac uses UTF-8 internally for all text. See TracUnicode for a detailed description.
     340
     341=== How can I make links to files on the network via UNC path links? === #how-can-i-make-links-to-files-on-the-network-via-unc-path-links
     342
     343Make a wiki link that looks like `[file:///%5C%5Cserver/path/to/file/readme.txt Readme]`.   In Mozilla or Firefox type `about:config` in your browser window and change security.checkloaduri to false.
    362344More info: http://tinyurl.com/4xg9c
    363345
    364 How do I see all pages that link to the current page?
    365 -----------------------------------------------------
    366 Currently you can use a 3rd party BackLinks_ `WikiMacro`:trac: to do this
    367 
    368 There is also ticket `#611`:trac: requesting this feature in Trac.
    369 
    370 .. _BackLinks: http://projects.edgewall.com/trac/wiki/MacroBazaar#BackLinks
    371 
    372 Is there a way to remove an attached file from a page?
    373 ------------------------------------------------------
     346=== How do I see all pages that link to the current page? === #how-do-i-see-all-pages-that-link-to-the-current-page
     347
     348Currently you can use a 3rd party MacroBazaar#BackLinks WikiMacro to do this
     349
     350There is also ticket #611 requesting this feature in Trac.
     351
     352=== Is there a way to remove an attached file from a page? === #is-there-a-way-to-remove-an-attached-file-from-a-page
    374353
    375354Users with WIKI_DELETE permissions can delete attachments.  To do this, login as the privileged user, click on the attachment.  The attachment page will now have a "Delete Attachment" button you can use to delete the attachment.  Note that is an irreversible operation.
    376355
    377 Is there a way to edit attachments?
    378 -----------------------------------
    379 Could I download attached file,  update it and upload it back with same name? See related `#948`:trac:.
    380 
    381 Can I convert MediaWiki pages to Trac?
    382 --------------------------------------
    383 You can use the mediawiki2trac.py script (attached to `TracWiki`:trac:) as a starting point. However, it would probably be better to write a `WikiProcessor`:trac: for the MediaWiki styles.
    384 
    385 Can I directly add questions to this Wiki FAQ?
    386 ----------------------------------------------
     356=== Is there a way to edit attachments? === #is-there-a-way-to-edit-attachments
     357
     358Could I download attached file,  update it and upload it back with same name? See related #948.
     359
     360=== Can I convert MediaWiki pages to Trac? === #can-i-convert-mediawiki-pages-to-trac
     361
     362You can use the mediawiki2trac.py script (attached to TracWiki)  as a starting point. However, it would probably be better to write a WikiProcessor for the MediaWiki styles.
     363
     364=== Can I directly add questions to this Wiki FAQ? === #can-i-directly-add-questions-to-this-wiki-faq
     365
     366
    387367Yes, you can! However, please don't add unanswered questions.  Good places to ask questions
    388 are the `MailingList`:trac: and the `IrcChannel`:trac:. 
    389 
    390 Just click *Edit this page* at the bottom of the page.
    391 Be aware that this page is written using reStructuredText_, so
    392 you may want to check `WikiRestructuredText`:trac: first...
    393 Thanks to ReST, the index for this FAQ is generated automatically,
    394 using the ``.. contents::`` directive.
    395 
    396 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
    397 
    398 But then how do we control spammers and malicious contributors?
    399 ---------------------------------------------------------------
     368are the MailingList and the IrcChannel. 
     369
     370Just click ''Edit this page'' at the bottom of the page.
     371
     372Please note that this page is '''no longer''' written using [http://docutils.sourceforge.net/rst.html reStructuredText]...
     373Thanks to the ![[PageOutline]] macro, the index for this FAQ is generated automatically.
     374
     375[[comment(well, I know, the equivalent to the ::sectnum feature is currently missing...)]]
     376
     377=== But then how do we control spammers and malicious contributors? === #but-then-how-do-we-control-spammers-and-malicious-contributors
     378
    400379I guess you would get an answer rapidly if you added a malicious contribution, and you just might get a bruise.
    401380
    402 
    403 -----
    404 
    405 .. ** TIMELINE **
    406 
    407 Timeline
    408 ========
    409 
    410 How do I get Trac to resync the timeline with my subversion repository?
    411 -----------------------------------------------------------------------
     381----
     382
     383== Timeline == #timeline
     384
     385=== How do I get Trac to resync the timeline with my subversion repository? === #how-do-i-get-trac-to-resync-the-timeline-with-my-subversion-repository
     386
    412387trac-admin in trac 0.8 and above has a built-in command to resync the repository that works like this.
    413 ::
    414 
     388
     389{{{
    415390  trac-admin <yourprojenv> resync
    416 
    417 -----
    418 
    419 .. ** BROWSER **
    420 
    421 Browser
    422 =======
     391}}}
     392
     393----
     394
     395== Browser == #browser
    423396   
    424 On Windows, why does Trac not display diffs?
    425 --------------------------------------------
     397=== On Windows, why does Trac not display diffs? === #on-windows-why-does-trac-not-display-diffs
     398
     399
    426400The tree diff functionality provided by the subversion python bindings use an
    427 external diff_ command. On UNIX-like systems, diff is usually installed already, so this wasn't an issue there. Installing diffutils_ should solve the problem.
     401external diff_ command. On UNIX-like systems, diff is usually installed already, so this wasn't an issue there. Installing [http://gnuwin32.sourceforge.net/packages/diffutils.htm diffutils] should solve the problem.
    428402
    429403After installing diffutils, you will need to add the path to the diff executable to the Windows PATH environment variable and reboot the machine.
    430404
    431 
    432 Diffutils for windows: http://gnuwin32.sourceforge.net/packages/diffutils.htm
    433 
    434 .. _diff: http://gnuwin32.sourceforge.net/packages/diffutils.htm
    435 .. _diffutils: http://gnuwin32.sourceforge.net/packages/diffutils.htm
    436 
    437 Does Trac support syntax coloring/highlighting of source code files?
    438 --------------------------------------------------------------------
    439 Yes, using several methods. See `TracSyntaxColoring`:trac: for details.
    440 
    441 -----
    442 
    443 .. ** TICKETS **
    444 
    445 Tickets
    446 =======
    447 
    448 Is there any way to remove tickets ?
    449 ------------------------------------
    450 You have to go through the db file in order to remove a ticket. No web interface is available for the moment (see `#298`:trac:).
    451 
    452 Is there any way to migrate tickets from one Trac installation to another?
    453 --------------------------------------------------------------------------
     405=== Does Trac support syntax coloring/highlighting of source code files? === #does-trac-support-syntax-coloring-highlighting-of-source-code-files
     406
     407Yes, using several methods. See TracSyntaxColoring for details.
     408
     409----
     410
     411== Tickets == #tickets
     412
     413=== Is there any way to remove tickets? === #is-there-any-way-to-remove-tickets
     414
     415
     416You have to go through the db file in order to remove a ticket. No web interface is available for the moment (see #298).
     417
     418=== Is there any way to migrate tickets from one Trac installation to another? === #is-there-any-way-to-migrate-tickets-from-one-trac-installation-to-another
     419
    454420For example, is it possible to import and export in the same way as one can using trac-admin for the wiki?
    455421
    456422A possible approach (until someone comes up with a better one?!) is to use the sqlite engine to export the tickets and changes, generate a script, and then insert the records into the second trac installation. E.g.:
    457423
    458 ::
    459 
     424{{{
    460425  [root@xgbemf6002 root]# sqlite <path/to/trac_project/db/trac.db>
    461426  SQLite version 2.8.15
    462427  Enter ".help" for instructions
    463428
    464 
    465 
    466429  sqlite> .output ticket.sql
    467430  sqlite> .dump ticket
     431}}}
    468432
    469433
     
    472436You will need to either drop the ticket table in your new installation or remove the "create table" statement out of the ticket.sql file.
    473437
    474 As provided below, the database schema can be found here_.
    475 
    476 .. _here: http://projects.edgewall.com/trac/file/trunk/trac/db_default.py?rev=latest
     438As provided below, the database schema can be found [http://projects.edgewall.com/trac/file/trunk/trac/db_default.py?rev=latest here]
    477439
    478440Moving from Win2k, SQLite 3 to Debian 3.1, SQLite 2 the following worked:
    479 
     441{{{
    480442sqlite3.exe e:\\project\\db\\trac.db .dump > c:\\project.sql
    481 
     443}}}
    482444copy this file and any attachments/templates to the new server.
    483 
     445{{{
    484446sqlite /new/project/db/trac.db
    485447
     
    487449
    488450.exit
    489 
     451}}}
    490452Move the other files into postion.
    491453Done!
    492454
    493 How can I associate usernames (e.g. for assigned tickets) with email addresses for notification?
    494 -------------------------------------------------------------------------------------------------
     455=== How can I associate usernames (e.g. for assigned tickets) with email addresses for notification? === #how-can-i-associate-usernames-e-g-for-assigned-tickets-with-email-addresses-for-notification
     456
    495457In version 0.9 Trac will use the email address from the Settings page for authenticated users.
    496458
    497 Can Trac automatically update a ticket when I commit a changeset?
    498 -----------------------------------------------------------------
    499 Yes, you can setup Subversion to update the Trac ticket when you commit changes with a message listing tickets that are fixed or related.  You can read the comments in the beginning of the file contrib/trac-post-commit-hook  http://projects.edgewall.com/trac/file/trunk/contrib/trac-post-commit-hook for more information on how to set this up.
    500 
    501 If you are using a stable version rather than the latest development version you should instead get the script which matches your release - for example http://projects.edgewall.com/trac/file/branches/0.8-stable/contrib/trac-post-commit-hook
     459=== Can Trac automatically update a ticket when I commit a changeset? === #can-trac-automatically-update-a-ticket-when-i-commit-a-changeset
     460
     461Yes, you can setup Subversion to update the Trac ticket when you commit changes with a message listing tickets that are fixed or related.  You can read the comments in the beginning of the file contrib/trac-post-commit-hook  source:/trunk/contrib/trac-post-commit-hook for more information on how to set this up.
     462
     463If you are using a stable version rather than the latest development version you should instead get the script which matches your release - for example source:/branches/0.9-stable/contrib/trac-post-commit-hook
    502464
    503465If the trac-post-commit-hook script does not appear to be working, for some extra clues try running it from the command-line using the account normally used to run it and without an environment (as it's normally executed).
    504466Change to the relevant user and execute the following from the subversion repository hooks directory:
    505 
     467{{{
    506468env - ./post-commit /svn/test 7
    507 
     469}}}
    508470This will also check your subversion hook is calling trac-post-commit-hook.
    509471
    510472If the results give you something like this:
    511 
     473{{{
    512474"ImportError: no module named trac.env"
    513 
     475}}}
    514476then it's likely python has not been found properly by line 1 of trac-post-commit-hook, so change line 1 to suit your system, such as:
     477{{{
    515478
    516479#!/usr/local/bin/python
    517 
    518 If it runs manually but not from Subversion, make sure first line in script post-commit (for linux) is "#!/bin/sh" (does not show in example script).
    519 
    520 We're already using Bugzilla, can I disable tickets?
    521 ----------------------------------------------------
    522 Use `TracAdmin`:trac: and disable the permissions for tickets:
    523 
    524 ::
    525 
     480}}}
     481If it runs manually but not from Subversion, make sure first line in script post-commit (for linux) is `#!/bin/sh` (does not show in example script).
     482
     483=== We're already using Bugzilla, can I disable tickets? === #we-re-already-using-bugzilla-can-i-disable-tickets
     484
     485
     486Use TracAdmin and disable the permissions for tickets:
     487
     488{{{
    526489  trac-admin </path/to/projenv> permission remove TICKET_VIEW TICKET_CREATE TICKET_MODIFY TICKET_ADMIN
    527 
    528 
    529 Microsoft Outlook displays ticket notification mails in a non-monospace font, how do I change that?
    530 ---------------------------------------------------------------------------------------------------
     490}}}
     491
     492=== Microsoft Outlook displays ticket notification mails in a non-monospace font, how do I change that? === #microsoft-outlook-displays-ticket-notification-mails-in-a-non-monospace-font-how-do-i-change-that
     493
    531494Outlook can be configured to use a monospace font by going to
    532 Tools --> Options... --> Email format --> Fonts ... --> International Fonts.
     495Tools -> Options... -> Email format -> Fonts ... -> International Fonts.
    533496Highlight Unicode in the language list, select Courier New as the proportional font, and select Unicode (UTF-8) as encoding.
    534497
    535 -----
    536 
    537 .. ** REPORTS **
    538 
    539 Reports
    540 =======
    541 
    542 
    543 Is there any way to remove reports?
    544 -----------------------------------
    545 Yes, if you have the proper permissions, you should be able to delete a report simply by viewing it and clicking *delete*.
    546 
    547 -----
    548 
    549 .. ** DEVELOPMENT **
    550 
    551 Development
    552 ===========
    553 
    554 How can I contribute to the project?
    555 ------------------------------------
     498----
     499
     500== Reports ==
     501
     502
     503== Is there any way to remove reports? == #is-there-any-way-to-remove-reports
     504
     505Yes, if you have the proper permissions, you should be able to delete a report simply by viewing it and clicking ''Delete''.
     506
     507----
     508
     509
     510== Development ==
     511
     512=== How can I contribute to the project? === #how-can-i-contribute-to-the-project
     513
    556514There are several ways to contribute, including submitting patches, sending feedback and reporting bugs.
    557 For details, see `HowToContribute`:trac:.
    558 
    559 
    560 Are there any provisions for I18N and L10N? Is it enough to translate the templates?
    561 ------------------------------------------------------------------------------------
    562 Yes and no. Merely translating the templates is not enough to provide complete internationalization of Trac. Python supports gettext_ just fine, but templates might require some extra work, using Clearsilver's built-in `trans.py`_ mechanism or the new `gettext patch`_.
    563 
    564 The standpoint of the `TracTeam`:trac: right now is to postpone translation efforts until the feature base and source code has stabilized somewhat, so as to not add too much extra work until 1.0.
    565 
    566 That said, people have already started looking into it, and making some good suggestions already. We will need help with translation efforts. If you're interested in volunteering, please consider joining `the mailing list`_.
    567 
    568 See also `TracL10N`:trac:.
    569 
    570 .. _gettext: http://www.gnu.org/software/gettext/gettext.html
    571 .. _`trans.py`: http://groups.yahoo.com/group/ClearSilver/message/211
    572 .. _`gettext patch`: http://groups.yahoo.com/group/ClearSilver/message/210
    573 .. _`the mailing list`: http://projects.edgewall.com/trac/wiki/MailingList
    574 
    575 
    576 Is the Database schema available anywhere?
    577 ------------------------------------------
    578 In Trac 0.8.x and below the schema is available in http://projects.edgewall.com/trac/file/branches/0.8-stable/trac/db_default.py
     515For details, see HowToContribute.
     516
     517
     518=== Are there any provisions for I18N and L10N? Is it enough to translate the templates? === #are-there-any-provisions-for-i18n-and-l10n-is-it-enough-to-translate-the-templates
     519
     520Yes and no. Merely translating the templates is not enough to provide complete internationalization of Trac. Python supports [http://www.gnu.org/software/gettext/gettext.html gettext] just fine, but templates might require some extra work, using Clearsilver's built-in [http://groups.yahoo.com/group/ClearSilver/message/211 trans.py] mechanism or the new [http://groups.yahoo.com/group/ClearSilver/message/210 gettext patch].
     521
     522The standpoint of the TracTeam right now is to postpone translation efforts until the feature base and source code has stabilized somewhat, so as to not add too much extra work until 1.0.
     523
     524That said, people have already started looking into it, and making some good suggestions already. We will need help with translation efforts. If you're interested in volunteering, please consider joining [MailingList the mailing list].
     525
     526See also TracL10N.
     527
     528=== Is the Database schema available anywhere? === #is-the-database-schema-available-anywhere
     529
     530In Trac 0.8.x and below the schema is available in source:branches/0.8-stable/trac/db_default.py
    579531
    580532Trac no longer has the schema in plain SQL since it was necessary to abstract the table creation
    581 in order to support other database platforms.  However, the structure in db_default.py_ still provides
     533in order to support other database platforms.  However, the structure in [source:trunk/trac/db_default.py db_default.py] still provides
    582534a representation of the schema.
    583535
    584 .. _db_default.py: http://projects.edgewall.com/trac/file/trunk/trac/db_default.py?rev=latest
    585 
    586536To get a definitive schema for your install:
    587537
    588 ::
    589 
     538{{{
    590539  prompt> sqlite3 /path/to/tracdata/yourinstance/db/trac.db
    591540  sqlite> .schema
    592 
    593 
    594 -----
    595 
    596 .. ** MISCELLANEOUS **
    597 
    598 Miscellaneous
    599 =============
    600 
    601 Is it possible to disable the version control component?
    602 --------------------------------------------------------
    603 
     541}}}
     542
     543----
     544
     545== Miscellaneous == #miscellaneous
     546
     547=== Is it possible to disable the version control component? === #is-it-possible-to-disable-the-version-control-component
    604548
    605549Some users prefer to use Trac as an issue-tracker and Wiki and thus don't require the version control subsystem.  When initializing a project's environment with *trac-admin* specify /dev/null or some other path for the repository directory.  Then add the following to project/conf/trac.ini:
    606 ::
    607 
     550{{{
    608551   [components]
    609552   trac.versioncontrol.* = disabled
    610 
    611 How do I create or change a milestone with an associated date?
    612 --------------------------------------------------------------
    613 
    614 
    615 Using *trac-admin*, specifically the *milestone time* or *milestone add* command. The input format for the date is rather limited still, and should be a string like this: 'Jun 3, 2003'. Note the string **must** be quoted for proper parsing.
     553}}}
     554
     555=== How do I create or change a milestone with an associated date? === #how-do-i-create-or-change-a-milestone-with-an-associated-date
     556
     557Using `trac-admin`, specifically the `milestone time` or `milestone add` command. The input format for the date is rather limited still, and should be a string like this: `'Jun 3, 2003'`. Note the string '''must''' be quoted for proper parsing.
    616558Example:
    617 ::
    618 
     559{{{
    619560  trac-admin myprojenv milestone add anniversary 'Jun 3, 2003'
    620 
    621 Can I use Trac with other version control systems (CVS, Arch, etc.)?
    622 ------------------------------------------------------------------------------
    623 
    624 Currently only Subversion is supported, but Trac will probably support other systems in the future.  See discussion of this on `VersioningSystemBackend`:trac:
    625 
    626 Also, CVSTrac_ is a similar, but far simpler system which can track a CVS repository
    627 
    628 .. _CVSTrac: http://www.cvstrac.org/
    629 
    630 
    631 Can I use LDAP to manage user accounts?
    632 ---------------------------------------
    633 Apache supports LDAP authentication with mod_auth_ldap_.  You can use this in place of the other authenticate methods used in the installation guides.  It may be easier, however, depending on your installation, to use mod_auth_pam_ with Apache and configure PAM to use LDAP for authentication.
    634 
    635 You can use LDAP to manage your Trac groups and permissions with the LdapPlugin_
    636 
    637 .. _LdapPlugin: http://trac-hacks.swapoff.org/wiki/LdapPlugin
    638 .. _mod_auth_ldap: http://httpd.apache.org/docs-2.0/mod/mod_auth_ldap.html
    639 .. _mod_auth_pam: http://pam.sourceforge.net/mod_auth_pam/
    640 
    641 See also: `TracGuide`:trac:, `TitleIndex`:trac:
    642 
    643 -----
    644 
    645 .. ** TROUBLE SHOOTING **
    646 
    647 Internet explorer will not upload (multiple) files when Trac is used over SSL (Apache server only)
    648 --------------------------------------------------------------------------------------------------
    649 Intnernet explorer is not too keen on obeying rules. Try to add this line in your httpd.conf:
     561}}}
     562
     563=== Can I use Trac with other version control systems (CVS, Arch, etc.)? === #can-i-use-trac-with-other-version-control-systems-cvs-arch-etc
     564
     565Currently only Subversion is supported, but Trac will probably support other systems in the future.  See discussion of this on VersioningSystemBackend.
     566
     567Also, [http://www.cvstrac.org/ CVSTrac] is a similar, but far simpler system which can track a CVS repository
     568
     569
     570=== Can I use LDAP to manage user accounts? === #can-i-use-ldap-to-manage-user-accounts
     571
     572Apache supports LDAP authentication with [http://httpd.apache.org/docs-2.0/mod/mod_auth_ldap.html mod_auth_ldap].  You can use this in place of the other authenticate methods used in the installation guides.  It may be easier, however, depending on your installation, to use [http://pam.sourceforge.net/mod_auth_pam/ mod_auth_pam] with Apache and configure PAM to use LDAP for authentication.
     573
     574You can use LDAP to manage your Trac groups and permissions with the TracHacks:LdapPlugin.
     575
     576See also: TracGuide, TitleIndex
     577
     578----
     579
     580== Trouble-shooting ==
     581
     582=== Internet explorer will not upload (multiple) files when Trac is used over SSL (Apache server only) === #internet-explorer-will-not-upload-multiple-files-when-trac-is-used-over-ssl-apache-server-only
     583
     584Internet explorer is not too keen on obeying rules. Try to add this line in your httpd.conf:
     585{{{
    650586SetEnvIf User-Agent ".*MSIE.*" nokeepalive ssl-unclean-shutdown downgrade-1.0 force-response-1.0
     587}}}
     588
    651589See also: http://www.modssl.org/docs/2.7/ssl_faq.html#ToC48
    652 
    653 
    654 }}}