MediaWiki extensions manual
Metadata
Release status: experimental
Description Adds #metadata parser function to set page properties, and expose them via ‎<meta> tags and a REST API endpoint
Author(s) Sophivorustalk
Latest version 4.0
MediaWiki >= 1.35.0
License GNU General Public License 3.0 or later
Download
Hooks used
  • OutputPageParserOutput
  • ParserFirstCallInit
Quarterly downloads 6 (Ranked 164th)
Translate the Metadata extension if it is available at translatewiki.net

The Metadata extension adds the #metadata parser function to set page properties, and exposes them via ‎<meta> tags and a REST API endpoint.

Installation

  • Download and place the file(s) in a directory called Metadata in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file: 
    wfLoadExtension( 'Metadata' );
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

To set a simple key-value pair for the current page:

{{#metadata:key=value}}

And to set multiple key-value pairs in a single call:

{{#metadata:
| key = value
| foo = bar
| baz
}}

Keys with no value will be assigned a "1" value.

Once set, the properties will be accessible via the HTML <meta> tags, like so:

<meta name="key" content="value" />
<meta name="foo" content="bar" />
<meta name="baz" content="1" />

And also, via the "props" endpoint introduced by this extension to the MediaWiki REST API, with the following URL pattern:

/w/rest.php/v1/page/{title}/props

Finally, the properties can also be accessed via the Properties module of the MediaWiki Action API, with the following URL pattern:

/w/api.php?action=query&prop=pageprops&titles={title}

See also

  • Page metadata
  • Manual:Page props table
  • Extension:MetaMaster
This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.