Extension:PCR GUI Inserts

PCR GUI Inserts lets you add pieces of HTML code at the top, bottom or below the sidebar of your wiki, the Graphical user interface (GUI) area. There is no limit to what you can add within these areas.

The idea for this extension came from the observation that adding a simple item to a wiki, like a stat-tracking script or a donation button, although easy in theory is still quite tedious. Before you needed to either:
 * manually edit the skin (all your activated skins, every time you upgrade MediaWiki)
 * install one extension for every feature you want to add. Thus there is the Piwik extension, the Google Analytics extension, the Google Adsense extension (and even another one), the donation button extension, etc.

Install one extension for every feature causes problems:
 * first, you end up with quite a lot of tiny extensions, and
 * second, sometimes there isn't the extension you need to add one specific element. For example, what if you wanted to insert Ad Bard ads? No extension is able to do this currently.

That's where PCR GUI Inserts is useful: it handles the hooks, and only the hooks, and you handle the HTML code, all the HTML code.

Installation

 * Download the source code zip file and extract the PCR GUI Inserts 1.0-b1 folder.
 * Move the PCR GUI Inserts 1.0-b1 folder to your  folder.
 * Add the following code at the end of LocalSettings.php:

Configuration
By default, the extension won't output anything. You can edit the following settings in LocalSettings.php (add them after the line which includes the extension):

Add to the top of the wiki
$wgPCRguii_Inserts['addHeadItem'] is used to add items at the end of the area. For meta-tags or if you want to add a script at the top:
 * $wgPCRguii_Inserts['addHeadItem']['on']: boolean, whether or not to enable this feature (default: false)
 * $wgPCRguii_Inserts['addHeadItem']['content']: an array of things you want to insert there, for instance:

You will want to keep statistics at the bottom for faster content loading.

Add to the bottom of the wiki
$wgPCRguii_Inserts['BeforePageDisplay'] adds items at the end of a page, at the bottom but still within the content frame.


 * $wgPCRguii_Inserts['BeforePageDisplay']['on']: boolean, whether or not to enable this feature (default: false)
 * $wgPCRguii_Inserts['BeforePageDisplay']['content']: a string of things you want to insert, for instance:

Add to the bottom of the wiki
$wgPCRguii_Inserts['SkinAfterBottomScripts'] adds items  at the very bottom of a page, below the footer including the "Powered by MediaWiki" button. This is usually where you'll want to add tracking scripts.


 * $wgPCRguii_Inserts['SkinAfterBottomScripts']['on']: boolean, whether or not to enable this feature (default: false)
 * $wgPCRguii_Inserts['SkinAfterBottomScripts']['content']: a string of things to insert there, for example Google Analytics and Quantcast tracking:

Add below the side bar
$wgPCRguii_Inserts['SkinBuildSidebar'] adds items below the side bar. For vertical ads or a donation button.
 * $wgPCRguii_Inserts['SkinBuildSidebar']['on']: boolean, whether or not to enable this feature (default: false)
 * $wgPCRguii_Inserts['SkinBuildSidebar']['content'] example:

Adding a Piwik statistics code at the bottom
(example for Piwik 0.9 to 1.1.1)

Examples

 * Please add your URL to the bottom of the list.


 * Wiki4Games.com, the video game wiki
 * EntCyclopedia, the satirical wiki
 * Pneumapedia.org, the free encyclopedia of airguns
 * WikiArquitectura.com A Wiki dedicated to Architecture. Initially in Spanish

Changelog

 * 1.0 (2011-03-02): added German and French locales
 * 1.0-b1 (2010-08-09): first published version