• • - turn the table into edit mode

• • - save your changes
  • - save your changes without alerting subscribed WebNotify users
  • - add row to the table (if enabled)
  • - remove last row from the table (if enabled)
  • - cancel without saving and release edit lock

• Bug: The Plugin fails if the table is at the very end of the topic (without a new line) Always ensure there is a newline after the table
• This Plugin does not support TWiki table formatting like Multi-span cells (e.g. | ... ||) and cell justification (e.g. |  centered  |   right |)
• There is a performance issue when editing a large table, say, with more then 50 rows
• Variables like %ATTACHURL% get expanded unless they are in a label
• You cannot put two %EDITTABLE{}% statements on the same line in the source
• You can include %-vars now in select values, by quoting them with <nop>, as in %<nop>X% for %X%, say for instance:

• Default flag for quiet save option: on to show the Quiet Save button, off to hide
  • Set QUIETSAVE = on

• Default edit button: Specify button text, or specify alternate text, image URL
  • #Set EDITBUTTON = Edit table
  • Set EDITBUTTON = Edit this table,

Initial Values

By default, variables in <initial value> (of text input field) and <label text> (of fixed label) get expanded when a new row is added. This can be used for example to add a timestamp to a label. You can escape characters if you do not want that:

Date Field Type

The date field type allows one to choose a date with a popup calendar. Popup calendar works for Netscape 6.0 or better, all other Gecko-based browsers, Internet Explorer 5.0 or better for Windows, Opera 7 and Konqueror 3.1.2. The ... button is inactive if the browser cannot support the popup calendar. It uses the nice Mishoo DHTML calendar, see also TWiki:Codev/JavaScriptDatePickerForForm

Per Cell Settings

The edit field type can be defined for each table cell by placing an %EDITCELL{ "type, ..." }% variable after the cell content. This is useful to override the per column %EDITTABLE{ format="..." }% settings, or to create tables with key/value rows. All edit field types of the format="..." parameter are supported, e.g. to define a text field, type: | cell content %EDITCELL{ "text, 20" }% |

It is also possible to place the edit button into a cell instead of default location below the table. Type | %EDITCELL{ "editbutton, 1, Edit this table" }% | to show a button, or | %EDITCELL{ "editbutton, 1, Edit table, Image-URL" }% | to show a button image with alternate text.

Note: The EDITCELL variable cannot be used by itself; place an EDITTABLE variable at the beginning of a table where you want to use EDITCELL variables.

• • Set SHORTDESCRIPTION = Edit TWiki tables using edit fields, date pickers and drop down boxes

• Default text for edit button:
  • Set EDITBUTTON = Edit table

• The Plugin depends on the viewauth script to authenticate the user. As described in TWikiAccessControl, copy the view script to viewauth (or better, create a symbolic link) and add viewauth to the list of authenticated scripts in the .htaccess file.

• Language of DHTML calendar, pointing to attached calendar-<code>.js language file: en, af, br, ca, cs-win, da, de, du, el, es, fr, hr, hr-utf8, hu, it, jp, nl, no, pl, pt, ro, ru, sk, sp, sv, tr, zh

• The Mishoo DHTML calendar 0.9.5 is preinstalled and should work without any configuration. If you wish to use another language, specify the in the Plugin settings, or create a new language files, attach it to the Plugin topic, and change the Plugin settings
• Test if the Plugin is correctly installed:

Edit Table Plugin

Table Buttons

Date Field Type

The date field type allows one to choose a date with a popup calendar. Popup calendar works for Netscape 6.0 or better, all other Gecko-based browsers, Internet Explorer 5.0 or better for Windows, Opera 7 and Konqueror 3.1.2. The ... button is inactive if the browser cannot support the popup calendar. It uses the nice Mishoo DHTML calendar, see also TWiki:Codev/JavaScriptDatePickerForForm

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %EDITTABLEPLUGIN_SHORTDESCRIPTION%

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Edit TWiki tables using edit fields and drop down boxes

• Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
  • Set DEBUG = 0

