r2 - 08 May 2005 - 04:45:29 - TWikiContributorYou are here: Astrophysics Wiki >  TWiki Web  > PreferencesPlugin
---+!! PreferencesPlugin

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 TWiki:Plugins/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 " }%
    • topic references a TWikiForms 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 TWikiForms.


  • %EDITPREFERENCES{ "%TWIKIWEB%.TWikiPreferencesForm" }%

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %PREFERENCESPLUGIN_SHORTDESCRIPTION%

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

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip PreferencesPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/PreferencesPlugin.txt Plugin topic
    data/TWiki/PreferencesPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/PreferencesPlugin.pm Plugin Perl module
    data/TWiki/TWikiPreferencesForm.txt Example form
  • (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • If the installation was successful, an edit button should appear below:

Plugin Info

Plugin Author: TWiki:Main.ThomasWeigert
Plugin Version: 08 May 2005
Change History:  
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
TWiki Dependency: $TWiki::Plugins::VERSION 1.026
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
License: GPL (GNU General Public License)
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: TWikiPreferences, TWikiForms

-- TWiki:Main.ThomasWeigert - 08 May 2005

Edit | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r2 < r1 | More topic actions

key Log In or Register

Main Web Users Groups Index Search Changes Notifications Statistics Preferences

Webs Main Sandbox TWiki Zen Information

Main Web Users Groups Index Search Changes Notifications Statistics Preferences

Webs Main Sandbox TWiki Zen

Astrophysics Wiki

Edit Wysiwyg Attach Printable
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Astrophysics Wiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.PreferencesPlugin