Global Replace Plugin

Introduction

The Global Replace Plugin is designed to:

1. Search through topics with user supplied criteria
2. Find strings within the topics found
3. Provide a mechanism to pick and choose which hits will be replaced
4. Replace the hit with a user supplied expressions

Please go to GlobalSearchAndReplace to perform a global replace operation.

Plugin Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Global search and replace functionality across all topics in a web

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Examples

Example 1: Changing a string

1. Click Raw Edit from a page.
2. Copy the string you want to change into the clipboard.
3. Go to GlobalSearchAndReplace and paste the string into the "Replace search string" field. This is the field you want to replace.
4. Select web and a search string.
5. Escape any non-numeric and non-alphabetic character with a backslash, such as } with \}. This applies to the "Replace search string" field only.
   • Example: \%EDITCELL\{checkbox, 3, Input data exchange, ... \}\%
6. Copy-paste the string to the "Replace string" field and modify it as needed.
7. Press the "Search"-button and verify that the replaced and replacing strings are as expected.
8. Set all the checkboxes of the strings you want to replace. You can also select "Set all".
9. Click "Replace all check-marked hits".

Example 2: Inserting a line below another line

1. Follow the previous example to the point where "Replace search string" is inserted.
2. Use (\n) in the "Replace search string", at the end of the line. This will be stored for use in the "Replace string". You can reference it with $n, where n is a number 0 to 9.
   • Example: We want to replace a line which ends to a string Shutdown}% |.
     "Replace search string": Shutdown\}\% \|(\n) and "Replace string": Shutdown}% |$1Something$foo-bar$1

Note: Using this trick you can also insert a line before another line.

• Example: We want to insert a line before another line, which begins with a string | *Keywords:* |.
  "Replace search string": \| \*Keywords\:\* \|(.*?)(\n) and "Replace string": Something $2| *Keywords: |$1$2
• Example: We want to replace a line which begins with a string | *Keywords:* | and ends with or contains the string Interrupt}%.
  "Replace search string": \| \*Keywords\:\* \|(.*?)Interrupt\}\%(.*?)(\n) and "Replace string": Something $3| *Keywords: |$1Interrupt}%$2$3

Known Issues

• This plugin ignores locked topics, it writes over locked topics.
• This plugin is potentially dangerous. Security measures:
  1. The operations of this plugin is restricted to the group which can edit the TWikiPreferences (usually TWikiAdminGroup).
  2. For public sites, it is recommended to enable this plugin only for the short time when needed (it is enabled if the following variable shows "installed": %GLOBALREPLACE{func="check"}%).
• This plugin has been tested. However, it does not have ANY WARRANTY, does not even have the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

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 Plugins web (see below).
• Unzip GlobalReplacePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/GlobalReplacePlugin.txt	Plugin topic
  data/TWiki/GlobalSearchAndReplace.txt	Search replace form topic
  data/TWiki/GlobalSearchAndReplaceHelp.txt	Help topic
  data/TWiki/GlobalSearchAndReplaceTopics.txt	Replace result topic
  lib/TWiki/Plugins/GlobalReplacePlugin.pm	Plugin Perl module
  pub/TWiki/Plugins/GlobalSearchAndReplaceHelp/gsr.png	Screenshot

• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Test if the installation was successful:
  • Plugin is installed if the following variable shows "installed": %GLOBALREPLACE{func="check"}%
• After each use it is recommended to disable this plugin in the {Plugins} section of configure.

Plugin Info

Related Topics: GlobalSearchAndReplace, GlobalSearchAndReplaceHelp, GlobalSearchAndReplaceTopics, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences