Wikipedia talk:AutoWikiBrowser/Dev: Difference between revisions
| Line 82: | Line 82: | ||
:Awesome, I just re-started my work on my own plugin (the one which will do thousands of minor edits by doing a lookup into the national register) and this version plus the CFD plugin SVN allowed me to hammer together my now functioning plugin. Great stuff from you guys! --[[User:Stalfur|Stalfur]] 01:27, 23 July 2007 (UTC) |
:Awesome, I just re-started my work on my own plugin (the one which will do thousands of minor edits by doing a lookup into the national register) and this version plus the CFD plugin SVN allowed me to hammer together my now functioning plugin. Great stuff from you guys! --[[User:Stalfur|Stalfur]] 01:27, 23 July 2007 (UTC) |
||
::Excellent. Keep us updated on that please, sounds interesting. --[[User:Kingboyk|kingboyk]] 21:41, 24 July 2007 (UTC) |
::Excellent. Keep us updated on that please, sounds interesting. --[[User:Kingboyk|kingboyk]] 21:41, 24 July 2007 (UTC) |
||
:::The list of changes made my AWB (run on a bot account due to popular demand of other users) is [http://is.wikipedia.org/w/index.php?title=Kerfiss%C3%AD%C3%B0a:Contributions&offset=20070723200000&target=St%C3%A1l%C3%BEjarkur here], there around 3300+ entries marked as ''laga þjóðskrá'' (fixing register) are the result of doing a lookup into a mysql database for that particular name and adjusting the number of currently living people who have that name as their first or latter (second/third...) given name. It's a simple regex exercise really and a simple mysql-query but AWB gave me the platform to build it on. I am thinking of extending it to regenerate the timeline code also present in most pages (where more than 0 have the name), I will probably run this on a yearly basis from now on. --[[User:Stalfur|Stalfur]] 09:43, 25 July 2007 (UTC) |
|||
Revision as of 09:43, 25 July 2007
- 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
 Archive 1 Archive 2 |
|---|
 | Warning: You take full responsibility for any action you perform using AutoWikiBrowser. You must read and understand Wikipedia policies and use this tool within these policies, otherwise you risk losing access to the tool or even being blocked from editing. |
- 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
AutoWikiBrowser is not an automatic bot—edits made using this software are the responsibility of the editor using it. Although AWB does have an automatic mode enabled for some bot accounts, it normally just assists a human.
 | |
 | |
| Original author(s) | Bluemoose (retired) |
|---|---|
| Developer(s) | |
| Stable release | 6.3.1.1 (August 9, 2024) [±] |
| Preview release | SVN (SVN) [±] |
| Written in | C# |
| Operating system | Windows Vista and later |
| Platform | .NET Framework |
| Available in | English |
| Type | Wikipedia tool |
| License | GPL v2 |
| Website | sourceforge |
AutoWikiBrowser (AWB) is a semi-automated MediaWiki editor designed to make tedious or repetitive editing tasks quicker and easier. It is a .NET desktop application which includes a browser that follows a user-generated list of pages to modify, presenting changes to implement within each of those pages, then progressing to the next page in the list once the changes are confirmed or skipped by the user. When set to do so, it suggests some changes (typically formatting) that are generally meant to be incidental to the main change.
AWB is written for Windows operating system versions Vista and newer. It also functions reasonably well under Wine on Mac and some versions of Linux but is not officially supported.
At present, AWB can create a list of pages from single or multiple categories, "what links here", the wiki links on a page, a text file, a Google search, a user's watchlist, or a user's contributions. AWB also comes with an integrated program to search Wikipedia database dumps. The edit box of AWB supports the Microsoft Text Services Framework for use with speech recognition/handwriting applications.
The sources are available under the GPLv2 (see Documentation page). It is written in C# using Microsoft Visual C# Express Edition/Visual Studio, which is freely available at Microsoft downloads.
There is an AWB IRC channel at #AutoWikiBrowser connect.
| Usergroup | No. approved |
|---|---|
| Admins | All (854) |
| Bots | 80 |
| Users | 1,682 |
Rules of use
- You are responsible for every edit made. You are expected to review every edit, just as if you were making an edit using Wikipedia's edit form when editing by hand. Do not sacrifice quality for speed, and review all changes before saving.
- Abide by all Wikipedia guidelines, policies and common practices.
- Do not make controversial edits with it. Seek consensus for changes that could be controversial at the appropriate venue; village pump, WikiProject, etc. "Being bold" is not a justification for mass editing lacking demonstrable consensus. If challenged, the onus is on the AWB operator to demonstrate or achieve consensus for changes they wish to make on a large scale.
- Do not make insignificant or inconsequential edits. An edit that has no noticeable effect on the rendered page is generally considered an insignificant edit. If in doubt, or if other editors object to edits on the basis of this rule, seek consensus at an appropriate venue before making further similar edits.
- Repeated abuse of these rules could result, without warning, in your software being disabled. If you wish to run a bot, see Wikipedia:Bots; bots must be approved by the bot approvals group.
Using this software
(1) Register
Request permission at Wikipedia:Requests for permissions/AutoWikiBrowser if you would like to use the software. Once your username is added to the list on the check page, you can then use AutoWikiBrowser on the English Wikipedia.
Anyone can be registered, but only if an admin approves your registration. As a general rule, only users with more than Wikipedia talk:AutoWikiBrowser/Dev/Non-automated mainspace count non-automated mainspace edits or Wikipedia talk:AutoWikiBrowser/Dev/Mainspace count total mainspace edits will be registered. You will probably not be contacted when your registration has been approved, so look at the check page periodically for your name or watchlist the page. Admin accounts are automatically approved for using the software, even without being registered. Admins with pseudo-bot or flooder (not available on the English Wikipedia) will still need to add themselves into the bots section of the CheckPage to be able to use the Bots tab.
If you are planning to use only the "Make list" or "List comparer" options, then there is no need to register. These parts of the software do not prompt for a username or check the account permissions.
(2) Download
Download the release version here. Please ensure that you click on the correct download button on the SourceForge page, as there may be more than one. The correct button is green and inside the box containing the description, just above the screenshots.
If you want to run the latest SVN version, see Wikipedia:AutoWikiBrowser/Sources.
Running on Windows
AutoWikiBrowser requires Windows Vista or newer to edit on Wikimedia wikis. AutoWikiBrowser does not work on Windows XP as it does not meet Wikimedia's security standards. On other wikis, AutoWikiBrowser may work with Windows XP, although the tool is likely no longer maintained.
AWB comes in a zip file, and it is recommended that it be unzipped to a new directory, rather than running, for example, straight from the desktop. AWB is not installed on the PC and runs mostly as a standalone application: AutoWikiBrowser.exe (the provided WikiFunctions.dll file is also required). AWB can be unzipped to any directory; however, on some machines there can be permissions problems that stop AWB working correctly if the directory used is on a network drive. If you're unsure, unzip AWB to somewhere on the machine's C: drive, for example, within 'Downloads'.
Running on Linux or Mac
On Linux, AWB mostly works with Wine with .NET 4.5 installed and is suitable for use for regular editing. The installation process is the same as Wikipedia:Huggle/Wine.
AWB can also be started on Mono, albeit with some strange errors, and the web browser component does not yet work under Mono. AWB under Mono is not yet suitable for use for regular editing.
On macOS, AWB is not natively available, but one option is to use virtualization with software such as Parallels Desktop, VMware Fusion, or VirtualBox and then run Microsoft Windows virtually with AWB as per the Windows instructions above. A paid license is required for both Parallels Desktop and Microsoft Windows, though VirtualBox is free and open-source software and VMware Fusion provides a freeware version. Another option is to use Boot Camp to install Windows on an Intel-based Mac, as it is not supported on Macs with Apple Silicon (to check if your computer is Apple Silicon based, please see this Apple Support article). AWB can also be used under Wine on a Mac. A package manager such as Homebrew can be used to install Wine; see Wine on a Mac using homebrew. However, AWB has not been compiled for ARM (Wine has been) so AWB won't run natively on Apple Silicon.
Alternatively, JavaScript Wiki Browser may be used on any major operating system in web browsers.
(3) Get started
- Select "Make from Category", then enter a category name.
- Click "Make list", then let the list load up.
- Set any options, such as find and replace, edit summary, etc.
- Click "Start", it will load up the page, automatically make any changes, and then go to the diff.
- Change anything in the page you want in the Edit box on the lower right, not the normal website textbox in the browser, then click "Save" or "Skip / Ignore", the next page will load up automatically.
Refer to the FAQ for more information, including problems with other software and Wikipedia skins.
Features
AutoWikiBrowser's main feature is to easily make the same type of edit to a large number of pages. For example, fixing a typo, adding a navbox, or adding a category to dozens or hundreds of pages.
- Create a list of pages, files, categories to run edits on. Criteria for list building include:
- CheckWiki errors
- items in category
- Google search results
- links or categories on target page
- links or a simple list of titles in a text file
- watchlist contents
- special page results
- pages that link, transclude or redirect to target
- Wikipedia search results
- Search and replace wikitext – plain text or regular expressions
- Add material to the beginning or end of each page
- Add, remove, or replace categories and files
- Rules-based page skipping
- Custom user scripts
AutoWikiBrowser also has some other features.
- Make list articles
- Offline database scanner
- Automatic fixes of common issues
Database scanner
AWB includes a database scanner that scans versions of Wikipedia downloaded to your local computer. It can be used to search wikitext, without causing extra unnecessary load on Wikimedia servers. This is useful for building lists of titles to perform AutoWikiBrowser tasks on, and for performing searches that would time out on-wiki searches. The scanner supports regular expression searches and users can run multiple instances at once.
Database dumps are created from time to time (more info here) and are available for free download. As the page states, the best/most useful dump is the enwiki-latest-pages-articles.xml.bz2 (dir). Visiting the database dump progress site allows you to view the status of the current dump and easily browse to the downloads in it.
After downloading, the archive needs to be uncompressed; this will turn it from a ~22 GB bz2 archive into an XML database dump around 100 GB.
A scannable .xml file of selected files can also be generated by visiting Special:Export.
Scripting
Custom modules
AWB allows you to write your own C# or VB.NET code and execute it inside the program, via Custom Modules. This can be accessed via Tools -> Make module.
Plugins
AWB can also load and use fully customized plugins. These plugins can process page text and extend the user interface, and are in the form of libraries (.dll files) which can be made in any .NET language such as C# or Visual Basic .NET. When AWB loads, it automatically checks to see if there are any plugins in the folder from which it was executed. Any plugins found are loaded and initialized without further intervention by the user.
AWB ships with WikiFunctions.dll, which can be referenced by other standalone projects. The DLL includes a wiki-ready web browser control, a simple page editor, a listmaker, and other tools and components.
See also
- JavaScript Wiki Browser – A user script with similar functionality to the downloadable AutoWikiBrowser, but loaded within the web browser
- JavaScript Wiki Browser in toolbar – Installs the above script, then puts the link to the script in the toolbar for easy access
- AutoEd – A user script that helps to automatically make certain changes in articles
- autoFormatter – A user script that semi-automatically fixes more than 200 common errors in wiki markup
- WPCleaner – A tool designed to help with various maintenance tasks, especially repairing links to disambiguation pages, checking Wikipedia, fixing spelling and typography
- Wikiget – A Unix command-line tool to generate a list of articles from categories, templates, backlinks, etc.
- WP:HIDEAWB – Instructions on how to hide AWB edits from your watchlist.
- {{AWB topicon}} – a top icon template to indicate you have the AutoWikiBrowser user right – adds a category to page automatically
- Category:AutoWikiBrowser user templates – Userboxes to show AutoWikiBrowser userright (e.g.
{{Wikipedia:AutoWikiBrowser/Userbox 2}}generates the userbox below - Wikipedia:Using AWB with 2FA
This user has AutoWikiBrowser rights on the English Wikipedia. (verify)
External links
- Project home on SourceForge
- Browsing the source code on SourceForge
- Regular Expression Language Elements from the .NET Framework Developer's Guide in the online documentation of Microsoft
This page is for AWB developers to discuss the development of AWB.
Please do not post bugs, feature requests, and similar on here, unless it is extremely urgent, but in that case it would probably be better to use #autowikibrowser on IRC if possible.
Useful Links:
SVN
When I was working on patching together log uploading and AWB Profiles, Tortoise SVN got itself into a right state. I was unable to add some new/renamed files to the repository at all (and I spent about an hour trying); in the end I had to ask Sam to commit the files for me. A .designer file somehow got totally lost. I also then had network problems so couldn't explain what had happened on irc!
It's been #2 on my job priority list today to fix, but alas job #1 has taken a lot longer than expected and caused me to lose yet more hair :( Yesterday I built a HTPC as a wedding present; today it was supposed to be the relatively easy matter of finishing off configuration and copying files over. Unfortunately the machine decided it didn't want to talk to my monitor having previously been plugged into the TV; I've also been fighting dodgy TV card drivers and what have you! These things are never simple, are they? I hate computers!
Anyrode, I'll have a bash at recreating the missing file now, and get the code back to a compilable state. Finishing off the actual task will probably have to wait until tommorow and consultation with Sam (who has been unable to test/bug fix a possible problem in his part of the code). Apologies to anyone who has been inconvenienced by this - it's been weighing on my mind all day! --kingboyk 20:08, 7 July 2007 (UTC)
- Right, recreated and tested, seem to be back pretty much where I was before svn issues :) That is to say, log writing works, I've patched Profiles into log uploading but have uncovered a bug in editing of profiles; am doing a test run now to see if the log gets uploaded or not. --kingboyk 22:15, 7 July 2007 (UTC)
- Update/summary:
- Logging to file is now working
- Log upload isn't working yet, but I will fix it worry ye not (it's working code ported from VB plus AWB Profiles == fixable)
- AWB skips when plugin tells it to in bot mode, but doesn't in manual mode. I suspect this got broken when the new HTML message was added (see #Need to release 4.0 soon). If nobody beats me to it I'll take a look at this when I've got my other jobs done.
- Articles skipped by plugin get added by AWB to "saved" log tab, not "skipped". I suspect this issue is directly related to the one above; I definitely left this in a working state before my technical issues forced me to take a sabattical
Editing a profile corrupts the profile: Sam knows about this now and I don't imagine it will be hard to fix- Missing Encrypt on username during edit. Fixed - rev 1429 Reedy Boy 12:54, 8 July 2007 (UTC) rev 1428 was connected also. --kingboyk 14:06, 8 July 2007 (UTC)Adding a new profile forces the "Use for upload" flag of existing profile to be set to No. Should be a minor bug so I'll look at that now; if I can't fix it I'll ask Sam as it's his code and I'm sure it's a trivial error.- Fixed - rev 1430 Reedy Boy 12:57, 8 July 2007 (UTC)
- Anything else or are these the sole remaining issues we know of? --kingboyk 22:48, 7 July 2007 (UTC)
- Update/summary:
- I checked out rev 1384. Log tab (not logging to file) is broken there too. I noticed that even my tooltiptext code seems not to be working (each log entry in the saved and ignore lists should have a tooltip explaining what processes happened to the article). Presumably somebody has made some major changes and not tested them == kingboyk not amused to see his work mistreated like that! I'm sure this was all working when I last touched it; it was only logging to file which was screwed. **Working in 3.9.2.0. AWB skips when plugin tells it to, adds logs to the correct tab and with a skip reason, and the tool tips are there.
- It's very late now but I'll try an even older revision tommorow. Really thoigh it would be better if it were fixed by whoever broke it because I don't have the time or the inclination to go through every revision... --kingboyk 01:59, 8 July 2007 (UTC)
- Filed as a bug. Old binaries with notes and XML committed as rev 1441. --kingboyk 22:41, 8 July 2007 (UTC)
I've fixed (so far as I can tell) the log tab and skipping. AWBProfiles appear to be working for log uploading. Logs don't actually upload because, as far as I can tell, of a problem in WPEditor. My guess is that Mediawiki has changed the way it sends or receives tokens (see [1]).
Seems to be in working order for simple usage with plugin. Will need much more testing but at least this is a move forward and within the next couple of days we should be able to get some more product out to our alpha testers; with any luck a public beta release can follow by the end of the weekend... --kingboyk 00:20, 18 July 2007 (UTC)
SVN Changes
If anyones having any problems reading from/writing to the AWB SVN, it could be because SF have made some changes
You can no longer connect with https://svn.sourceforge.net/svnroot/autowikibrowser, you must use https://autowikibrowser.svn.sourceforge.net/svnroot/autowikibrowser
I had to checkout a clean copy as i couldnt work out how to change the working link in TortoiseSVN
Then just put my files in and re-commited
Reedy Boy 08:41, 10 July 2007 (UTC)
Version 4 for testing
I've fixed all the bugs I know about and upped the version to 4.0.0.0 as of rev 1470. I'd like to invite active fellow devs and alpha testers to seriously test this version to try and find bugs. I'm expecting some bugs to show up, but assuming there's nothing too serious we should aim to release v4 as a beta this weekend.
Features should now be frozen. Any feature requests will have to wait until the next version. --kingboyk 18:41, 18 July 2007 (UTC)
- Well, unless someone comes up with something really good, but as it stands, theres nothing that really needs to go in for v4 now. Reedy Boy 18:14, 19 July 2007 (UTC)
- Tweaks here and there, yes, but any major new features just puts the release date back further and further :) --kingboyk 21:32, 19 July 2007 (UTC)
Help browser
The help browser is nice and all, and I've just extended it somewhat (moved base class to wf.dll and made it reusable, exposed it to plugins, various other tweaks), but is it actually any better than opening help pages in the user's default browser? Are we gonna get context sensitive help, bug report submissions, etc. etc? If not, it's arguably bloatware, and it's never gonna have the features of a standalone browser either... Thoughts? --kingboyk 17:00, 19 July 2007 (UTC)
Skipping
I tested three different types of skip, and in each case AWB skipped correctly, and added the article to the Skipped log with a correct caption. The types were: skipped by AWB ("skip on no change"), skipped by a plugin, and skipped by user hitting ignore.
--kingboyk 21:42, 19 July 2007 (UTC)
AWB v4 Alpha
Released - [2]
Reedy Boy 15:54, 20 July 2007 (UTC)
- Awesome, I just re-started my work on my own plugin (the one which will do thousands of minor edits by doing a lookup into the national register) and this version plus the CFD plugin SVN allowed me to hammer together my now functioning plugin. Great stuff from you guys! --Stalfur 01:27, 23 July 2007 (UTC)
- Excellent. Keep us updated on that please, sounds interesting. --kingboyk 21:41, 24 July 2007 (UTC)
- The list of changes made my AWB (run on a bot account due to popular demand of other users) is here, there around 3300+ entries marked as laga þjóðskrá (fixing register) are the result of doing a lookup into a mysql database for that particular name and adjusting the number of currently living people who have that name as their first or latter (second/third...) given name. It's a simple regex exercise really and a simple mysql-query but AWB gave me the platform to build it on. I am thinking of extending it to regenerate the timeline code also present in most pages (where more than 0 have the name), I will probably run this on a yearly basis from now on. --Stalfur 09:43, 25 July 2007 (UTC)
- Excellent. Keep us updated on that please, sounds interesting. --kingboyk 21:41, 24 July 2007 (UTC)