[[PageOutline(2-5,Contents,pullout)]] = Provides forms for ticket description and wiki pages = == Description == This plugin aims to allow for forms anywhere there is a field with Trac wiki syntax. This is meant to supersede the previously limited-scope ChecklistPlugin. == Release Status and Download == || Stable Version || [source:tracformsplugin/tags/tracforms-0.2.1] || [download:tracformsplugin/tags/tracforms-0.2.1 download] || [http://trac-hacks.org/svn/tracformsplugin/tags/tracforms-0.2.1 subversion] || Under Development || [source:tracformsplugin/trunk] || [download:tracformsplugin/trunk download] || [http://trac-hacks.org/svn/tracformsplugin/trunk subversion] The former, rather individual development model (working inside plugin version branches) has been dropped in favor of the common habit to use trunk for all development. You can also download the entire project [download:tracformsplugin here], or checkout a copy using [http://trac-hacks.org/svn/tracformsplugin subversion]. See installation below for details on how to install and configure the plugin. == Example and [wiki:TracFormsPlugin/Docs Documentation] == '''''Also consider viewing the online [wiki:TracFormsPlugin/Tutorial tutorial] or the [wiki:TracFormsPlugin/Docs documentation] (docs still under development)''''' 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 chuck this in: {{{ == 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 get something looking like this: [[Image(LaundryList.jpg)]] From here, you can check some things and click "Submit Query" you'll see the fields change. After a few clicks it might look like this: [[Image(LaundryList2.jpg)]] 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 it's 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 [wiki:TracFormsPlugin/Docs] for more information on the various ways to use this tool. == Bugs/Feature Requests == Existing bugs and feature requests for TracFormsPlugin are [query:status=new&status=assigned&status=!closed&component=TracFormsPlugin&order=priority here]. If you have any issues, create a [http://trac-hacks.org/newticket?component=TracFormsPlugin&owner=hasienda new ticket]. == Installation == Once you have downloaded the source, do the following (your mileage may vary on the actual directory names depending on what you downloaded): {{{ #!sh cd tracformsplugin cd trunk cd 0.11 }}} For older versions or ones still in development, cd into tags and then into the desired version. For example, to use the 0.1 version: {{{ #!sh cd tracformsplugin cd tags cd release-0.1 cd 0.11 }}} === Using TracFormsPlugin with MySQL === See ticket #3290 for a drop-in replacement for formdb.py that should work with either versions prior to 0.2.1 (where it will be more transparent). Once you have formdb.py, do something like the following depending on what exactly you downloaded: {{{ #!sh cp /tmp/formdb.py tracforms/ }}} Replace /tmp/formdb.py with the path to wherever you download the formdb.py script to. Now you can proceed to installation. I'm going to try to have this worked out by 0.2.1 so that it'll work both ways (and set up to eventually also work in postgreSQL, etc). Thanks to the donator of this code (in #3290) for your help with the project! === 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): {{{ #!sh python setup.py bdist_egg cp dist/TracForms-0.1-*.egg $TRACENV_DIR/plugins/ }}} === Method 2: Full install === 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): {{{ #!sh 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... {{{ #!sh trac-admin $TRACENV_DIR upgrade }}} == Recent Changes == [[ChangeLog(tracformsplugin, 3)]] == Author/Contributors == '''Author:''' [wiki:rharkins] [[BR]] '''Maintainer:''' [wiki:hasienda] [[BR]] '''Contributors:''' [wiki:jrcutler]