A replacement for most of EditTablePlugin, some of EditTablerowPlugin and some of TablePlugin. Features:
You can edit one row,or even one cell at a time, instead of having to edit the entire table.
Supports footer rows.
Supports sorting columns in tables using Javascript, avoiding the round-trip to the server required by TablePlugin.
Simple interface to moving rows around in the table, deleting and adding rows.
Gets row numbering right (takes account of headers).
It's much faster than the individual plugins it replaces.
(geeky) Coded using a clean object-oriented architecture, which makes it easily extensible.
(geeky) Uses a simple REST interface for saving changes, which allows Javascript table editors to use the same interface to save.
(geeky) Tolerant to Javascript being disabled in the browser
You can edit one row 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.
Row being edited can be presented horizontally, as with EditTablePlugin, or Form-style, like EditTablerowPlugin. Makes it easier to edit very wide tables.
Supports footer rows.
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.
Simple interface to moving rows around in the table, deleting and adding rows.
Gets row numbering right (takes account of headers).
It's faster than the individual plugins it replaces.
(geeky) Coded using a clean object-oriented architecture, which makes it easily extensible.
(geeky) Uses a simple REST interface for saving changes, which allows Javascript table editors to use the same interface to save.
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.
Usage
Usage
Works like the EditTablePlugin (it uses exactly the same %EDITTABLEmacro) and you can use it to edit the entire table, or just one row at a time.
Works like the EditTablePlugin (it uses exactly the same %EDITTABLEtags) and you can use it to edit the entire table, or just one row at a time.
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.
A%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.
Parameters:
Parameters:
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, , Select one from a list of choices.
radio, , etc. Radio buttons. size indicates the number of buttons per line in edit mode.
checkbox, , 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 preferenceCHANGEROWS, or "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 preferenceEDITROWPLUGIN_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 preferenceQUIETSAVE, 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 to allow youto create a new table in a document, and to have a header that is truely readonly.
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.
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, , Select one from a list of choices.
radio, , etc. Radio buttons. size indicates the number of buttons per line in edit mode.
checkbox, , 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 preferenceCHANGEROWS, or off 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 preferenceEDITROWPLUGIN_DISABLE, or none if it isn't set.
quietsave - Quiet Save button is shown if "on". Defaults to the value of the preferenceQUIETSAVE, 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 withEditTablePlugin, 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.
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.
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 the initial valuesspecified 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
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
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
Per Cell Settings
Per Cell Settings
An individual edit field type can be defined for each individual table cell. Place an %EDITCELL{ "type, ..." }%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" }% |
An individual edit field type can be defined for each individual table cell. Place an %EDITCELL{ "type, ..." }%variable 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{}%macrocannot be used by itself; place an%EDITTABLE{ }% macro at the beginning of a table where you want to use %EDITCELL{ }% macros.
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.
Examples
Examples
Copy the following examples and paste them into a topic in the Sandbox web (or another web where you have write access). The EditRowPlugin is not enabled on this site, so the examples will be disabled.
Copy the following examples and paste them into a topic in the Sandbox web (or another web where you have write access). The EditRowPlugin is not enabled on this site, so the examples will be disabled.
%EDITTABLE{ format="| label,12 | textarea, 3x30 |" }%
| *Model* | *Description* |
| 345TG66 | Short, with sightly concave upper surface, and devilish nuts |
| 9A-11 | A new model for 2007, but not quite as pretty as the 9A-10 |
| RR717-D | Solid performer, dependable in vacuum grinders |
%EDITTABLE{ format="| label,12 | textarea, 3x30 |" }%
| *Model* | *Description* |
| 345TG66 | Short, with sightly concave upper surface, and devilish nuts |
| 9A-11 | A new model for 2007, but not quite as pretty as the 9A-10 |
| RR717-D | Solid performer, dependable in vacuum grinders |
Example 3
Example 3
%EDITTABLE{ format="| text,100 | text,100 |" orientrowedit="vertical" headerislabel="on"}%
| *Line* | *Explanation* |
| He took his _vorpal_ sword in hand | A vorpal sword is made from broken bits of Commodore 64 disk-drives |
| Long time the _manxome_ foe he sought | manxome: possibly from 'manky'; or from the Isle of Man |
| So rested he by the _Tumtum_ tree, | Tumtum is a Nilo-Saharan language and people |
| And stood awhile in _thought_ | _thought_ a process not often employed by example writers |
%EDITTABLE{ format="| text,100 | text,100 |" orientrowedit="vertical" headerislabel="on"}%
| *Line* | *Explanation* |
| He took his _vorpal_ sword in hand | A vorpal sword is made from broken bits of Commodore 64 disk-drives |
| Long time the _manxome_ foe he sought | manxome: possibly from 'manky'; or from the Isle of Man |
| So rested he by the _Tumtum_ tree, | Tumtum is a Nilo-Saharan language and people |
| And stood awhile in _thought_ | _thought_ a process not often employed by example writers |
Example 4
Example 4
%EDITTABLE{ format="| label | text, 40 |" }%
|*Key*|*Value*|
| Name: | John Smith |
| Gender: | M %EDITCELL{select, 1, , F, M}% |
| DOB: | 18 October 2007 %EDITCELL{date, 10}% |
| City: | New York |
%EDITTABLE{ format="| label | text, 40 |" }%
|*Key*|*Value*|
| Name: | John Smith |
| Gender: | M %EDITCELL{select, 1, , F, M}% |
| DOB: | 18 October 2007 %EDITCELL{date, 10}% |
| City: | New York |
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.
Preferences
Preferences
The plugin interprets a couple of preferences, in common with the EditTablePlugin.
The plugin interprets a couple of preferences, in common with the EditTablePlugin.
QUIETSAVE
Gives a default value for the quietsave parameter. Default is off.
CHANGEROWS
Gives a default value for the changerows parameter. Default is on.
QUIETSAVE
Gives a default value for the quietsave parameter. Default is off.
CHANGEROWS
Gives a default value for the changerows parameter. Default is off.
Also, the plugin has a couple of itsown settings:
Also, the plugin can be selectively disabled using
EDITROWPLUGIN_JS
Usuallythe plugin expects to be able to use Javascript to generate controls. However sometimes users disable Javascript in the browser, so the plugin also generates a minimal set of fallback controls to give non-JS access to the main features, even if Javascript is disabled. You can use this preference to control whether Javascript is preferred, ignored, or assumed when generating the controls.
preferred means "use JS if it's available, but keep the non-JS fallback controls visible",
ignored means "never use JS, only display the non-JS controls",
assumed means "assume that JS will be available in the browser, and don't display the fallback controls".
You cancontrol the setting on aper-table basis using thejsparameterto theEDITTABLE macro.
EDITROWPLUGIN_DISABLE
Set to on to disable the plugin. Default is off.
EDITROWPLUGIN_DISABLE
Set to onto disable the plugin. Default isoff.
These preferences can be defined in SitePreferences, in WebPreferences for an individual web, or in the topic.
These preferences can be defined in SitePreferences, in WebPreferences for an individual web, or in the topic.
There is also a configure (expert) setting that allows you to change the name of the macro used to carry table editor parameters. This is usually EDITTABLE but can be changed to help work around problems with other plugins.
There is also a configure (expert) setting that allows you to change the name of the macro used to carry table editor parameters. This is usually EDITTABLE but can be changed to help work around problems with other plugins.
InstallationInstructions
Relationships
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".
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:
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_
__
Relationship to other plugins
EditTablePlugin
EditTablePlugin
At this time most features of EditTablePlugin are supported. Known exceptions are:
At this time most features of EditTablePlugin are supported. Known exceptions are:
the editbutton parameter,
Plugin preferences (though global preferences are compatible)
the editbutton parameter,
Plugin preferences (though global preferences are compatible)
TablePlugin
TablePlugin
Javascript sorting in EditRowPlugin is much faster than TablePlugin. However TablePlugin has many features this plugin does not support. Forthe most part, the two plugins can safely be used together. However if you use a TABLE statement with an initsort parameter, it is likely to cause great confusion, as the table will be re-sorted each time a row is opened for edit, and when the table is edited in full table mode.
Javascript sorting in EditRowPlugin is much faster than TablePlugin. However TablePlugin has many features this plugin does not support. The two plugins can safely be used together.
EditTablerowPlugin
EditTablerowPlugin
Provides the vertical row editing interface like EditTablerowPlugin, with the row being edited shown in context in the table.
Provides the vertical row editing interface like EditTablerowPlugin, with the row being edited shown in context in the table.
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".
The plugin saves changes to tables via a REST handler. Javascript developers may find this interface useful when developing their own tools that manipulate tables.
The REST handler is invoked using the following URI format:
/rest/EditRowPlugin/save
The handler accepts the following parameters:
erp_active_topic the web.wikiname of the topic to be changed
erp_active_table the table to be changed (numbered from 1)
erp_active_row - the row to be changed (numbered from 1, or -1 for the whole table)
erp_active_format - the format parameter from the EDITTABLE tag
erp_save.x - if nonzero, this is a save
erp_quietSave.x - if nonzero, this is a quietsave
erp_upRow.x - if nonzero, this is a row move
erp_downRow.x - if nonzero, this is a row move
erp_deleteRow.x - if nonzero, this is a row deletion
erp_cancel.x - if nonzero, this is a cancel
erp_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_
__
Plugin Info
Plugin Info
Another great Foswiki extension from the WikiRing - working together to improve your wiki experience!
Another great Foswiki extension from the WikiRing - working together to improve your wiki experience!
Foswiki:Tasks/Item11381: automatically disable JSif rest script is in {AuthScripts} and no-one is logged in
3.0.0 (8 Dec2011)
Foswiki:Tasks/Item11140: recoded to onlyinstrument the table when the rows are actually rolled over. Reduced the amount of HTML generated by the server enormously. Added REST API.
Foswiki:Tasks/Item2016: work around core code limitations when cell content is0;Foswiki:Tasks/Item10591: silence noisy "Click to edit" statements; change to a control for editing cells, due to the "wikiword selection" problem Foswiki:Tasks/Item10592: row move now uses an external handle, to allow for cursor select of table contents. Add feedback for saves. Foswiki:Tasks/Item10768: fix edit/save buttons in IE 7; Foswiki:Tasks/Item10777: make sure full table edit is working, and there is no risk of data loss when adding/removing rows
Foswiki:Tasks/Item2016: editor was not handling a table cell thatcontained only "0" correctly
2.1.1(25 Feb 2011)
Some minor tweaks
2.1.0(21 Feb 2011)
Foswiki:Tasks/Item5618: Foswiki:Tasks/Item5714: Foswiki:Tasks/Item5715: row moves and single-cell edits are now done client-side as much as possible. Row moves are drag and drop. Using JS lets us maintain the column numbering so that other plugins still work (e.g. table plugin init sort) as well as being a lot faster. Foswiki:Tasks/Item10363: Support button placement at the ends of table rows. Foswiki:Tasks/Item10388: broke out JEditable into a separate package
2.0.2(2 Feb 2011)
Foswiki:Tasks/Item2016: doesn't save "0" in table cells; fixed.Foswiki:Tasks/Item2229: needs better headings support; fixed. Foswiki:Tasks/Item1186: textarea newlines are not saved with whitespace around br; fixed. Foswiki:Tasks/Item9091: orientrowedit=vertical does not show the header labels; fixed. Foswiki:Tasks/Item9775: missing section headings from Config.spec; fixed.
TWikibug:Item5621: helptopics were getting munged because of use of BR toreplace newlines. This was to prevent accidental table concatenation, but breaks other things worse so I removed it.TWikibug:Item5624: handle comments with embedded tables. TWikibug:Item5625: don't count generated tables in the table count. TWikibug:Item5594: typo was causing strange behaviour with row management tools. TWikibug:Item5595: fixed problem with included tables. TWikibug:Item5596: changed default behaviour for empty cells to ignore pre-existing spaces if there is no other content. TWikibug:Item5616: row moving was failing on 4.1.2 due to bad URL construction.
8 Mar 2008
TWikibug:Item5386: fixed problem withediting of tables embedded from an included topicTWikibug:Item5043: added Jeff Crawford's patch to fix multiline textareas
4 Jan 2008
TWikibug:Item5320: fixed destructive save when add row is pressedoutside edit mode
13 Dec 2007
TWikibug:Item4970: removed beforeCommonTagsHandler, which was causing problemswhen interacting with other plugins that use unregistered tag handlers.