Home
Introduction and rules
User manual
How to use AWB
Discussion
Discuss AWB, report errors, and request features
User tasks
Request or help with AWB-able tasks
Technical
Technical documentation

WP:AWB/CPF

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 Wikipedia: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!".

    "messages": [
        {
            "version": "6.1.0.2",
            "text": "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 {{bots}} and {{nobots}}, 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,_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 Wikipedia: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.wiki.x.io/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.

{
    "enabledusers": [
    ],
    "enabledbots": [
    ]
}

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.

{
    "typolink": "",
    "allusersenabled": false,
    "allusersenabledusermode": false,
    "messages": [],
    "underscoretitles": [],
    "nogenfixes": [],
    "noregextypofix": []
}

Old format (HTML/wikitext)

The old format using HTML comments and wikitext is to be considered deprecated.

General format

==Approved users==
<!--enabledusersbegins-->

===Bots===
<!--enabledbots-->
* Willy on Wheels!
* Foobot tha Great
<!--enabledbotsends-->

===Normal users===
* Lorem
* Ipsum
<!--enabledusersends-->

<!--Message:Some message all users will see after login-->

<!--No general fixes:
List pages here that have specific formatting issues not compatible with AWB's general fixes.
[[Mathematica]] - formulae are screwed up!
[[Wikipedia:Lists of common misspellings]]
[[Associative array]] - becomes dissassociative
[[List of musical works in unusual time signatures]]
-->

<!--Typos:Wikipedia:AutoWikiBrowser/Typos-->

Details

All directives AWB understand are either hidden in  or are stored  two of . If you'd like to keep the directives visible, you may wrap them in <pre> tags.

Message

By adding  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 {{bots}} and {{nobots}}, 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  checkpage directive. Every [[Simple wikilink]] between the colon character and the final end of comment(-->) 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,_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 <!--Underscores:Category name- ->, 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 Wikipedia: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 - . The second one is a full URL that may lead to anywhere - even not to wiki, for example,  would point AWB to the Russian Wikipedia typo list. Note that the destination URL should contain raw wikitext, e.g.  will not work.

Boilerplate

You may start writing your checkpage using the following boilerplate:

==Approved users==
<!--enabledusersbegins-->

===Bots===
<!--enabledbots-->
<!--enabledbotsends-->

===Normal users===
<!--enabledusersends-->

<!--Message:-->

<!--No general fixes:
-->

<!--Typos:-->