Wikipedia:AutoWikiBrowser/CheckPage format

If you'd like to constrain the usage of AutoWikiBrowser on your wiki, you may introduce a checkpage, just like the English Wikipedia does. Here is the manual on writing checkpages.

= New format (JSON) = Project:AutoWikiBrowser/CheckPageJSON and Project:AutoWikiBrowser/Config replaces the old Project:AutoWikiBrowser/CheckPage.

Most of the config values are similar, but using a structured JSON format, rather than HTML comments in Wikitext, which is harder to manage and parse.

When the page is saved, it needs to be valid JSON.

Message
By using messages on Project:AutoWikiBrowser/Config, you can make AWB display message box to every AWB user when they log in to your wiki. This may be useful for broadcasting urgent messages related to AWB.

Global (for all AWB users) messages are defined on AutoWikiBrowser/CheckPage/VersionJSON.

Note the version string is for a specific version, or * for all versions.

For example, the JSON below will make AWB version 6.1.0.2 display "Hello, world!".

No general fixes
AWB has a "general fixes" feature. It corrects many formatting and style problems, but may cause problems on pages with tricky markup. To make AWB ignore such pages, use templates  and, like on enwiki. However, if you would like to control this in centralised fashion or this template is already used on your wiki for some purpose, you may use the nogenfixes checkpage directive.

Pages with underscore in their title
Sometimes turning wikilinks pasted from browser's address bar into normalized form (e.g. New_York%2C_New_York → New York, New York) may result in removal of valid underscores from the link. To avoid this, AWB has option of ignoring such links since version 4.0. It loads content of the category that contains such titles. This category is typically populated by a template, such as underscore on enwiki. You can inform AWB of existence of such category by using directive underscoretitles, where category name is without the category namespace prefix.

Typo lists
AWB has a feature of semi-automatic typo fixing. It needs a list of common typos to work. By default, it's looked up at Project:AutoWikiBrowser/Typos (such as AutoWikiBrowser/Typos here on en:), but smaller wikis should benefit from using typos from larger projects in their language. This can be configured using the Typos directive. It has two forms: the first points to local page - "typolink": "MyWiki:TyposToIncinerate". The second one is a full URL that may lead to anywhere - even not to wiki, for example, "typolink": "http://ru.wikipedia.org/w/index.php?title=Википедия:AutoWikiBrowser/Typos&action=raw" would point AWB to the Russian Wikipedia typo list.

Checkpage Boilerplate
It is recommended to use Special:ChangeContentModel to change Project:AutoWikiBrowser/CheckPageJSON on your wiki to have a "New content model" of JSON.

Config Boilerplate
It is recommended to use Special:ChangeContentModel to change Project:AutoWikiBrowser/Config on your wiki to have a "New content model" of JSON.

= Old format (HTML/wikitext) = The old format using HTML comments and wikitext is to be considered deprecated.

Bots

 * Willy on Wheels!
 * Foobot tha Great

Normal users

 * Lorem
 * Ipsum

Details
All directives AWB understand are either hidden in &lt;!-- HTML comments --&gt; or are stored <tt>&lt;!--between--&gt; two of &lt;!--them--&gt;</tt>. If you'd like to keep the directives visible, you may wrap them in <tt>&lt;pre&gt;</tt> tags.

Message
By adding <tt> </tt> anywhere on the page, you will make AWB display "Hello, world!" message box to every AWB user when they log in to your wiki. This may be useful for broadcasting urgent messages related to AWB.

No general fixes
AWB has a "general fixes" feature. It corrects many formatting and style problems, but may cause problems on pages with tricky markup. To make AWB ignore such pages, use templates  and, like on enwiki. However, if you would like to control this in centralised fashion or this template is already used on your wiki for some purpose, you may use <tt> </tt> checkpage directive. Every <tt> Simple wikilink </tt> between the colon character and the final end of comment(<tt>--&gt;</tt>) denotes a page to be ignored. You may add an explanations outside wikilinks as to why the page should be ignored, see above for example.

Pages with underscore in their title
Sometimes turning wikilinks pasted from browser's address bar into normalized form (e.g. New_York%2C_New_York → New York, New York) may result in removal of valid underscores from the link. To avoid this, AWB has option of ignoring such links since version 4.0. It loads content of the category that contains such titles. This category is typically populated by a template, such as underscore on enwiki. You can inform AWB of existence of such category by using directive <tt> </tt>. The second one is a full URL that may lead to anywhere - even not to wiki, for example, <tt> </tt> would point AWB to the Russian Wikipedia typo list. Note that the destination URL should contain raw wikitext, e.g. <tt> </tt> will not work.

Boilerplate
You may start writing your checkpage using the following boilerplate: