Extension:EntitySchema

MediaWiki extensions manual

File:OOjs UI icon advanced-invert.svg 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	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate> readme
Parameters $wgEntitySchemaSkippedIDs $wgEntitySchemaNameBadgeMaxSizeChars $wgEntitySchemaSchemaTextMaxSizeBytes $wgEntitySchemaEnableDatatype $wgEntitySchemaShExSimpleUrl
Hooks used BeforeDisplayNoArticleText ContentModelCanBeUsedOn ExtensionTypes FormatAutocomments HtmlPageLinkRendererEnd ImportHandleRevisionXMLTag LoadExtensionSchemaUpdates PageHistoryLineEnding SidebarBeforeOutput SkinTemplateNavigation::Universal Universal extensions TitleGetRestrictionTypes WikibaseRepoDataTypes WikibaseRepoOnParserOutputUpdaterConstruction
Quarterly downloads
Public wikis using
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

• <translate> [[<tvar name=2>Special:ExtensionDistributor/EntitySchema</tvar>|Download]] and move the extracted <tvar name=name>EntitySchema</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
  <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/EntitySchema
• <translate> Only when installing from Git, run <tvar name=composer>Composer</tvar> to install PHP dependencies, by issuing <tvar name=code>composer install --no-dev</tvar> in the extension directory.</translate> <translate> (See <tvar name=phab><translate> task <tvar name=1>T173141</tvar></translate></tvar> for potential complications.)</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'EntitySchema' );
  

  Configure as required.
• 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>

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