Extension:MetaDescriptionTag

From Linux Web Expert

MediaWiki extensions manual
MetaDescriptionTag
Release status: stable
Implementation Tag
Description Provides a tag for adding a custom ‎<meta> description to the document's ‎<head>
Author(s) Dror S., Joshua C. Lerner (original author)
Latest version 0.4.0 (2017-05-22)
MediaWiki 1.25+
Database changes No
License MIT License
Download
See below
‎<metadesc>
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').

The MetaDescriptionTag allows users to add a ‎<meta> description into a page's ‎<head>.

Installation

  • <translate> <tvar name=1>Download</tvar> and place the file(s) in a directory called <tvar name=name>MetaDescriptionTag</tvar> in your <tvar name=ext>extensions/</tvar> folder.</translate>
  • <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>
    wfLoadExtension( 'MetaDescriptionTag' );
    
  • File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Usage

Once installed, editors of your wiki can add a ‎<meta> description tag by adding the following to the article text:

<metadesc>PageDescription</metadesc>

Where PageDescription would be replaced by the desired meta description.

For example, the above would become:

<meta name="description" content="PageDescription" />

Usage through a template

Say for example you want use a template to set the meta description to something like:

<metadesc>Extract from the article ARTICLETITLE</metadesc>

Create a template called (for example) "Template:Metadesc". Add the following content:

{{#tag:metadesc | Extract from the article {{{1}}} }}

In the article to which you set the meta description, add:

{{metadesc|{{PAGENAME}} }}

Changelog

0.4.0

This is re-write to make it compatible with more modern MediaWiki practices and make sure it works nicely with MediaWiki 1.27+:

  • Extension Registration (extension.json)
  • json i18n files - An actual README file! :-)
  • Switching to semantic versioning.
0.3

Fix i18n to work with v1.16+, sanitize output using htmlspecialchars().

0.2

Change syntax to <metadesc>some content</metadesc> to support template variable substitution.

0.1

Initial release.

See also