Extension:MetaDescriptionTag

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
English • ‎dansk • ‎русский • ‎日本語
MediaWiki extensions manual
Crystal Clear action run.svg
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
Tags
<metadesc>
Hooks used
ParserFirstCallInit
OutputPageParserOutput
Translate the MetaDescriptionTag extension if it is available at translatewiki.net
Check usage and version matrix.

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

Installation[edit]

  • Download, extract and place the file(s) in a directory called MetaDescriptionTag in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'MetaDescriptionTag' );
    
  • Yes 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( 'MetaDescriptionTag' );, you need to use:

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

Usage[edit]

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[edit]

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[edit]

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[edit]