Replace Text Plugin

By default, the plugin uses from, to, search, replace parameters, as documented at REPLACETEXT. The search and replace parameters allows for more complex search and replace operations using regular expression grouping.

If you need even more control over search and replace you can write your own search and replace module, such as to sort a list based on the search and replace operation. For this you can clone and modify twiki/lib/TWiki/Plugins/ReplaceTextPlugin/CustomReplace.pm. Specify the name of your module in the $TWiki::cfg{Plugins}{ReplaceTextPlugin}{CustomReplace} configure setting, such as 'TWiki::Plugins::ReplaceTextPlugin::MyReplace'.

Add a function as follows:

replaceText( $web, $topic, $text, $search, $replace ) -> $text

• =$web: =Name of web
• =$topic: =Name of topic
• =$text: =Text of topic
• =$search: =Text to search for
• =$replace: =Text to replace with
• =return: =Text with replacement

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
  • See the installation supplement on TWiki.org for more information.

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins home (see below).
  • Unzip ReplaceTextPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/ReplaceTextPlugin.txt	Plugin topic
    data/TWiki/VarREPLACETEXT.txt	Variable documentation
    lib/TWiki/Plugins/ReplaceTextPlugin.pm	Plugin Perl module
    lib/TWiki/Plugins/ReplaceTextPlugin/Config.spec	Configuration spec file
    lib/TWiki/Plugins/ReplaceTextPlugin/Core.pm	Plugin core module
    lib/TWiki/Plugins/ReplaceTextPlugin/CustomReplace.pm	Template for custom replace module

  • Set the ownership of the extracted directories and files to the webserver user.

• Plugin configuration:
  • Run the configure script and enable the plugin in the Plugins section.

• Test if the configuration is successful:
  • Try the replacement form above, preferably with the Sandbox web