Item8467: Incorrect reference to WIKIPREFSTOPIC in documentation

The Plugin Settings section references WIKIPREFSTOPIC as the location for storing preference settings but is that really correct?

Rather than:

Plugin Settings

Plugin settings are stored as preferences values. To change the setting you need to overwrite them in DefaultPreferences. Changing them here will have no effect! This allows you to upgrade the plugin without having worry about loosing your settings.

• Enabled state - if disabled, does nothing. You will need to overwrite this if you want the plugin enabled anywhere (either in site or per-web)

Shouldn't that section read something like:

Plugin Settings

Plugin settings are stored as preferences values. You can override the defaults for these preferences in SitePreferences, the WebPreferences topic of the current web, or in individual topics, using the standard 'Set' syntax e.g:

   * Set BATCHUPLOADPLUGIN_ENABLED = 1

Changing them here will have no effect! This allows you to upgrade the plugin without having worry about losing your settings.

Configurable Preferences

• Enabled state - if disabled, does nothing. You will need to overwrite this if you want the plugin enabled anywhere (either in site or per-web)

-- BryanThale - 04 Feb 2010

Hi, me again.

You probably meant to delete the paragraph that follows the "Configurable Preferences" heading in the updated plugin topic.text and reference Foswiki:Tasks.Item8467 in the change log.

-- BryanThale - 12 Feb 2010

I realize it might be too late, but in an attempt not be a total PITA , should I continue to report problems similar to this that I find in other plugin topics? The GaugePlugin also mentions configuring the plugin via WIKIPREFSTOPIC which could trip someone up and cost them their settings when they upgrade. Should I file a bug report per plugin or is once enough?

-- BryanThale - 16 Feb 2010

yes, please continue to report these bugs. they are definitely appreciated---keep up the good work! don't report one bug per plugin, but instead one per bug.

-- WillNorris - 16 Feb 2010

Commenting is disabled while not logged in