wiki:TracFormsPlugin

Version 26 (modified by rharkins, 8 years ago) (diff)

--

Hey You! Don't use this yet!!!

Provides forms anywhere there is a wiki

Description

This plugin aims to allow for forms anywhere there is a wiki. This is meant to supersede the previously limited-scope ChecklistPlugin.

Example

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

|| || '''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:

Example of blank laundry list

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:

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. Now, for more fun, do the same thing in a ticket. Including a wiki form structure will work especially well with a PageTemplate.

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

FOR NOW, PLEASE DON'T BOTHER SUBMITTING ANYTHING. THIS ISN'T TRULY RELEASED YET.

Existing bugs and feature requests for TracFormsPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from [download:tracformsplugin here].

Source

You can check out TracFormsPlugin from here using Subversion, or browse the source with Trac.

Installation

Once you have downloaded the source, do the following (your mileage may vary on the actual directory names depending on what you downloaded):

cd tracformsplugin
cd trunk
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 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):

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

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
Contributors:

Attachments (2)

Download all attachments as: .zip