[[PageOutline(2-5,Contents,pullout)]]

= Provides a feature like [http://en.wikipedia.org/wiki/Biff Biff] for file in repository = 

== Description ==

TracChangeFileBiffPlugin is useful to query or monitor certain file in the repository when someone will update it.

Note: TracChangeFileBiffPlugin requires Trac 1.0 or higher since it uses
the `list` format of text type. ([http://trac.edgewall.org/wiki/TracTicketsCustomFields TracTicketsCustomFields])


=== Features ===

 - Provides a feature like [http://en.wikipedia.org/wiki/Biff Biff] for file in repository


== Configuration ==

1. Enable TracChangeFileBiffPlugin in Plugins page.

2. '''''Access to File Biff admin panel'''''

The option of `ticket-custom` section would be added when you access to File Biff admin page like this.

 {{{#!ini
[ticket-custom]
filebiff = text
filebiff.format = list
filebiff.label = Biff       ; change filed label as you like
filebiff.multiple = true    ; this option is used by TracMultiSelectBoxPlugin
filebiff.options =          ; will be set when you configure File Biff settings
filebiff.size = 3           ; this option is used by TracMultiSelectBoxPlugin
}}}

3. '''''Configure a File Biff settings'''''

 [[Image(trac-plugin-changefilebiff-admin1.png)]]

Specification:

- White-space is not allowed to include into Name
- Cc and Filename are configured multiple values separated by comma.
- The glob pattern for Filename is allowed with [https://docs.python.org/2/library/fnmatch.html fnmatch module].

Added `[changefilebiff]` section after you configured File Biff settings like this.

 {{{#!ini
[changefilebiff]
biff.2e320ca20d1aed6a.cc = user1
biff.2e320ca20d1aed6a.filename = *.txt, *.text
biff.2e320ca20d1aed6a.name = text-files
biff.319ddde3cb437ffc.cc = user2, guest1
biff.319ddde3cb437ffc.filename = *.properties
biff.319ddde3cb437ffc.name = property-files
biff.dd487b83e5e76d08.cc = user1, user2
biff.dd487b83e5e76d08.filename = *.gif, *.png, *.jpg
biff.dd487b83e5e76d08.name = Image-files
biff_keys = dd487b83e5e76d08, 319ddde3cb437ffc, 2e320ca20d1aed6a
}}}


== Example ==

'''''set Biff value automatically when a user committed into the repository'''''
[[BR]][[BR]]
[[Image(trac-plugin-changefilebiff-ticket1.png)]]

[[Image(trac-plugin-changefilebiff-ticket2.png)]]


== Operation Tips ==

=== integrate TracMultiSelectBoxPlugin ===

To integrate TracMultiSelectBoxPlugin is good practice for ticket maintenance like this.
[[BR]][[BR]]
[[Image(trac-plugin-changefilebiff-ticket-with-msb1.png)]]


== Bugs/Feature Requests == 

Existing bugs and feature requests for TracChangeFileBiffPlugin are 
[https://bitbucket.org/t2y/trac.plugins.changefilebiff/issues here].

If you have any issues, create a 
[https://bitbucket.org/t2y/trac.plugins.changefilebiff/issues/new new ticket].


== Download ==

Download the archived source from [http://pypi.python.org/pypi/TracChangeFileBiffPlugin here].


== Source ==

You 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].


== Recent Changes ==

See https://bitbucket.org/t2y/trac.plugins.changefilebiff/commits.


== Author/Contributors ==

'''Author:''' [wiki:t2y] [[BR]]
'''Maintainer:''' [wiki:t2y] [[BR]]
'''Contributors:'''