This plugin inserts a common header and/or footer into every topic,
without requiring special tags in each topic.
In general, this plugin does not require special syntax,
since it is intended to insert a common header or footer without
special syntax in each topic.
Preference variables (described below) specify
which topics to use for the common header and footer,
and which topics or webs should be allowed or denied such headers and footers.
: To prevent infinite recursion,
this plugin will not include the common header or footer in the header or footer topics.
In other topics where you explicitly want a header or footer, you can use:
%COMMONHEADER% to include the common header.
%COMMONFOOTER% to include the common footer.
In topics where you explictly do not
want a header or footer, you can use:
%COMMONHEADERSKIP% to skip the common header.
%COMMONFOOTERSKIP% to skip the common footer.
Plugin settings are stored as preferences variables. To reference
a plugin setting write
- One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Insert a common header and/or footer into topics
- Topic containing common header (if web is not specified, plugin looks in same web as parent topic).
- Topic containing common footer (if web is not specified, plugin looks in same web as parent topic).
- Comma-separated list of topics that should never have common header
- Comma-separated list of topics that should never have common footer
- Comma-separated list of topics that should have common header
- Comma-separated list of topics that should have common footer
- Comma-separated list of webs that should have common header
- Set ALLOWHEADERWEB = Sandbox
- Comma-separated list of webs that should have common footer
- Set ALLOWFOOTERWEB = Sandbox
- Debug plugin: (See output in
Plugin Installation Instructions
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 TWiki server.
- Download the ZIP file from the Plugin web (see below)
CommonHeaderFooterPlugin.zip in your twiki installation directory. Content:
| File: || Description: |
| Plugin topic |
| Plugin Perl module |
- Configure the Plugin:
- TWiki 4.0 and up: Run the configure script to enable the Plugin
- Change the Plugin settings as needed
- Test if the installation was successful: see above
Related Topics: TWikiPlugins
- 16 Jun 2006