wiki:TracFormsPlugin

Provides forms for ticket description and wiki pages

Description

This plugin allows you to add forms anywhere where there is a field with Trac wiki syntax. This is meant to supersede the previously limited-scope ChecklistPlugin.

The similar WikiFormsPlugin aims at providing even more flexibility with a sightly more complex wiki markup incompatible with that of this plugin. Additional features from this plugin have been requested here too (see #8715). For a comparison between the two plugins, see here.

Example and Documentation

Also see the online tutorial or the documentation (docs still in need of some corrections and updates to 0.4).

Let's start by looking at a simple laundry list. This list will be automatically bound to whatever page it appears in by default (this can be configured). Once the plugin is installed, simply edit a new wiki resource called Sandbox/LaundryList and add this:

== Laundry list example

{{{
#!TracForm
#
# An example of a TracForm. The first lines can be commentary or #! commands.
#
#! track_fields

|| || '''Who''' || '''When''' || '''What''' ||
|| [tf:wash] || [tf.who:wash] || [tf.when:wash] || Wash Clothes ||
|| [tf:dry] || [tf.who:dry] || [tf.when:dry] || Dry Clothes ||
|| [tf:fold] || [tf.who:fold] || [tf.when:fold] || Fold Clothes ||

}}}

Once saved, you should see something like this:

Example of blank laundry list

From here, you can click "Submit Query" and you will see the fields change. After a few clicks it might look like this:

Example after a few checks.

Now, if you thought that was neat, make sure you have the IncludeMacro installed and fire up a new wiki page Sandbox/LaundryListUser with the following:

[[Include(Sandbox/LaundryList)]]

Note that the form is blank and you can play with the results again. This is because the default context for the form is the page URL itself! That means that as long as a form is included on a different page (and the default context is not overridden), then each page including gets its own version of the form's results. This works particularly well with PageTemplates.

Now, for more fun, do the same thing in a ticket. Once submitted, every ticket including the template will contain its own checklist. One obvious use for this is when creating a svn commit checklist. Simply put the checklist in the appropriate wiki location, create tickets that include the location, and voila, instant commit step-by-step. Once enough of the form becomes exposed, we should be able to work this into the workflow too (no resolving before at least paying lip service to the checklist).

There is much more planned for this plugin than simply checklists. See TracFormsPlugin/Docs for more information on the various ways to use this tool.

Bugs/Feature Requests

Existing bugs and feature requests for TracFormsPlugin are here.

If you have any issues, create a new ticket.

defect

27 / 31

enhancement

13 / 30

task

1 / 1

Download and Source

Stable Version tracformsplugin/tags/tracforms-0.4.1 download subversion
Under Development tracformsplugin/trunk download subversion

The current stable version is usable with Python 2.6; an older Python requires simplejson to be installed.

Revision [10011] and above requires some dedicated permissions assigned to use new features (such as Search) as well as known TracForms features (such as the 'Update Form' button).

You can also download the entire project here, or checkout a copy using Subversion.

Installation

Once you have downloaded the source, do the following (the actual directory names depend on what you downloaded):

cd tracformsplugin
cd trunk
cd 0.11

For older versions or ones still in development, go to the tags directory and then to the desired version, for example:

cd tracformsplugin
cd tags
cd release-0.1
cd 0.11

Method 1: Lay an egg

From here, you can do one of two things. The first is building an egg to drop into your project's plugins directory or your master project's plugins directory (replace or define $TRACENV_DIR with your project's base directory):

python setup.py bdist_egg
cp dist/TracForms-0.1-*.egg $TRACENV_DIR/plugins/

Method 2: Full installation

Or, you can build and install and enable the right bit in the configuration file (replace or define $TRACENV_DIR with your project's base directory):

python setup.py install
vi $TRACENV_DIR/conf/trac.ini

Within here, locate (or create) your [components] section and add the following:

[components]
tracforms.* = enabled

Upgrading the database

Either of the above methods require a database upgrade:

trac-admin $TRACENV_DIR upgrade

Grant user persmissions

Since tracforms-0.4 you must grant form-related permissions to the relevant groups and/or users. Otherwise only users with TRAC_ADMIN permision will be able to see details and use forms. These are the permission actions available:

FORM_VIEW
view form details, similar to ticket or wiki change history.
FORM_EDIT_VAL
enable submission of form content changes - these users will be able to see and use 'Update Form' buttons.
FORM_RESET
enable incremental and full form version clean-up by using additional action buttons on form details pages.
FORM_ADMIN
inherits all previous permissions, nothing more yet.

About i18n/l10n support

This plugin is prepared for localization.
But English message texts are still the (POSIX) default. If this isn't your preferred language, you can

  1. check if it is already available from the Trac plugin l10n project at Transifex or
  2. do it yourself (see the l10n cookbook page for Trac plugins for more details).

You've done a new translation? Superb! Contributing your translation is highly appreciated.
You could send it to the plugin's maintainer or contribute to Trac plugin l10n project via Transifex:

Top translations: Trac_Plugin-L10N » tracforms

http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/tracforms/chart/image_png

Kindly provided by https://ds0k0en9abmn1.cloudfront.net/static/charts/images/tx-logo-micro.png

Preparing the plugin from source requires no additional steps for compiling message catalog files. Only to include translations marked as # fuzzy by the translator, you'll want to do a manual message catalog compilation with the extra -f argument before packaging:

cd tracformsplugin/
python ./setup.py compile_catalog -f
python ./setup.py bdist_egg

Complaints about missing locale directory are often a side-effect of failure to compile any message catalog for inclusion into Python egg, hence the whole path is missing. Due to a know Trac issue Babel has to be installed prior to Trac, to get it all working as expected.
Again, for more details see the l10n cookbook page for Trac plugins.

Recent Changes

15447 by rjollos on 2016-03-22 19:24:22
0.5dev: Fix incorrect permission check using Form object

Fixes #12713.

15446 by rjollos on 2016-03-22 19:23:30
0.5dev: Remove tag_svn_revision

The attribute is not supported in setuptools >= 10

Refs #12713.

15445 by rjollos on 2016-03-22 19:21:03
Remove intermediate 0.11 directory
(more)

Author/Contributors

Author: rharkins
Maintainer: Steffen Hoffmann
Contributors: anderson, andrewbates, jrcutler, nelsojost

Last modified 9 months ago Last modified on Nov 20, 2015, 12:47:34 PM

Attachments (2)

Download all attachments as: .zip