PreferencesPlugin

Page contents

• Introduction
• Syntax Rules
• Examples
• Caveat
• Plugin Installation Instructions
• Plugin Info

Allows editing of preferences using fields predefined in a form

Introduction

Allows editing of preferences using fields predefined in a TWikiForms. However, the edit fields are inlined in the text, similar to how tables are edited in EditTablePlugin.

Insert the %EDITPREFERENCES% variable (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" editbutton="..." }%
  • topic references a TWikiForm defining the format of the edit fields for preferences. It may be prefixed by a web.
  • Optional editbutton parameter: Custom edit button label. Default: Edit Preferences.
  • 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 TWikiForms.
• %EDITPREFERENCES%
  • Edit existing preferences in the topic using a simple text field.

Examples

• %EDITPREFERENCES%
• %EDITPREFERENCES{ "%SYSTEMWEB%.TWikiPreferencesForm" }%
• %EDITPREFERENCES{ "%SYSTEMWEB%.TWikiPreferencesForm" editbutton="Edit Group Settings" }%

Caveat

When the "Edit Preferences" button is clicked, the page is rendered in such a manner that it makes a big HTML form to update preferences. This form generation processing assumes that there is no HTML form tags (form, input, select, option, textarea tags) are present in the WebPreferences content. If HTML forms are present on WebPreferences, "Edit Preferences" may generate an HTML form not functioning well.

Meanwhile you may put HTML forms in TWiki.WebPreferences, which is included in every WebPreferences. To cope with that, inclusion of that topic is suppressed when "Edit Prefereces" is clicked.

Plugin Installation Instructions

This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Plugin Info

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Allows editing of preferences using fields predefined in a form

Plugin Author: TWiki:Main.ThomasWeigert Copyright: © 2005 TWiki:Main.ThomasWeigert © 2005-2013 TWiki:TWiki.TWikiContributor License: GPL (GNU General Public License) Plugin Version: 2013-09-08

TWiki Dependency: $TWiki::Plugins::VERSION 1.026 CPAN Dependencies: none Other Dependencies: none Perl Version: 5.005 TWiki:Plugins/Benchmark: GoodStyle nn%, FormattedSearch nn%, PreferencesPlugin nn% Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/PreferencesPlugin Feedback: http://TWiki.org/cgi-bin/view/Plugins/PreferencesPluginDev Appraisal: http://TWiki.org/cgi-bin/view/Plugins/PreferencesPluginAppraisal

Related Topics: TWikiPreferencesForm, TWikiPreferences, TWikiForms, TWikiPlugins