Changes between Version 83 and Version 84 of TracFormsPlugin
- Timestamp:
- Jul 24, 2015, 12:47:37 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracFormsPlugin
v83 v84 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 {{{#!NewsFlash3 '''News'''4 22-Jul-2011:: '''!TracForms 0.4.1''' is out. (open: 13)5 18-May-2011:: !TracForms 0.4 is out. (open: 14)6 04-Dec-2010:: Maintainership handed over from [wiki:rharkins] to [wiki:hasienda]7 26-Oct-2010:: Starting ticket list cleanup and triaging (open: 25)8 '''!ToDo'''9 * short-term: #3523, #603310 }}}11 2 12 = Provides forms for ticket description and wiki pages = 13 == Description == 3 = Provides forms for ticket description and wiki pages 14 4 15 This plugin aims to allow for forms anywhere there is a field with Trac wiki syntax. 16 This is meant to supersede the previously limited-scope ChecklistPlugin. 5 == Description 6 7 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. 17 8 18 9 WikiFormsPlugin aims at providing even more flexibility with a sightly more complex wiki markup incompatible to that of !TracFormsPlugin. 19 10 Additional features from this plugin have been requested here too (see #8715). 20 11 21 == Release Status and Download ==12 === Example and [wiki:TracFormsPlugin/Docs Documentation] 22 13 23 || Stable Version || [source:tracformsplugin/tags/tracforms-0.4.1] || [download:tracformsplugin/tags/tracforms-0.4.1 download] || [http://trac-hacks.org/svn/tracformsplugin/tags/tracforms-0.4.1 subversion] 24 || Under Development || [source:tracformsplugin/trunk] || [download:tracformsplugin/trunk download] || [http://trac-hacks.org/svn/tracformsplugin/trunk subversion] 14 Also see the online [wiki:TracFormsPlugin/Tutorial tutorial] or the [wiki:TracFormsPlugin/Docs documentation] (docs still in need of some corrections and updates to 0.4). 25 15 26 The current stable version is usable with Python2.6; an older Python requires [http://simplejson.github.com/simplejson/ simplejson] to be installed.[[BR]] 27 Revision [10011] and above requires some dedicated permissions assigned to use new (search) as well as known !TracForms features ('Update Form' button). 28 29 You can also download the entire project [download:tracformsplugin here], or checkout a copy using [http://trac-hacks.org/svn/tracformsplugin subversion]. 30 31 See installation below for details on how to install and configure the plugin. 32 33 == Example and [wiki:TracFormsPlugin/Docs Documentation] == 34 35 '''''Also consider viewing the online [wiki:TracFormsPlugin/Tutorial tutorial] or the [wiki:TracFormsPlugin/Docs documentation] (docs still in need of some corrections and updates to 0.4)''''' 36 37 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: 16 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: 38 17 39 18 {{{ … … 61 40 [[Image(LaundryList.jpg)]] 62 41 63 From here, you can check some things and click "Submit Query" you'll see the fields change. 42 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: 64 43 65 44 [[Image(LaundryList2.jpg)]] … … 71 50 }}} 72 51 73 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.52 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. 74 53 75 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).54 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). 76 55 77 There is much more planned for this plugin than simply checklists. 56 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. 78 57 79 == Bugs/Feature Requests ==58 == Bugs/Feature Requests 80 59 81 60 Existing bugs and feature requests for TracFormsPlugin are … … 83 62 84 63 If you have any issues not covered by the existing tickets (including closed ones), create a 85 [ http://trac-hacks.org/newticket?component=TracFormsPlugin&owner=hasiendanew ticket].64 [/newticket?component=TracFormsPlugin new ticket]. 86 65 87 == Installation == 66 [[TicketQuery(component=TracFormsPlugin&group=type,format=progress)]] 88 67 89 Once you have downloaded the source, do the following (your mileage may vary on the actual directory names depending on what you downloaded): 68 == Download and Source 90 69 91 {{{ 92 #!sh 70 || Stable Version || [source:tracformsplugin/tags/tracforms-0.4.1] || [download:tracformsplugin/tags/tracforms-0.4.1 download] || [http://trac-hacks.org/svn/tracformsplugin/tags/tracforms-0.4.1 subversion] 71 || Under Development || [source:tracformsplugin/trunk] || [download:tracformsplugin/trunk download] || [http://trac-hacks.org/svn/tracformsplugin/trunk subversion] 72 73 The current stable version is usable with Python 2.6; an older Python requires [http://simplejson.github.com/simplejson/ simplejson] to be installed. 74 75 Revision [10011] and above requires some dedicated permissions assigned to use new (search) as well as known !TracForms features ('Update Form' button). 76 77 You can also download the entire project [download:tracformsplugin here], or checkout a copy using [http://trac-hacks.org/svn/tracformsplugin subversion]. 78 79 == Installation 80 81 Once you have downloaded the source, do the following (the actual directory names depend on what you downloaded): 82 83 {{{#!sh 93 84 cd tracformsplugin 94 85 cd trunk … … 96 87 }}} 97 88 98 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:89 For older versions or ones still in development, go to the tags directory and then to the desired version, for example: 99 90 100 {{{ 101 #!sh 91 {{{#!sh 102 92 cd tracformsplugin 103 93 cd tags … … 106 96 }}} 107 97 108 === Method 1: Lay an egg === 98 === Method 1: Lay an egg 99 109 100 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): 110 101 111 {{{ 112 #!sh 102 {{{#!sh 113 103 python setup.py bdist_egg 114 115 104 cp dist/TracForms-0.1-*.egg $TRACENV_DIR/plugins/ 116 105 }}} 117 106 118 === Method 2: Full install ===107 === Method 2: Full installation 119 108 120 109 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): 121 110 122 {{{ 123 #!sh 111 {{{#!sh 124 112 python setup.py install 125 113 vi $TRACENV_DIR/conf/trac.ini … … 128 116 Within here, locate (or create) your [components] section and add the following: 129 117 130 {{{ 131 132 118 {{{#!ini 119 [components] 120 tracforms.* = enabled 133 121 }}} 134 122 135 === Upgrading the database ===123 === Upgrading the database 136 124 137 Either of the above methods require a database upgrade ...125 Either of the above methods require a database upgrade: 138 126 139 {{{ 140 #!sh 127 {{{#!sh 141 128 trac-admin $TRACENV_DIR upgrade 142 129 }}} … … 151 138 FORM_ADMIN:: just inherits all previous permissions, nothing more yet 152 139 153 === About i18n/l10n support ===140 === About i18n/l10n support 154 141 155 142 The this plugin is prepared for localization.[[BR]] 156 143 But English message texts are still the (POSIX) default. If this isn't your preferred language, you can 157 1. look, if it's already available from the [TracPluginTranslation Trac plugin l10n project] at [https://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/tracforms Transifex] or144 1. check if it is already available from the [TracPluginTranslation Trac plugin l10n project] at [https://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/tracforms Transifex] or 158 145 2. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details). 159 146 … … 167 154 168 155 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: 169 {{{ 156 {{{#!sh 170 157 cd tracformsplugin/ 171 158 python ./setup.py compile_catalog -f 172 159 python ./setup.py bdist_egg 173 }}} 160 }}} 161 174 162 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.[[BR]] 175 163 Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins]. 176 164 177 == Recent Changes ==165 == Recent Changes 178 166 179 167 [[ChangeLog(tracformsplugin, 3)]] 180 168 181 == Author/Contributors ==169 == Author/Contributors 182 170 183 171 '''Author:''' [wiki:rharkins] [[BR]] 184 '''Maintainer:''' [ wiki:hasienda] [[BR]]172 '''Maintainer:''' [[Maintainer]] [[BR]] 185 173 '''Contributors:''' anderson, [wiki:andrewbates], [wiki:jrcutler], [wiki:nelsojost]
