Wikipedia:AutoWikiBrowser/CheckPage format
From Wikipedia, the free encyclopedia
If you'd like to constrain the usage of AutoWikiBrowser on your wiki, you may introduce a checkpage, just like the Engilsh Wikipedia does. Here is the manual on writing checkpages.
Contents |
[edit] General format
<!--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]] --> <!--Underscores:pages with an underscore in their title--> <!--Typos:Wikipedia:AutoWikiBrowser/Typos--> ==Approved users== <!--enabledusersbegins--> ===Bots=== <!--enabledbots--> * Willy on Wheels! * Foobot tha Great <!--enabledbotsends--> ===Admins=== <!--adminsbegins--> * Wik * Johnny the Vandal <!--adminsends--> ===Normal users=== * Lorem * Ipsum <!--enabledusersends-->
[edit] Details
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.
[edit] Message
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.
[edit] 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 ypur 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.
[edit] 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 existance of such category by using directive <!--Underscores:Category name-->, where category name is without the category namespace prefix.
[edit] 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 - <!--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.
[edit] Boilerplate
You may start writing your checkpage using the following boilerplate:
<!--Message:--> <!--No general fixes: --> <!--Underscores:--> <!--Typos:--> ==Approved users== <!--enabledusersbegins--> ===Bots=== <!--enabledbots--> <!--enabledbotsends--> ===Admins=== <!--adminsbegins--> <!--adminsends--> ===Normal users=== <!--enabledusersends-->
