Manual:Page content models

The ContentHandler introduced in MediaWiki 1.21 allows you to add new content models other than wikitext.

It makes it possible for wiki pages to be composed of data other than wikitext, and represented in any way — for example: Markdown, reStructuredText, icalendar, or a custom XML format.

The display and editing of these content models can be handled in custom ways (e.g. different syntax highlighting, or whole new data-entry forms).

This page steps through how to create a new content model in an extension.

It assumes some familiarity with general extension development practices. For a brief summary of the requirements, see the 1>#Summary|Summary section at the bottom of this page.

A meaningless "Goat" content model will be used for the examples.

You can also examine the DataPages extension, which is part of .

Registration
First of all, add the content model's name and handler class to your :


 * The left-hand value here is the name of the content type, it can be any unique string you want, and it lives alongside the five built-in content types: 'wikitext', 'JavaScript', 'CSS', 'plain text', 'JSON'. This value is exposed to users in places such as Special:ChangeContentModel and 2>Special:Info/Manual:Page content models|page information.
 * The right-hand value is the fully-qualified name of a class that extends.

This will require two new classes,   and <tvar|2> </>, to be added to <tvar|3></> (if their namespace isn't in <tvar|4></>).

More information about these classes is given below.

Optional content model constants
The 'goat' string above is the content model's ID (generally called <tvar|1> </> in code), and is usually also defined as a constant.

These constants are defined for all built-in content models, and lots of documentation refers to the "<tvar|1>CONTENT_MODEL_XXX</>" constants.

If you have not defined them, this can be a bit confusing.

The definition should be done via the 1>Manual:Extension.json/Schema#callback</>|callback item in extension.json. For example:

In <tvar|1> </>:

In <tvar|1> </>:

You don't have to do it this way, and could just use the string.

Assigning content models to pages
If you want an entire wiki namespace to have a default content model, you can define it as such in <tvar|1>extension.json</>:

Or if you want to determine the content type by the addition of a quasi-file-type suffix on the wiki page name, you can use the <tvar|1></> hook. For example:

ContentHandler
The next thing to define is the <tvar|1>GoatContentHandler</> class, which is where we also specify what format this content type will be stored as (in this case, text).

ContentHandlers don't know anything about any particular page content, but determine the general structure and storage of the content.

Content
The <tvar|1>GoatContent</> class is the representation of the content's data, and does not know anything about pages, revisions, or how it is stored in the database.

Beside the required seven inherited methods, you can add other public methods are domain-specific; in this case we want to be able to retrieve the goat's name.

Edit form
Now we've got the skeleton set up, we'll want to try editing a Goat.

To do this, we create <tvar|1> </> and specify what actions we want to map to what classes.

To start with, we'll just deal with 'edit' (which corresponds to <tvar|1> </> in the URL).

And we'll create our new <tvar|1>GoatEditAction</> class, basically the same as the core <tvar|2>EditAction</> but using our own <tvar|3>GoatEditPage</>:

Our new <tvar|1>GoatEditPage</> class is where the action happens (excuse the pun):

You should now be able to edit a page and see your form.

But when you put data into it, and hit 'preview', you'll see that things are not yet working fully and that you get no output, nor is your submitted text shown again in the form.

So we must override the 'submit' action as well, with a new <tvar|1>GoatSubmitAction</> class and the addition of <tvar|2> </> to our <tvar|3> </> method.

Our <tvar|1>GoatSubmitAction</> class should be the same as that of core, but inheriting from our <tvar|2>GoatEditAction</>.

Display
A content model is responsible for producing any required output for display.

This usually involves working with its data and producing HTML in some way, to add to the parser output.

Display a description/documentation
Sometimes you may want to display some informations or some documentation for an article that have a custom content model such as JSON.

Actually there aren't 1>Special:MyLanguage/Help:System message</>|system messages to display some text above such pages (with the exception of <tvar|2>MediaWiki:Clearyourcache</> displayed above only JavaScript and CSS pages).

You may want to see <tvar|1>T206395</> for further details.

Comparing revisions
The <tvar|1>GoatDifferenceEngine</> class is the representation of the difference between goat contents.

We override the default <tvar|1> </> method to generate a diff.

In order to tell MediaWiki to use our <tvar|1>GoatDifferenceEngine</>, we overwrite the <tvar|2> </> in our <tvar|3>GoatContentHandler</>.

Summary
To implement a new content model with a custom editing form, create the following: