Extension:WimaAdvertising

MediaWiki extensions manual

WimaAdvertising Release status: stable
Implementation	Skin , MyWiki , Hook
Description	Ads banners defined in LocalSettings.php
Author(s)	WikiMANNia (WikiForMentalk)
Latest version	2.5.0 (2023-12-07)
MediaWiki	1.35+
PHP	7.3.19+
License	GNU General Public License 2.0 or later
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net .
Example	http://39.wikimannia.org
Parameters $wmWimaAdvertising $wmWimaAdvertisingAnonOnly $wmBannerTopCode $wmBannerTopStyle $wmBannerTopType $wmBannerBottomCode $wmBannerBottomStyle $wmBannerBottomType $wmSidebarAd1Code $wmSidebarAd1Type $wmSidebarAd2Code $wmSidebarAd2Type
Hooks used BeforePageDisplay SidebarBeforeOutput SiteNoticeAfter SkinAfterContent SkinAfterPortlet

The WimaAdvertising extension offers four additional advertising blocks to the Cologne Blue , Modern , MonoBook , Timeless , and Vector skin. The banners are placed in the top and bottom of the wiki and two of them in the sidebar . Google Adsense is supported.

Use

One ad block is located at the top of the "MediaWiki:Sitenotice", a second one below the article text and above the category bar and two more ad blocks in the sidebar. By entering * AD1 and * AD2 in the MediaWiki:Sidebar, these can be placed individually. If Sitenotice is defined, the TopBanner will be displayed randomly alternating with the Sitenotice message.

Installation

• Download and place the file(s) in a directory called WimaAdvertising in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'WimaAdvertising' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'WimaAdvertising' );, you need to use:

require_once "$IP/extensions/WimaAdvertising/WimaAdvertising.php";

Generall configuration

Enable advertising. Default is false.

$wmWimaAdvertising = true;

Disable advertising for logged-in users. Default is false.

$wmWimaAdvertisingAnonOnly = true;

Wima web slots

BannerType

Set the type of the banner

• Possible values: 'advertising', 'eventnote', 'hint'
• Default value: 'advertising'

$wmBannerTopType = "eventnote";
$wmBannerBottomType = "eventnote";
$wmSidebarAd1Type = "advertising";
$wmSidebarAd2Type = "hint";

The labels above the advertising blocks will be translated into: de, en, es, fr, it, nl, pt, ru

BannerCode

Set a html snippet of the banner.

$wmBannerTopCode = '<a title="Uhren-Wiki" href="https://www.uhren-wiki.net"><img src="https://wikimannia.org/skins/werbung/Werbung - Oben.jpg" width="728" height="92" alt="Werbung" /></a>';
$wmBannerBottomCode = '
Your banner code here.
';

$wmSidebarAd1Code = '<a title="Schwarzbuch Wikipedia" href="https://de.wikimannia.org/Schwarzbuch_Wikipedia"><img src="https://wikimannia.org/werbung/images/130px-Schwarzbuch_Wikipedia.jpg" alt="Schwarzbuch_Wikipedia.jpg" /></a> <p><b>Schwarzbuch Wikipedia</b></p><p class="small">Mobbing, Diffamierung und Falschinformation in der Online-Enzyklopädie, und was jetzt dagegen getan werden muss.</p><p>Im Februar 2020 im <i>Zeitgeist-Verlag</i> erschienen.</p>';
$wmSidebarAd2Code = 'Your banner code here.';

You can also do Google AdSense:

$wmSidebarAd2Code = '<script type="text/javascript"><!--
google_ad_client = "pub-9471398824076666";
/* ID 007 */
google_ad_slot = "3512091103";
google_ad_width = 145;
google_ad_height = 260;
google_language = "en";
google_encoding = "utf8";
// -->
</script>
<script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>';

BannerStyle

Set the CSS style specifications for the banner.

$wmBannerTopStyle = 'text-align:center;border:1px solid blue;';
$wmBannerBottomStyle = 'text-align:center;border:1px dotted red;';
$wmSidebarAd1Style = '';
$wmSidebarAd2Style = '';

Google Adsense

Enable advertising. Default is false.

$wmGoogleAdSense = true;

Disable advertising for logged-in users. Default is false.

$wmGoogleAdSenseAnonOnly = true;

The type of the banner here is fix 'advertising'.

Mandatory parameters

// Replace this with your own publisher ID (google_ad_client / data-ad-client)
$wmGoogleAdSenseClient = 'none'; // Client ID for your AdSense script (example: ca-pub-1234546403419693)

(You can get your publisher ID and ad unit ID from the "Get code" page: Get and copy the ad code.)

Optional parameters

Add any of the optional settings below – if your settings deviate from the defaults:

// This can be anything you like. Default is 'none'.
$wmGoogleAdSenseID = 'none';

// Source URL of the AdSense script. No need to change - it can't deviate from the defaults.
$wmGoogleAdSenseSrc = '//pagead2.googlesyndication.com/pagead/show_ads.js';

// Text coding. Default is 'utf8'.
$wmGoogleAdSenseEncoding = "utf8";

// Advertising language. Default is $wgLanguageCode.
$wmGoogleAdSenseLanguage = "en";

Ad units

Define up to four ad units:

$wmGoogleAdSense_AD1= [ 'slotid 1', 145, 260 ];
$wmGoogleAdSense_AD2= [ 'slotid 2', 145, 260 ];
$wmGoogleAdSense_Top= [ 'slotid 3', 145, 260 ];
$wmGoogleAdSense_Bottom = [ 'slotid 4', 145, 260 ];

Replace the first value with your AdSense ad unit ID (google_ad_slot / data-ad-slot) for each ad unit. The Slot ID for your AdSense script is for example 1234580893.

Also specify in the second and third value the width and the height of the AdSense unit, specified in your AdSense account (google_ad_width / data-ad-width, google_ad_height / data-ad-height). Values such as 'auto', '100%', '60%' etc. are accepted.

Example

This example is doing the same as the example above in chapter BannerCode:

$wmWimaAdvertising = false;
$wmGoogleAdSense = true;
$wmGoogleAdSenseClient = 'pub-9471398824076666';
$wmGoogleAdSenseID = 'ID 007';
$wmGoogleAdSense_AD1 = [ '3512091103', 145, 260 ];
$wmGoogleAdSenseSrc = 'https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js';

Hacks

If your are using version MediaWiki 1.35 or 1.36 you will find advise and documentation outlined in this version of the documenation.

See also

• PCR GUI Inserts did something similar since REL 1.23, but not as sophisticated.

Remarks

• Branch REL1_25 for MediaWiki 1.23 up to 1.35.
• Branch REL1_35 for MediaWiki 1.35+.
• Version 2.1 has added support for Skin vector-2022.
• Version 2.2 has added support for Skin Timeless.
• Version 2.3 has added Hook SkinAfterPortlet for supporting MediaWiki 1.35+.
• Version 2.4 has some Refactoring:

  Changed “configuration schema”, replaced manifest version 1 with version 2 and changed the prefix of the configuration variables from default to wm.

  Replaced class “WimaAdvertisingHooks” (extends “Hooks”) with class implements interfaces.

• Version 2.4.1 contains a dirty hack for skin Timeless.
• Version 2.5 places JavaScript for GoogleAdSense in <head> section.
• Tested with: 1.35.13, 1.39.5, 1.40.1.

Version 3.0

• The version 3.0 (alpha) has a new approach, with click-away ads that are fixed and do not disappear when scrolling, and are (largely) independent of the skin.
• At the moment only tested with MediaWiki version 1.39.1.
• Download on GitHub (alpha Version)