Changes between Initial Version and Version 1 of TracChangeFileBiffPlugin


Ignore:
Timestamp:
Mar 31, 2014, 7:13:50 AM (9 months ago)
Author:
t2y
Comment:

added initial document

Legend:

Unmodified
Added
Removed
Modified
  • TracChangeFileBiffPlugin

    v1 v1  
     1[[PageOutline(2-5,Contents,pullout)]]
     2
     3= Provides a feature like [http://en.wikipedia.org/wiki/Biff Biff] for file in repository =
     4
     5== Description ==
     6
     7TracChangeFileBiffPlugin is useful to query or monitor certain file in the repository when someone will update it.
     8
     9Note: TracChangeFileBiffPlugin requires Trac 1.0 or higher since it uses
     10the `list` format of text type. ([http://trac.edgewall.org/wiki/TracTicketsCustomFields TracTicketsCustomFields])
     11
     12
     13=== Features ===
     14
     15 - Provides a feature like [http://en.wikipedia.org/wiki/Biff Biff] for file in repository
     16
     17
     18== Configuration ==
     19
     201. Enable TracChangeFileBiffPlugin in Plugins page.
     21
     222. '''''Access to File Biff admin panel'''''
     23
     24The option of `ticket-custom` section would be added when you access to File Biff admin page like this.
     25
     26 {{{#!ini
     27[ticket-custom]
     28filebiff = text
     29filebiff.format = list
     30filebiff.label = Biff       ; change filed label as you like
     31filebiff.multiple = true    ; this option is used by TracMultiSelectBoxPlugin
     32filebiff.options =          ; will be set when you configure File Biff settings
     33filebiff.size = 3           ; this option is used by TracMultiSelectBoxPlugin
     34}}}
     35
     363. '''''Configure a File Biff settings'''''
     37
     38 [[Image(trac-plugin-changefilebiff-admin1.png)]]
     39
     40Specification:
     41
     42- White-space is not allowed to include into Name
     43- Cc and Filename are configured multiple values separated by comma.
     44- The glob pattern for Filename is allowed with [https://docs.python.org/2/library/fnmatch.html fnmatch module].
     45
     46Added `[changefilebiff]` section after you configured File Biff settings like this.
     47
     48 {{{#!ini
     49[changefilebiff]
     50biff.2e320ca20d1aed6a.cc = user1
     51biff.2e320ca20d1aed6a.filename = *.txt, *.text
     52biff.2e320ca20d1aed6a.name = text-files
     53biff.319ddde3cb437ffc.cc = user2, guest1
     54biff.319ddde3cb437ffc.filename = *.properties
     55biff.319ddde3cb437ffc.name = property-files
     56biff.dd487b83e5e76d08.cc = user1, user2
     57biff.dd487b83e5e76d08.filename = *.gif, *.png, *.jpg
     58biff.dd487b83e5e76d08.name = Image-files
     59biff_keys = dd487b83e5e76d08, 319ddde3cb437ffc, 2e320ca20d1aed6a
     60}}}
     61
     62
     63== Example ==
     64
     65'''''set Biff value automatically when a user committed into the repository'''''
     66[[BR]][[BR]]
     67[[Image(trac-plugin-changefilebiff-ticket1.png)]]
     68
     69[[Image(trac-plugin-changefilebiff-ticket2.png)]]
     70
     71
     72== Operation Tips ==
     73
     74=== integrate TracMultiSelectBoxPlugin ===
     75
     76To integrate TracMultiSelectBoxPlugin is good practice for ticket maintenance like this.
     77[[BR]][[BR]]
     78[[Image(trac-plugin-changefilebiff-ticket-with-msb1.png)]]
     79
     80
     81== Bugs/Feature Requests ==
     82
     83Existing bugs and feature requests for TracChangeFileBiffPlugin are
     84[https://bitbucket.org/t2y/trac.plugins.changefilebiff/issues here].
     85
     86If you have any issues, create a
     87[https://bitbucket.org/t2y/trac.plugins.changefilebiff/issues/new new ticket].
     88
     89
     90== Download ==
     91
     92Download the archived source from [http://pypi.python.org/pypi/TracChangeFileBiffPlugin here].
     93
     94
     95== Source ==
     96
     97You can clone TracChangeFileBiffPlugin from [https://bitbucket.org/t2y/trac.plugins.changefilebiff/ here] using Mercurial, or [https://bitbucket.org/t2y/trac.plugins.changefilebiff/src browse the source].
     98
     99
     100== Recent Changes ==
     101
     102See https://bitbucket.org/t2y/trac.plugins.changefilebiff/commits.
     103
     104
     105== Author/Contributors ==
     106
     107'''Author:''' [wiki:t2y] [[BR]]
     108'''Maintainer:''' [wiki:t2y] [[BR]]
     109'''Contributors:'''