MediaWiki extensions manual

EntitySchema Release status: stable
Implementation	ContentHandler , Page action , Special page , API
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.
MediaWiki	master
Database changes	Yes
Tables	entityschema_id_counter
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review readme
Parameters $wgEntitySchemaSkippedIDs $wgEntitySchemaNameBadgeMaxSizeChars $wgEntitySchemaSchemaTextMaxSizeBytes $wgEntitySchemaEnableDatatype $wgEntitySchemaShExSimpleUrl
Hooks used BeforeDisplayNoArticleText ContentModelCanBeUsedOn ExtensionTypes FormatAutocomments ImportHandleRevisionXMLTag LoadExtensionSchemaUpdates PageHistoryLineEnding SidebarBeforeOutput SkinTemplateNavigation::Universal TitleGetRestrictionTypes WikibaseRepoDataTypes WikibaseRepoOnParserOutputUpdaterConstruction
Quarterly downloads	12 (Ranked 158th)
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 place the file(s) in a directory called EntitySchema in your extensions/ folder.
• Only when installing from Git, run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (See task T173141 for potential complications.)
• 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

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.