Difference: PreferencesPlugin (1 vs. 7)

Revision 72008-09-13 - Main.TWikiAdminUser

Line: 1 to 1
 

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.

Line: 28 to 28
 

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 where TWiki is running.
Changed:
<
<
Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.
  • If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • If you have any problems, then you can still install manually from the command-line:
    1. Download one of the .zip or .tgz archives
    2. Unpack the archive in the root directory of your TWiki installation.
    3. Run the installer script ( perl <module>_installer )
    4. Run configure and enable the module, if it is a plugin.
    5. Repeat for any missing dependencies.
  • If you are still having problems, then instead of running the installer script:
    1. Make sure that the file permissions allow the webserver user to access all files.
>
>
Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.
  • If you have TWiki 4.1 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
    • The webserver user has to have permission to write to all areas of your installation for this to work.
  • If you have a permanent connection to the internet, you are recommended to use the automatic installer script
    • Just download the PreferencesPlugin_installer perl script and run it.
  • Notes:
    • The installer script will:
      • Automatically resolve dependencies,
      • Copy files into the right places in your local install (even if you have renamed data directories),
      • check in new versions of any installed files that have existing RCS histories files in your existing install (such as topics).
      • If the $TWIKI_PACKAGES environment variable is set to point to a directory, the installer will try to get archives from there. Otherwise it will try to download from twiki.org or cpan.org, as appropriate.
      • (Developers only: the script will look for twikiplugins/PreferencesPlugin/PreferencesPlugin.tgz before downloading from TWiki.org)
    • If you don't have a permanent connection, you can still use the automatic installer, by downloading all required TWiki archives to a local directory.
      • Point the environment variable $TWIKI_PACKAGES to this directory, and the installer script will look there first for required TWiki packages.
        • $TWIKI_PACKAGES is actually a path; you can list several directories separated by :
      • If you are behind a firewall that blocks access to CPAN, you can pre-install the required CPAN libraries, as described at http://twiki.org/cgi-bin/view/TWiki/HowToInstallCpanModules
  • If you don't want to use the installer script, or have problems on your platform (e.g. you don't have Perl 5.8), then you can still install manually:
    1. Download and unpack one of the .zip or .tgz archives to a temporary directory.
    2. Manually copy the contents across to the relevant places in your TWiki installation.
 
    1. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
    2. Manually edit LocalSite.cfg to set any configuration variables.
Added:
>
>
    1. Run configure and enable the module, if it is a plugin.
    2. Repeat from step 1 for any missing dependencies.

Note if you are installing this extension in TWiki version < 4.2, please add these definitions to your Main.WebPreferences, if they are not already there:

  • Set SYSTEMWEB = %TWIKIWEB%
  • Set USERSWEB = %MAINWEB%
 
Deleted:
<
<
 
  • If the installation was successful, an edit button should appear below:
Line: 51 to 63
 

Plugin Info

Plugin Author: TWiki:Main.ThomasWeigert
Changed:
<
<
Plugin Version: 15487 (11 Aug 2008)
>
>
Plugin Version: 15484 (05 Nov 2007)
 
Change History:
<-- versions below in reverse order -->
 
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

Revision 62005-05-08 - Main.TWikiContributor

Line: 1 to 1
 

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.

Line: 51 to 51
 

Plugin Info

Plugin Author: TWiki:Main.ThomasWeigert
Changed:
<
<
Plugin Version: 15487 (04 Aug 2008)
>
>
Plugin Version: 15487 (11 Aug 2008)
 
Change History:
<-- versions below in reverse order -->
 
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

Revision 52005-05-08 - Main.TWikiContributor

Line: 1 to 1
 

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.

Line: 51 to 51
 

Plugin Info

Plugin Author: TWiki:Main.ThomasWeigert
Changed:
<
<
Plugin Version: 15487 (22 Jan 2008)
>
>
Plugin Version: 15487 (04 Aug 2008)
 
Change History:
<-- versions below in reverse order -->
 
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

Revision 42005-05-08 - Main.TWikiContributor

Line: 1 to 1
 

PreferencesPlugin

Changed:
<
<
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.
>
>
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).

Changed:
<
<
In edit mode, the edit button is replaced by save and cancel buttons, with their obvious meanings.
>
>
In edit mode, the edit button is replaced by Save and Cancel buttons, with their obvious meanings.
 

Syntax Rules

  • %EDITPREFERENCES{ " topic " }%
Changed:
<
<
    • topic references a TWikiForms defining the format of the edit fields for preferences. It may be prefixed by a web.
>
>
    • topic references a TWikiForm 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.
Changed:
<
<
    • Otherwise, the input can be through textareas, select, radio, checkbox, date, or text, as provided by TWikiForms.
>
>
    • 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

Changed:
<
<
  • %EDITPREFERENCES{ "%TWIKIWEB%.TWikiPreferencesForm" }%
>
>
  • %EDITPREFERENCES%
  • %EDITPREFERENCES{ "%SYSTEMWEB%.TWikiPreferencesForm" }%
 

Plugin Settings

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

>
>
 
    • Set SHORTDESCRIPTION = Allows editing of preferences using fields predefined in a form

Plugin Installation Instructions

Added:
>
>
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 where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.

  • If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • If you have any problems, then you can still install manually from the command-line:
    1. Download one of the .zip or .tgz archives
    2. Unpack the archive in the root directory of your TWiki installation.
    3. Run the installer script ( perl <module>_installer )
    4. Run configure and enable the module, if it is a plugin.
    5. Repeat for any missing dependencies.
  • If you are still having problems, then instead of running the installer script:
    1. Make sure that the file permissions allow the webserver user to access all files.
    2. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
    3. Manually edit LocalSite.cfg to set any configuration variables.
 
Changed:
<
<
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.
>
>
 
Changed:
<
<
  • 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:
>
>
  • If the installation was successful, an edit button should appear below:
 

Plugin Info

Plugin Author: TWiki:Main.ThomasWeigert
Changed:
<
<
Plugin Version: 15 Apr 2006
>
>
Plugin Version: 15487 (22 Jan 2008)
 
Change History:
<-- versions below in reverse order -->
 
Added:
>
>
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
Line: 55 to 65
 
Other Dependencies: none
Perl Version: 5.005
License: GPL (GNU General Public License)
Changed:
<
<
TWiki:Plugins/Benchmark: GoodStyle nn%, FormattedSearch nn%, PreferencesPlugin nn%
>
>
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
Changed:
<
<
Related Topics: TWikiPreferences, TWikiForms
>
>
Related Topics: TWikiPreferences, TWikiForms
 
Deleted:
<
<
-- TWiki:Main.ThomasWeigert - 08 May 2005
 

Revision 32005-05-08 - Main.TWikiContributor

Line: 1 to 1
 

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.

Line: 44 to 44
 

Plugin Info

Plugin Author: TWiki:Main.ThomasWeigert
Changed:
<
<
Plugin Version: 08 May 2005
>
>
Plugin Version: 15 Apr 2006
 
Change History:
<-- versions below in reverse order -->
 
Added:
>
>
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

Revision 22005-05-08 - Main.TWikiContributor

Line: 1 to 1
 

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.

Revision 12005-05-08 - Main.TWikiGuest

Line: 1 to 1
Added:
>
>

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.

Examples

  • %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:
<-- versions below in reverse order -->
 
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

 
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 TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.PreferencesPlugin