Edgewall Software

Changes between Version 38 and Version 39 of 0.12/TracFaq


Ignore:
Timestamp:
May 14, 2004, 5:32:39 PM (20 years ago)
Author:
daniel
Comment:

Converted FAQ to ReStructuredText

Legend:

Unmodified
Added
Removed
Modified

  • 0.12/TracFaq

    v38 v39  
    1 = Frequently Asked Questions =
     1{{{
     2#!rst
     3========
     4Trac FAQ
     5========
     6Here you can find the answer to some of the most frequently asked questions about Trac. If you a question not answered by this page you can add your question by clicking on the "Edit this page" link at the bottom of this page.
    27
    3 Here  you can find the answer to some of the most frequently asked questions about Trac.
    4 If you a question not answered by this page you can add your question by clicking on the
    5 "''Edit this page''" link at the bottom of this page.
     8.. contents::
     9.. sectnum::
    610
    7 ----
    8 == 1. Installing and Running Trac ==
    9  '''1.1. What operating systems does Trac run on?'''
    10    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, NetBSD and  MS Windows.
    11 [[br]]See also: TracOnNetBsd, TracOnOsx, TracOnMandrakelinux, TracOnGentoo, TracOnDebian
     11-----
    1212
    13  '''1.2. What are the dependencies of Trac?'''
    14    Trac depends on the following software: [http://subversion.tigris.org/ Subversion w/Python bindings], [http://www.clearsilver.net/ Clearsilver], [http://www.sqlite.org SQLite w/Python bindings].
    15 Syntax coloring requires [http://people.ssh.fi/mtr/genscript/ GNU Enscript] and/or [http://silvercity.sf.net SilverCity].
    16 [[br]]See also: TracInstall, TracSyntaxColoring.
     13.. ** INSTALLING AND RUNNING TRAC **
    1714
    18  '''1.3. Can I manage multiple projects from a single installation of Trac or do I have to setup a different directory for each one?'''
     15Installing and Running Trac
     16===========================
    1917
    20 ----
    21 == 2. Wiki ==
    22  '''2.1. What is a "Wiki"?'''
    23    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.
    24 [[br]]See also: TracWiki
     18What operating systems does Trac run on?
     19----------------------------------------
     20Trac will run on any system supported by Python and the depending modules. Today we are aware of people running Trac on various
     21Linux distributions, Mac OS X, NetBSD and MS Windows.
    2522
    26  '''2.2. Did you copy the previous question from the [http://moinmoin.wikiwikiweb.de/MoinMoinFaq MoinMoin FAQ]?'''
    27    Why yes, thanks for asking.
     23  See also: `TracOnNetBsd`:trac: , `TracOnOsx`:trac:, `TracOnMandrakelinux`:trac:, `TracOnGentoo`:trac:, `TracOnDebian`:trac:
    2824
    29  '''2.3. Could the Wiki perhaps get a RecentChanges page, showing the changed pages in anti-chronological order?'''
    30    The [http://projects.edgewall.com/trac/timeline/ timeline] contains information about all the changes to Trac content.  By deselecting the ''view ticket changes'' and ''view repository checkins'' boxes you can view only the Wiki changes.
    3125
    32  '''2.4. I get the following error message when editing a wiki page with Trac 0.6.1:'''
    33 {{{
    34 columns name, version are not unique
     26What are the dependencies of Trac?
     27----------------------------------
     28Trac depends on the following software: Subversion w/Python bindings, Clearsilver_, `SQLite w/Python bindings`_. Syntax coloring requires `GNU Enscript`_ and/or SilverCity_.
     29
     30  See also: `TracInstall`:trac:, `TracSyntaxColoring`:trac:.
     31
     32.. _Clearsilver:  http://www.clearsilver.net/
     33.. _`SQLite w/Python bindings`:  http://www.sqlite.org/
     34.. _`GNU Enscript`:  http://people.ssh.fi/mtr/genscript/
     35.. _SilverCity:  http://silvercity.sf.net/
     36
     37-----
     38
     39.. ** WIKI **
     40
     41Wiki
     42====
     43
     44What is a "Wiki"?
     45-----------------
     46The term Wiki is a shortened form of WikiWikiWeb_. A Wiki is a database of pages that can be collaboratively edited using a web browser.
     47
     48See also: `TracWiki`:trac:
     49
     50.. _WikiWikiWeb: http://c2.com/cgi/wiki?WikiWikiWeb
     51
     52
     53Did you copy the previous question from the MoinMoin FAQ
     54---------------------------------------------------------
     55Why yes, thanks for asking.
     56
     57
     58Could the Wiki perhaps get a RecentChanges page, showing the changed pages in anti-chronological order?
     59-------------------------------------------------------------------------------------------------------
     60The timeline_ contains information about all the changes to Trac content. By deselecting the *view ticket changes* and *view repository checkins* boxes you can view only the Wiki changes.
     61
     62.. _timeline: http://projects.edgewall.com/trac/timeline/
     63
     64
     65I get the following error message when editing a wiki page with Trac 0.6.1:
     66---------------------------------------------------------------------------
     67::
     68
     69  columns name, version are not unique
     70
     71SQLite_ version 2.8.13 has a bug in the max() function. Either downgrade/upgrade sqlite or replace trac/Wiki.py with this file: Wiki.py_
     72
     73.. _SQLite: http://www.sqlite.org/
     74.. _Wiki.py: http://svn.edgewall.com/repos/trac/branches/0.6-stable/trac/Wiki.py
     75
     76
     77Does Trac support Unicode/UTF-8 or any other encodings?
     78-------------------------------------------------------
     79Yes, Trac uses UTF-8 internally for all text. See `TracUnicode`:trac: for a detailed description.
     80
     81
     82Can I directly add questions to this Wiki FAQ?
     83----------------------------------------------
     84Yes, I can! Just click *Edit this page* at the bottom of the page.
     85
     86
     87But then how do we control spammers and malicious contributors?
     88---------------------------------------------------------------
     89I guess you would get an answer rapidly if you added a malicious contribution, and you just might get a bruise.
     90
     91-----
     92
     93.. ** BROWSER **
     94
     95Browser
     96=======
     97   
     98On Windows, why does Trac not display diffs?
     99--------------------------------------------
     100Early versions of Subversion used an (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, but a better solution would be to upgrade to the latest Subversion_, which now uses an internal diff library.
     101
     102.. _Subversion: http://subversion.tigris.org/
     103
     104
     105Does Trac support syntax coloring/highlighting of source code files?
     106--------------------------------------------------------------------
     107Yes, using several methods. See `TracSyntaxColoring`:trac: for details.
     108
     109-----
     110
     111.. ** TICKETS **
     112
     113Tickets
     114=======
     115
     116Is there any way to remove tickets ?
     117------------------------------------
     118You have to go through the db file in order to remove a ticket. No web interface is available for the moment (but there is a `ticket:298`:trac: regarding it).
     119
     120-----
     121
     122.. ** REPORTS **
     123
     124Reports
     125=======
     126
     127Is there any way to remove reports?
     128-----------------------------------
     129Yes, if you have the proper permissions, you should be able to delete a report simply by viewing it and clicking *delete*.
     130
     131-----
     132
     133.. ** DEVELOPMENT **
     134
     135Development
     136===========
     137
     138How can i contribute to the project?
     139------------------------------------
     140There are several ways to contribute, including submitting patches, sending feedback and reporting bugs.
     141For details, see `HowToContribute`:trac:.
     142
     143-----
     144
     145.. ** MISCELLANEOUS **
     146
     147Miscellaneous
     148=============
     149
     150What is a typical use-case for trac? Why/when would I want to use it?
     151---------------------------------------------------------------------
     152*Note:* in the gist, this boils down to 'what is trac?' and should rather be the first question IMHO.
     153
     154
     155How do I create or change a milestone with an associated date?
     156--------------------------------------------------------------
     157Using *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.
     158Example:
     159::
     160
     161  trac-admin myprojenv milestone add anniversary 'Jun 3, 2003'
     162
     163-----
     164
     165See also: `TracGuide`:trac:, `TitleIndex`:trac:
    35166}}}
    36    [http://sqlite.org/ sqlite] version 2.8.13 has a bug in the {{{max()}}} function. Either downgrade/upgrade sqlite
    37 or replace trac/Wiki.py with this file: [http://svn.edgewall.com/repos/trac/branches/0.6-stable/trac/Wiki.py Wiki.py]
    38 
    39  '''2.5. Does Trac support Unicode/UTF-8 or any other encodings?'''
    40    Yes, Trac uses UTF-8 internally for all text. See TracUnicode for a detailed description.
    41 
    42  '''2.6. Can I directly add questions to this Wiki FAQ?'''
    43    Yes, I can!
    44 
    45  '''2.7. But then how do we control spammers and malicious contributors?'''
    46    I guess I would get an answer rapidely if I added a malicious contribution...
    47 
    48 ----
    49 == 3. Browser ==
    50  '''3.1. On Windows, why does Trac not display diffs?'''
    51    Early versions of Subversion used an (external) ''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, but a better solution would be to upgrade to the latest Subversion [http://subversion.tigris.org/], which now uses an internal diff library.
    52 
    53  '''3.2. Does Trac support syntax coloring/highlighting of source code files?'''
    54    Yes, using several methods. See TracSyntaxColoring for details.
    55  
    56 ----
    57 == 4. Tickets ==
    58  '''4.1. Is there any way to remove tickets ?'''
    59    You have to go through the db file in order to remove a ticket. No web interface is available for the moment (but there is a ticket:298 about that yet).
    60 
    61 ----
    62 == 5. Reports ==
    63  '''5.1. Is there any way to remove reports ?'''
    64 
    65 ----
    66 == 6. Development ==
    67 
    68 ----
    69 == 7. Miscellaneous ==
    70  '''7.1 What is a typical use-case for trac? Why/when would I want to use it?'''
    71    ''Note: in the gist, this boils down to 'what is trac?' and should rather be 1.1 than 7.1 IMHO.''
    72 
    73  '''7.2. How do I create or change a milestone with an associated date?'''
    74    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. Example:
    75 {{{
    76 trac-admin myprojenv milestone add anniversary 'Jun 3, 2003'
    77 }}}
    78 
    79 ----
    80 See also:  TracGuide, TitleIndex