Wikipedia:AutoWikiBrowser/CheckPage format

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search

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.

General format[edit]

==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[edit]

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

Message[edit]

By adding <!--Message:Hello, world!--> 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[edit]

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 <!--No general fixes:--> 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.


Typo lists[edit]

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 - <!--Typos:MyWiki:TyposToIncinerate-->. The second one is a full URL that may lead to anywhere - even not to wiki, for example, <!--Typos:http://ru.wikipedia.org/w/index.php?title=Википедия:AutoWikiBrowser/Typos&action=raw--> would point AWB to Russian typos. Note that the destination URL should contain raw wikitext, e.g. <!--http://en.wikipedia.org/wiki/Wikipedia:AutoWikiBrowser/Typos--> will not work.

Boilerplate[edit]

You may start writing your checkpage using the following boilerplate:

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

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

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