A replacement for most of EditTablePlugin, some of EditTablerowPlugin and some of TablePlugin. Features:

1. You can edit one row row, or even one cell at a time, instead of having to edit the entire table. This solves the problem with the long page rendering times required to show all the HTML for a full table edit on big tables.
2. Row being edited can be presented horizontally, as with EditTablePlugin, or Form-style, like EditTablerowPlugin. Makes it easier to edit very wide tables.
3. Supports footer rows.
4. Supports sorting columns in tables using Javascript, avoiding the round-trip to the server required by TablePlugin. Can fall back to TablePlugin if Javascript isn't available.
5. Simple interface to moving rows around in the table, deleting and adding rows.
6. Gets row numbering right (takes account of headers).
7. It's faster than the individual plugins it replaces. much faster than the individual plugins it replaces.
8. (geeky) Coded using a clean object-oriented architecture, which makes it easily extensible.
9. (geeky) Uses a simple REST interface for saving changes, which allows Javascript table editors to use the same interface to save.
10. (geeky) Tolerant to Javascript being disabled in the browser

Note that this plugin is designed for use with tables of up to ~1000 rows. Tables larger than this will work, but they put considerable stress on the browser and the server. For manipulating larger tables, you are recommended to investigate Foswiki:Extensions.JQGridPlugin.

Works like the EditTablePlugin (it uses exactly the same %EDITTABLEtags) macro) and you can use it to edit the entire table, or just one row at a time.

A An %EDITTABLE{...}% in the topic will be associated with the next table in the topic. If there is no existing table, or another %EDITTABLE{...}% is seen before the next table, then a new table will be created.

• format - The format of the cells in a row of the table. The format is defined like a table row, where the cell data specify the type for each cell. For example, format="| text,16 | label |". Cells can be any of the following types:
  • text, , Simple text field. Initial value is optional.
  • textarea, x, Multirow text box. Initial value is optional.
  • select, , , , etc Select one from a list of choices.
  • radio, , , , etc. Radio buttons. size indicates the number of buttons per line in edit mode.
  • checkbox, , , , etc Checkboxes. size indicates the number of buttons per line in edit mode.
  • label, 0, Fixed label.
  • row The row number, automatically worked out.
  • date, , , Date. Initial value and date format are both optional.
• changerows - Rows can be added and removed if "on". Rows can be added but not removed if "add". Defaults to the value of the preference CHANGEROWS, or off "on" if it isn't set.
• disable - By default, the plugin shows both full table and individual row editing controls. You can choose to disable one or both of these modes using the disable parameter, by setting it to row or full (or row,full to disable all editing and just leave sorting). If full table editing is disabled, but changerows is on, then the (edit table) button will be replaced with a (add row) button. Defaults to the value of the preference EDITROWPLUGIN_DISABLE, or none if it isn't set.
• buttons - set to left (the default) or right to position edit controls in the first or last columns in the table. buttons="right" may be required if you are using other plugins that expect a certain column order.
• quietsave - Quiet Save button is shown if "on". Defaults to the value of the preference QUIETSAVE, or off if it isn't set.
• include - Name of another topic defining the EDITTABLE parameters. The first %EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place.
• headerrows - Number of rows to treat as headers. Header rows are not editable, and will not be sorted. headerislabel is also supported for EditTablePlugin compatibility (equivalent to headerrows="1") |
• header - Specify the single-row header format of a new table. For example, "|*Food*|*Drink*|". Provided for compatibility with to allow you to create a new table in a document, and to have a header that is truely readonly. EditTablePlugin, not recommended.
• footerrows - Number of rows to treat as footers. Footer rows are not editable and will not be sorted. |
• orientrowedit - unique to EditRowPlugin, this parameter controls the orientation of a row when it is being edited. It can be set to horizontal (the default) or vertical, which will present the columns of the row as rows in the editor. This makes editing very wide tables much easier. Has no effect in whole table editing mode.
• helptopic Topic name containing help text shown when editing a table. The %STARTINCLUDE% and %STOPINCLUDE% markers can be used in the topic to specify what is shown. Note that newlines are removed from the included text so the that text can be used inside a table.
• js gives local, per-table control over the EDITROWPLUGIN_JS preference described below.

Table rows are shown with a row edit button in the first column, and a table edit button after the table. When the table is edited, then a number of buttons may be shown depending on the settings of changerows and quietsave.

• saves the changes
• saves without notification
• adds a new row after the current row, taking for its contents whatever you entered into the current row initial values specified in the EDITTABLE macro
• deletes the row
• Move this row up one row in the table
• Move this row down one row in the table
• cancels the open edit

An individual edit field type can be defined for each individual table cell. Place an %EDITCELL{ "type, ..." }%variable macro at the end of 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. For example, to define a text field, type: | cell content %EDITCELL{ "text, 20" }% |

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

Javascript Editing

When a table is editable and Javascript is enabled, then when the user rolls the mouse over a table row:

• individual table cells have a yellow stain on the corner that can be clicked to open an in-place editor,
• table rows that contain at least one editable cell can be manually sorted using drag-and-drop, by dragging the (though beware that a TABLE tag with an initsort will override this, which can be confusing),

Table columns can be sorted in the browser, by clicking the heading above the row.

Note that javascript editing is automatically disabled if:

• The current user does not have CHANGE access to the topic
• No user is logged in, but the rest script is listed in the {AuthScripts} admin setting.

Also, the plugin can be selectively disabled using has a couple of its own settings:

Relationships Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Using the REST API

The plugin provides a couple of useful REST handlers. Javascript developers may find this API useful when developing their own tools that manipulate tables.

There are two entry points, get and save. The get handler can be used to retrieve the contents of a table. Parameters are:

• erp_topic the web.wikiname of the topic
• erp_table the table (numbered from 1)
• erp_row - the row (numbered from 1)
• erp_col - the column (numbered from 1)

The handler returns a row, a column, or the entire table depending on the presence of the erp_row and erp_col parameters. If neither is given, the entire table is returned. If only erp_row is given, just that row will be returned, etc. The data is returned in JSON format.

For example, a URI to retrieve column 2 from the table EDITTABLE_1 from this topic would look like this:

https://nkwiki.de/foswiki/bin/rest/EditRowPlugin/get?erp_topic=System.EditRowPlugin;erp_table=EDITTABLE_1;erp_col=2

The save handler is used to save cells, and accepts the following parameters:

• erp_topic the web.wikiname of the topic to be changed
• erp_table the table to be changed (numbered from 1)
• erp_row - the row to be changed (numbered from 1, or -1 for the whole table)
• saveRowCmd.x - if nonzero, this is a save
• saveRowQuietlyCmd.x - if nonzero, this is a quietsave
• upRowCmd.x - if nonzero, this is a row move
• downRowCmd.x - if nonzero, this is a row move
• deleteRowCmd.x - if nonzero, this is a row deletion
• cancelCmd.x - if nonzero, this is a cancel
• noredirect - if set, suppresses the redirect and gets a status code instead

The value of each individual cell is stored in a parameter called erp_

EditTablePlugin

At this time most features of EditTablePlugin are supported. Known exceptions are:

• the editbutton parameter,
• Plugin preferences (though global preferences are compatible)

TablePlugin

EditTablerowPlugin

Provides the vertical row editing interface like EditTablerowPlugin, with the row being edited shown in context in the table.

Plugin Info

Another great Foswiki extension from the WikiRing - working together to improve your wiki experience!