PreferencesPlugin

Allows editing of preferences using fields predefined in a DataForms. However, the edit fields are inlined in the text, similar to how tables are edited in Foswiki:Extensions/EditTablePlugin.

Insert the %EDITPREFERENCES% preference (see below) anywhere in your topic. It will be replaced by a button that allows editing each preference in its predefined input format (or a text box, when no format is defined for this preference).

In edit mode, the edit button is replaced by Save and Cancel buttons, with their obvious meanings.

Syntax Rules

• %EDITPREFERENCES{ "topic" }%
  • topic references a DataForm defining the format of the edit fields for preferences. It may be prefixed by a web.
  • If a preference setting is not mentioned in the form referenced by topic, a text input box of the specified length is provided.
  • Otherwise, the input can be through textareas, select, radio, checkbox, date, or text, as provided by DataForms.
• %EDITPREFERENCES%
  • Edit existing preferences in the topic using a simple text field.

Examples

• %EDITPREFERENCES%
• %EDITPREFERENCES{ "%SYSTEMWEB%.DefaultPreferencesForm" }%

Plugin 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. "Extensions Operation and Maintenance" Tab → "Install, Update or Remove extensions" Tab. Click the "Search for Extensions" button. Enter part of the extension name or description and press search. Select the desired extension(s) and click install. If an extension is already installed, it will not show up in the search results.

You can also install from the shell by running the extension installer as the web server user: (Be sure to run as the webserver user, not as root!)

cd /path/to/foswiki
perl tools/extension_installer <NameOfExtension> 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 https://foswiki.org/Support/ManuallyInstallingExtensions for more help.

• If the installation was successful, an edit button should appear below:

Plugin Info

Change History:
14 Jun 2015 (1.16)	Foswikitask:Item13423: Perl 5.22 deprecations. Foswikitask:Item12864: Change to simple decimal versions.
23 Oct 2013 (1.1.5)	Foswikitask:Item12607: Document EDITBOX* settings ignored when cookie set
28 Nov 2012 (1.1.4)	Foswikitask:Item11267: Convert to perl version strings
06 Apr 2012 (1.1.3)	Foswikitask:Item11445: Use %SANDBOXWEB% macro.
02 Dec 2011 (1.1.2)	Minor updates for internal compatibility with Foswiki
29 Jun 2011 (1.1.1)	Switch to x.y.z version numbering. Minor update to play better with custom formfield types ( Foswiki::Meta→new() behaviour )
11 Apr 2011:	Version released with Foswiki 1.1.3. Only a minor change related to how the plugin is being upgraded
20 Sep 2009:	Small documentation update. Code tidied up. No preferences in plugin topic. No other functional changes.
19 Apr 2009:	Ignore all saving unless it happened by saving a form using POST method.
15 Dec 2008:	Arthur Clemens added reading of Local preferences. Foswiki version
05 Nov 2007:	Kenneth Lavrsen fixed problem when settings are hidden in html comments. These settings are now ignored.
23 Jun 2007:	Crawford Currie added testcases, recoded to work without a form definition, fixed for TWiki 4.2
08 Feb 2007:	Arthur Clemens added access keys for Save and Cancel, bold style for editable preference names, and a descriptive Save button label.
15 Apr 2006:	Adding css classes to buttons. Removed debug print statement causing 500s on SunOne. Prevent extra space in settings on saves. Switched to earlier handler. Converted all SCRIPTURL to SCRIPTURLPATH, and added support. The only SCRIPTURLs should be the one in the BASE tag and those in mail notification templates. Because the forms package was throwing an exception when it failed to create a form, the edit preferences plugin was aborting the whole of the session whenever the form specified in EDITPREFERENCES didn't exist. Changed it so that the Form constructor does not throw, but returns undef on a non-existant form, and changed preferences plugin to be tolerant of missing forms (ie defaults all fields to text if the form is missing, of is a Set exists which is not in the form).
26 May 2005:	Crawford Currie recoded to use code from Form.pm to render form fields.
08 May 2005:	Add plugin preference to define default input length
07 May 2005:	Initial version

---

Related Topics: DefaultPreferences, SitePreferences, DataForms