TIP AutoSubPlugin is not installed on Foswiki.org.

Auto Sub Plugin

Plugin designed to substitute links (or any other formatting) for wiki-words and non-wiki-words alike.


Gives the ability to do substitution of text in a wiki document, which may include things like:
  1. Automatic formatting of keywords
  2. Automatic linking of keywords
  3. Translation of keywords

AUTOSUB{...} -- define text substitutions for wiki pages

  • Parameters:
    Parameter Description Default
    name Text to auto-replace none, required parameter
    fmtMacro Replacement text. May be a wiki macro, however, the wiki macro being substituted may not encorporate other macros. If this is done, the wiki will complain to the administrator. none - no substitution

  • Syntax: %AUTOSUBS%
  • %AUTOSUBS% generates a table in place containing all links/substitutions known to this plug-in, which are only those in the topic page in which this macro appears and any included topics.

NOAUTOSUB{...} -- disable a text substitution for a wiki page

If a link/substitution has been defined for the text specified by the "name" parameter, this will prevent that text from being substituted in the page on which this macro is used.

This may be useful if, for example, a list of AUTOSUB macros is used on a topic being included on a page where the including topic does not want the substitution to be made.

AutoSubPlugin Settings

You can override the default settings as documented in preferences. These preferences can be set in your SitePreferences, or in WebPreferences, or in individual topics.

Preference Use to Default
AUTOSUBPLUGIN_DEBUG Enable debugging output, which is stored in files in the plug-in's work area on the server and is not accessible via the web 0
AUTOSUBPLUGIN_PROTECTED Specify HTML or HTML-style tags to be protected from substitutions by this plug-in "pre noautolink dot verbatim plantuml"

If the protected tags value is changed, it is strongly recommended that pre and noautolink remain in the list, at the beginning and in that order.


Examples can be found in AutoSubPluginExamples.

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.


Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.


No dependencies.

Known Bugs



Plugin Info

Change History:  
13 Aug 2015 1.0.0 Initial release.

PackageForm edit

Author Foswiki:Main.JohnKnutson
Version v1.0.0
Release 1.0.0
Copyright © 2015, Applied Research Laboratories, the University of Texas at Austin
License GPLv3
Home http://foswiki.org/Extensions/AutoSubPlugin
Support http://foswiki.org/Support/AutoSubPlugin
Repository https://github.com/foswiki/AutoSubPlugin
ExtensionClassification Interface and Visualisation
ExtensionType PluginPackage
DemoUrl http://
SupportUrl AutoSubPlugin
Topic attachments
I Attachment Action Size Date Who Comment
AutoSubPlugin.md5md5 AutoSubPlugin.md5 manage 162 bytes 21 Oct 2016 - 02:21 JohnKnutson  
AutoSubPlugin.sha1sha1 AutoSubPlugin.sha1 manage 186 bytes 21 Oct 2016 - 02:21 JohnKnutson  
AutoSubPlugin.tgztgz AutoSubPlugin.tgz manage 22 K 21 Oct 2016 - 02:20 JohnKnutson  
AutoSubPlugin.zipzip AutoSubPlugin.zip manage 29 K 21 Oct 2016 - 02:20 JohnKnutson  
AutoSubPlugin_installerEXT AutoSubPlugin_installer manage 4 K 21 Oct 2016 - 02:21 JohnKnutson  
COPYING.txttxt COPYING.txt manage 34 K 21 Oct 2016 - 02:19 JohnKnutson GNU General Public License v3
Topic revision: r2 - 27 Mar 2017, JohnKnutson - This page was cached on 09 Apr 2017 - 12:35.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License