User:Kingbotk/Plugin/User guide

From Wikipedia, the free encyclopedia

Kingbotk Plugin for AWB
Home General information about the Kingbotk Plugin and directions for installation.	Discussion Discuss the application and ask questions.	User guide How to use the plugin.	How it works What the plugin does, how it works, and why you should use it.	AutoWikiBrowser The plugin works inside AWB and is shipped with that tool.
Generic WikiProject templates · WikiFunctions2.dll · AWB Sandbox

This is the user guide for my AWB WikiProject templating plugin. Please note that "the plugin" is really a set of plugins in one DLL - one plugin per WikiProject template, and a plugin manager which interracts with AWB.

1 Downloading and installing
2 Configuration
3 Tagging
4 Wikipedia Assessments
5 Configuring and using Generic WikiProject templates

[edit] Downloading and installing

Download the plugin.
Add User:Kingbotk/Plugin to your watchlist and sign onto the mailing list so you can get updates.
If you've downloaded the complete package (AWB and plugin), extract it all to a new folder. If you've just downloaded the plugin extract it into your AWB folder.
Start AWB as normal.
You will now have several new menu items:
- Plugins menu. This contains a list of the plugins which are available - just click the plugin name to enable it. Be careful to select only one plugin at a time unless you really do want to tag talk pages on behalf of more than one WikiProject at a time (e.g. tagging military biographies with both {{WPBiography}} and {{WPMILHIST}}).
- "Kingbotk Plugin" submenu under Plugins. This contains general configuration for the plugin manager and other options which relate to all of the individual templating plugins. Some items here are not enabled or implemented yet.
- "Show settings tab" under General. Select this to hide all settings tabs. (But enable a plugin first!)
- New items under the Help menu.

[edit] Configuration

You do not have to follow these steps in this order, just do all of them before clicking Start:

Turn off all AWB features (or click Plugins\Kingbotk Plugin\Set AWB (not yet implemented))
Set the AWB edit summary (make it very short, as the plugin will append it's own edit summary)
Turn on the plugin(s) for the WikiProject template(s) you wish to add
You'll now have a number of additional tabs.
In the template plugin tabs, select the parameters you want to add or change
Click the plugin tab. If and only if you are working through a category and/or it's subcategories, enter the category name in the box provided. This will be added to the edit summary.
Click Plugins\Kingbotk Plugin\Logging and select your options. I recommend turning on verbose logging and logging problematic pages (bad tags), and logging to either wiki format (if you want to upload to wiki) or XHTML for viewing in a web browser. You can select both or neither, if you prefer.
If you're done with your settings you can now uncheck General\Show settings tabs and all tabs apart from the Plugin tab will disappear.
Save your settings so you can use them again. The plugin settings get saved too.
Build your article list (and save it to file if large)

[edit] Tagging

Hold your breath and click Start.

The little red circle on the Plugin tab goes green when the plugin is processing text - DOTNET regular expressions are very fast so blink and you'll miss it!
The plugin displays article statistics (leeched from AWB) and keeps a running count of how many articles it has tagged, how many it has skipped, how many were new pages, how long the tagging process has been running, how many pages have been successfully saved, and the number of seconds per successful save.
The plugin can recognise incorrectly formatted ("bad") templates; it does this by first searching for valid templates (and trapping any strangeness) and then running a "second chance" expression to search for any invalid instances which have been missed. These can be optionally logged and the list uploaded onto wiki so that the offending templates can be manually edited (my list is at User:Kingbotk/Logs/Bad tags).
If you want to do other work with AWB, just disable the plugins using the Plugin menu. There's no need to uninstall the .dll file.
This is new software so use it wisely and please report any issues or bugs - especially any which could result in my bot leaving behind bad tags.