Edgewall Software

Changes between Version 29 and Version 30 of TracBrowser


Ignore:
Timestamp:
Apr 10, 2010, 5:46:17 PM (14 years ago)
Author:
Christian Boos
Comment:

copied from 0.12/TracBrowser@8

Legend:

Unmodified
Added
Removed
Modified
  • TracBrowser

    v29 v30  
     1** Note: this page documents the 0.12 version of Trac, see [[0.11/TracBrowser]] if you need the previous version **
     2
    13= The Trac Repository Browser =
    24[[TracGuideToc]]
    35
    46The Trac repository browser can be used to browse specific revisions of directories
    5 and files stored in the repository of the configured version control system.
     7and files stored in the repositories associated with the Trac environment.
     8
     9''(since 0.12)'':
     10At the top-level of the repository browser is the '''Repository Index''',
     11listing all the configured repositories.
     12Each repository has a name which is used as a path prefix in a
     13"virtual" file hierarchy encompassing all the available repositories.
     14If a default repository has been configured, its top-level files and directories
     15are also listed, in a '''Default Repository''' section placed before the
     16repository index. If the default repository is the only repository associated
     17with the Trac environment the '''Repository Index''' will be omitted ^[#note-multirepos (1)]^.
    618
    719Directory entries are displayed in a list with sortable columns. The list
    8 entries can be sorted by ''name'', ''size'' or ''age'' by clicking on the column
     20entries can be sorted by ''Name'', ''Size'', ''Age'' or ''Author'' by clicking on the column
    921headers. The sort order can be reversed by clicking on a given column
    1022header again.
    1123
    1224The browser can be used to navigate through the directory structure
    13 by clicking on the directory names. Clicking on a file name will show
    14 the contents of the file. Clicking on the revision number of a file or
    15 directory will take you to the TracRevisionLog for that file.
    16 Note that there's also a ''Revision Log'' navigation link that will do
    17 the same for the path currently being examined.
     25by clicking on the directory names.
     26Clicking on a file name will show the contents of the file.
     27Clicking on the revision number of a file or directory will take
     28you to the TracRevisionLog for that file.
     29Note that there's also a ''Revision Log'' navigation link that will do the
     30same for the path currently being examined.
     31Clicking on the ''diff'' icon after revision number will display the changes made
     32to the files modified in that revision.
     33Clicking on the ''Age'' of the file - will take you to that changeset in the timeline.
    1834
    1935It's also possible to browse directories or files as they were in history,
     
    2238the ''View revision'' input field at the top of the page.
    2339
    24 ''(since 0.11)'':
     40The color bar next to the ''Age'' column gives a visual indication of the age
     41of the last change to a file or directory, following the convention that
     42'''[[span(style=color:#88f,blue)]]''' is oldest and '''[[span(style=color:#f88,red)]]'''
     43is newest, but this can be [TracIni#browser-section configured].
    2544
    26 The color bar next to the Age column gives a visual indication of the age
    27 of the last change to a file or directory. In the default configuration,
    28 blue is older and red is newer, but this can be [TracIni#browser-section configured].
    29 
    30 At the top of the browser page, there's a drop-down menu which you can use
     45At the top of the browser page, there's a ''Visit'' drop-down menu which you can use
    3146to select some interesting places in the repository, for example branches or tags.
    3247This is sometimes referred to as the ''browser quickjump'' facility.
    33 The precise meaning and content of this menu depends on your backend.
    34 For Subversion, this list contains by default the top-level trunk directory and sub-directories of the top-level branches and tags directories (`/trunk`, `/branches/*`, and `/tags/*`).  This can be [TracIni#svn-section configured] for more advanced cases.
     48The precise meaning and content of this menu depends on your repository backend.
     49For Subversion, this list contains by default the top-level trunk directory
     50and sub-directories of the top-level branches and tags directories
     51(`/trunk`, `/branches/*`, and `/tags/*`).  This can be [TracIni#svn-section configured]
     52for more advanced cases.
    3553
    36 If you're using a Javascript enabled browser, you'll be able to expand and collapse folders in-place by clicking on the arrow head at the right side of a folder. Alternatively, the [trac:TracKeys keyboard] can also be used for this: use 'j' and 'k' to go to the next or previous entry, and 'o' (or 'Enter') to toggle between expanded and collapsed state of the selected folder or for visiting the selected file.
     54If you're using a Javascript enabled browser, you'll be able to expand and
     55collapse directories in-place by clicking on the arrow head at the right side of a
     56directory. Alternatively, the [trac:TracKeys keyboard] can also be used for this:
     57 - use `'j'` and `'k'` to select the next or previous entry, starting with the first
     58 - `'o'` (open) to toggle between expanded and collapsed state of the selected
     59   directory or for visiting the selected file
     60 - `'v'` (view, visit) and `'<Enter>'`, same as above
     61 - `'r'` can be used to force the reload of an already expanded directory
     62 - `'A'` can be used to directly visit a file in annotate (blame) mode
     63 - `'L'` to view the log for the selected entry
     64If no row has been selected using `'j'` or `'k'` these keys will operate on the entry under the mouse .
    3765
    38 For the Subversion backend, some additional features are available:
    39  - Displays the `svn:needs-lock` property
    40  - Support for the `svn:externals` property (which can be [TracIni#svn:externals-section configured])
    41  - The `svn:mime-type` property is used to select the syntax highlighter for rendering the file. For example, setting `svn:mime-type` to `text/html` will ensure the file is highlighted as HTML, regardless of the file extension. It also allows selecting the character encoding used in the file content. For example, if the file content is encoded in UTF-8, set `svn:mime-type` to `text/html;charset=utf-8`. The `charset=` specification overrides the default encoding defined in the `default_charset` option of the `[trac]` section of [TracIni#trac-section trac.ini].
     66{{{#!comment
     67MMM: I guess that some keys are upper case and some lower to avoid conflicts with browser defined keys.
     68I find for example in Firefox and IE on windows that 'a' works as well as 'A' but 'l' does not work for 'L'.
     69 cboos: 'l' is reserved for Vim like behavior, see #7867
     70}}}
     71
     72For the Subversion backend, some advanced additional features are available:
     73 - The `svn:needs-lock` property will be displayed
     74 - Support for the `svn:mergeinfo` property showing the merged and eligible information
     75 - Support for browsing the `svn:externals` property
     76   (which can be [TracIni#svn:externals-section configured])
     77 - The `svn:mime-type` property is used to select the syntax highlighter for rendering
     78   the file. For example, setting `svn:mime-type` to `text/html` will ensure the file is
     79   highlighted as HTML, regardless of the file extension. It also allows selecting the character
     80   encoding used in the file content. For example, if the file content is encoded in UTF-8,
     81   set `svn:mime-type` to `text/html;charset=utf-8`. The `charset=` specification overrides the
     82   default encoding defined in the `default_charset` option of the `[trac]` section
     83   of [TracIni#trac-section trac.ini].
     84{{{#!comment
     85MMM: I found this section a bit hard to understand. I changed the first item as I understood that well.
     86but I think the other items could be changed also
     87 cboos: in the meantime, I've added the ''advanced'' word as a hint this can be a bit complex...
     88}}}
     89
    4290
    4391----
     92{{{#!div style="font-size:85%"
     93[=#note-multirepos (1)] -  This means that after upgrading a single-repository Trac of version
     940.11 (or below) to a multi-repository Trac (0.12), the repository browser will look and feel
     95the same, that single repository becoming automatically the "default" repository.
     96}}}
     97
    4498See also: TracGuide, TracChangeset, TracFineGrainedPermissions