Extension:Header Footer

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

HeaderFooter Release status: stable
Description	Provides per-namespace and per-page header + footer inclusion.
Author(s)	Jean-Lou Dupont
Last Version	2.0.1
MediaWiki	1.10, 1.11, 1.12
License	No license specified
Download	SVN See SVN ($Id: HeaderFooter.doc.wikitext 1170 2008-05-27 12:38:24Z jeanlou.dupont $)
Example	please give example and screenshot
check usage (experimental)

[edit] Purpose

Provides per-namespace and per-page header + footer inclusion.

[edit] Features

• Speed: integrated with parser caching
• Secure: header and footer articles are located in the NS_MEDIAWIKI namespace
• Controllable: headers and/or footers can be disabled on pages which are edit protected
• Customizable: headers and footers are wrapped in <div> elements

[edit] Usage

[edit] Per-Namespace Header and Footer

Edit the pages:

• MediaWiki:Hf-nsheader-namespace name
• MediaWiki:Hf-nsfooter-namespace name

For the 'main' namespace, just use blank i.e. no string, but with the hyphen:

• MediaWiki:Hf-nsheader-
• MediaWiki:Hf-nsfooter-

[edit] Per-Page Header and Footer

Edit the pages:

• MediaWiki:Hf-header-page name
• MediaWiki:Hf-footer-page name

[edit] Disable commands

On edit protected pages, one can add

• __NOHEADER__ to suppress the page level header
• __NOFOOTER__ to suppress the page level footer
• __NONSHEADER__ to suppress the namespace level header
• __NONSFOOTER__ to suppress the namespace level footer

[edit] CSS

• Page Level Header: <div class="hf-header">
• Namespace Level Header: <div class="hf-nsheader">
• Page Level Footer: <div class="hf-footer">
• Namespace Level Footer: <div class="hf-nsfooter">

[edit] Examples

1. Page MediaWiki:hf-nsheader-Extension would contain the wikitext to be included as header for all pages of the Extension namespace.
2. Page MediaWiki:hf-footer-Extension:HeaderFooter would contain the wikitext to be included as footer for the page Extension:HeaderFooter.

[edit] Dependency

• StubManager extension

[edit] Installation

See the Mediawiki Extension table entry "download" above.^[1]

[edit] LocalSettings.php

Extension:ExtensionManager: See footnote^[2]

• Add the following to LocalSettings.php if the extension was downloaded from Jean-Lou Dupont's MediaWiki SVN directory (link in the download entry of the table above)^[2]:

require_once( "$IP/extensions/HeaderFooter/HeaderFooter.php" );

pear channel-discover mediawiki.googlecode.com/svn

pear install mediawiki/HeaderFooter

require 'MediaWiki/HeaderFooter/HeaderFooter.php';

pear upgrade pear

pear clear-cache

pear upgrade --force mediawiki/HeaderFooter

[edit] RSS feed

To keep kept up-to-date with this channel, use the following RSS feed__.

[edit] Notes

[edit] Other Extensions From the same author

Consult User Jldupont's page.

1. ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
2. ↑ ^{2.0 2.1 2.2} Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
   Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
3. ↑ Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

[edit] History

[edit] See also