MediaWiki extensions manual

EntitySchema Release status: stableCategory:Stable extensions
Implementation	ContentHandler Category:ContentHandler extensions, Page action Category:Page action extensions, Special page Category:Special page extensions, API Category:API extensions
Description	Allows to store Shape Expression Schemas on wiki pages
Author(s)	The Wikidata team
Latest version	continuous updates
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.Category:Extensions with release branches compatibility policy
MediaWiki	masterCategory:Extensions with manual MediaWiki version
Database changes	Yes
Tables	entityschema_id_counter
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball Category:Extensions in Wikimedia version control readme
Parameters $wgEntitySchemaSkippedIDs $wgEntitySchemaNameBadgeMaxSizeChars $wgEntitySchemaSchemaTextMaxSizeBytes $wgEntitySchemaIsRepo $wgEntitySchemaShExSimpleUrl
Hooks used BeforeDisplayNoArticleText Category:BeforeDisplayNoArticleText extensions CanonicalNamespaces Category:CanonicalNamespaces extensions ContentHandlerForModelID Category:ContentHandlerForModelID extensions ContentModelCanBeUsedOn Category:ContentModelCanBeUsedOn extensions ExtensionTypes Category:ExtensionTypes extensions FormatAutocomments Category:FormatAutocomments extensions GetContentModels Category:GetContentModels extensions HtmlPageLinkRendererEnd Category:HtmlPageLinkRendererEnd extensions ImportHandleRevisionXMLTag Category:ImportHandleRevisionXMLTag extensions LoadExtensionSchemaUpdates Category:LoadExtensionSchemaUpdates extensions OutputPageParserOutput Category:OutputPageParserOutput extensions PageHistoryLineEnding Category:PageHistoryLineEnding extensions ResourceLoaderRegisterModules Category:ResourceLoaderRegisterModules extensions SidebarBeforeOutput Category:SidebarBeforeOutput extensions SkinTemplateNavigation::Universal Category:SkinTemplateNavigation::Universal extensions SpecialPage_initList Category:SpecialPage initList extensions TitleGetRestrictionTypes Category:TitleGetRestrictionTypes extensions WikibaseClientDataTypes Category:WikibaseClientDataTypes extensions WikibaseRepoDataTypes Category:WikibaseRepoDataTypes extensions WikibaseRepoEntitySearchHelperCallbacks Category:WikibaseRepoEntitySearchHelperCallbacks extensions WikibaseRepoOnParserOutputUpdaterConstruction Category:WikibaseRepoOnParserOutputUpdaterConstruction extensions WikibaseRepoSearchableEntityScopes Category:WikibaseRepoSearchableEntityScopes extensions WikibaseRepoSearchableEntityScopesMessages Category:WikibaseRepoSearchableEntityScopesMessages extensions
Quarterly downloads	8 (Ranked 108th)
Translate the EntitySchema extension
Issues	Open tasks · Report a bug

The EntitySchema extension allows storing Shape Expressions Schemas on wiki pages (using ShExC syntax), as well as validating entities against those Schemas using the ShEx2 — Simple Online Validator. For more information on enabling this second part, see #Configuration.

Installation

• Download and move the extracted EntitySchema folder to your extensions/ directory.
  Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/EntitySchema
• Only when installing from Git, run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (See T173141 for potential complications.)Category:Extensions requiring Composer with git
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'EntitySchema' );
  

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

Configuration

Prerequisites for displaying the optional "check entities against this Schema" link on the Schema page:

• In your "LocalSettings.php", set $wgEntitySchemaShExSimpleUrl to a non-empty string which represents the external verification tool to use (e.g. https://tools.wmflabs.org/shex-simple/wikidata/doc/shex-simple.html).
• The link is only displayed on pages where the Schema text is not empty

See also

• Schemas and WikiProject Schemas on Wikidata

• Top Wikibase extensions — Curated list of key Wikibase extensions

This extension is included in the following wiki farms/hosts and/or packages: ProWikiCategory:Extensions included in ProWiki This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm.

This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.