CommonHeaderFooterPlugin

This plugin inserts a common header and/or footer into every topic, without requiring special tags in each topic.

Syntax Rules

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.

NOTE: 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.

Examples

Plugin Settings

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

• 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).
  • Set HEADERTOPIC = CommonHeader

• Topic containing common footer (if web is not specified, plugin looks in same web as parent topic).
  • Set FOOTERTOPIC = CommonFooter

• Comma-separated list of topics that should never have common header
  • Set DENYHEADERTOPIC = TwikiResources, WebChanges, WebIndex, WebNotify, WebPreferences, WebRss, WebSearch, WebSearchAdvanced, WebStatistics, WebTopicList

• Comma-separated list of topics that should never have common footer
  • Set DENYFOOTERTOPIC = TwikiResources, WebChanges, WebIndex, WebNotify, WebPreferences, WebRss, WebSearch, WebSearchAdvanced, WebStatistics, WebTopicList

• Comma-separated list of topics that should have common header
  • Set ALLOWHEADERTOPIC =

• Comma-separated list of topics that should have common footer
  • Set ALLOWFOOTERTOPIC =

• 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 data/debug.txt)
  • Set DEBUG = 0

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 TWiki server.

• Download the ZIP file from the Plugin web (see below)
• Unzip CommonHeaderFooterPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/CommonHeaderFooterPlugin.txt	Plugin topic
  lib/TWiki/Plugins/CommonHeaderFooterPlugin.pm	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

Plugin Info

Plugin Author:	TWiki:Main.ClifKussmaul
Copyright:	© 2006, TWiki:Main.ClifKussmaul
License:	GPL (GNU General Public License)
Plugin Version:	16 Jun 2006 (V1.000)
Change History:
16 Jun 2006:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Benchmarks:	GoodStyle nn%, FormattedSearch nn%, CommonHeaderFooterPlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/CommonHeaderFooterPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/CommonHeaderFooterPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/CommonHeaderFooterPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWiki:Main.ClifKussmaul - 16 Jun 2006