Extension:Header Footer
From MediaWiki.org
 |
The author of this extension is no longer maintaining it! Meaning any reports for additional features and/or bugfixes will more than likely be ignored. Volunteers are encouraged to take on the task of developing and maintaining it. As a courtesy, you may want to contact the author. You should also remove this template and list yourself as maintaining the extension in the page's {{extension}} infobox. |
 Release status: unmaintained |
|
|---|---|
| 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 | [1] |
| Check usage and version matrix; stats | |
Contents |
Purpose[edit]
Provides per-namespace and per-page header + footer inclusion.
Features[edit]
- 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
Usage[edit]
[edit]
Edit the pages:
MediaWiki:Hf-nsheader-namespace nameMediaWiki: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]
Edit the pages:
MediaWiki:Hf-header-page nameMediaWiki:Hf-footer-page name
Disable commands[edit]
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
CSS[edit]
- 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">
Examples[edit]
- Page MediaWiki:hf-nsheader-Extension would contain the wikitext to be included as header for all pages of the Extension namespace.
- Page MediaWiki:hf-footer-Extension:HeaderFooter would contain the wikitext to be included as footer for the page Extension:HeaderFooter.
Dependency[edit]
Installation[edit]
See the Mediawiki Extension table entry "download" above.[1]
LocalSettings.php[edit]
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" );
- Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.
PEAR[edit]PEAR is a repository of PHP software code.
require 'MediaWiki/HeaderFooter/HeaderFooter.php';
Upgrades through PEAR[edit]Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.
or use the force method:
PEAR Web Frontend[edit]For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here. |
RSS feed[edit]
To keep up-to-date with this channel, use the following RSS feed__
.
Notes[edit]
Other Extensions From the same author[edit]
Consult User Jldupont's page.
- ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
- ↑ 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. - ↑ Modifications to
LocalSettings.phpis only necessary if not using Extension:ExtensionManager
History[edit]
| Release | Notes |
|---|---|
| 2.0.0 | Complete redesign |
| 2.0.1 | Fixed bug related to disable keywords (e.g. __NONSFOOTER__) |
See also[edit]
- Extension:HeadersFooters an independent implementation of similar functionality.
- Extension:PageNotice
- The PageNotice extension provides a way for you to define fixed notice messages for the top or the bottom of a page (by individual page name), or entire namespaces (by namespace number).