• Default for change rows flag: on, off, add
  • Set CHANGEROWS = on

• Date format of Mishoo DHTML calendar:
  • Set JSCALENDARDATEFORMAT = %Y/%m/%d

• Language of DHTML calendar, pointing to attached calendar-<code>.js language file: en, de, es, fr, jp
  • Set JSCALENDARLANGUAGE = en

• Additional options of DHTML calendar:
  • Set JSCALENDAROPTIONS =

Note: The Plugin looks for the JSCALENDAR* settings first in the TWiki Preferences, then in above Plugin settings

• The Mishoo DHTML calendar 0.9.5 is preinstalled and should work without any configuration. If you wish to use another language, attach the language files to the Plugin topic and change the Plugin settings

License

• The Edit Table Plugin is released under the GPL
• The Mishoo DHTML calendar bundled with this Plugin was created by Mihai Bazon and is released under the LGPL -- thanks Mihai for the great tool

Edit Table Plugin

This plugin allows you to edit TWiki tables using edit fields and drop down boxes. Tables have an [ Edit table ] button if preceeded by an %EDITTABLE{...}% variable. Each column can be a text field, a drop down box or a row number. Multiple tables per topic can be editable, but only one at a time canbe edited.

EditTablePlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Edit TWiki tables using edit fields and drop down boxes.

• Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
  • Set DEBUG = 0

Per Table Settings

Add a %EDITTABLE{...}% variable just before an existing table to make it editable, or add the variable anywhere in a topic to start a new table. Parameters:

Note: By default, variables in <initial value> (of text input field) and <label text> (of fixed label) get expanded when a new row is added. This can be used for example to add a timestamp to a label. You can escape characters if you do not want that:

Text:	To Escape:
$dollar	Dollar sign ($)
$quot	Double quote ("). Alternatively write \" to escape it
$nop or $nop()	Is a "no operation"
$percnt	Percent sign (%)

Examples

Line before table: %EDITTABLE{ header="|*Nr*|*Text field sandbox*|*Drop down sandbox*|*Timestamp*|" format="| row, -1 | text, 20, init | select, 1, one, two, three, four | label, 0, %SERVERTIME{"$day $mon $year $hour:$min"}% |" changerows="on" }%

If this plugin is installed you will see an [ Edit table ] button above; when you click on it you get this form:

Limitations and Known Issues

• This Plugin does not support TWiki table formatting like Multi-span cells (e.g. | ... ||) and cell justification (e.g. |  centered  |   right |).
• There is a performance issue when editing a large table, say, with more then 50 rows.
• The Plugin fails if the table is at the very end of the topic (without a new line) Always ensure there is a newline after the table
• Variables like %ATTACHURL% get expanded unless they are in a label.
• Warning: This plugin uses undocumented functions to read, save and lock a topic. The plugin will likely break in a future TWiki release.
• You cannot put two %EDITTABLE% statements on the same line in the source.
• You can include %-vars now in select values, by quoting them with <nop>, as in %<nop>X% for , say for instance:
  select,1,%<nop>X%,%<nop>Y%
• date field type for the format parameter adds a button popping a javascript calendar to choose the date on browsers supporting it. It uses the nice Mishoo DHTML calendar at http://dynarch.com/mishoo/calendar.epl, that should be included in Cairo release, or see TWiki:Codev/JavaScriptDatePickerForForm for installing it on Beijing Release

Plugin Installation Instructions

• Download the ZIP file from the Plugin web (see below)
• Unzip EditTablePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/EditTablePlugin.txt	Plugin topic
  data/TWiki/EditTablePlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/EditTablePlugin.pm	Plugin Perl module

• The plugin depends on the viewauth script to authenticate the user. As described in TWikiAccessControl, copy the view script to viewauth (or better, create a symbolic link) and add viewauth to the list of authenticated scripts in the .htaccess file.
• Test if the plugin is correctly installed:
  • Check above example if there is an [ Edit table ] button below the table in above example
  • Click on [ Edit table ], make changes and save the table

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- PeterThoeny - 08 Nov 2002