Wikipedia:WikiFunctions

From Wikipedia, the free encyclopedia

AutoWikiBrowser - 4.3.2.0

v  d  e
Home

General information about AutoWikiBrowser and directions for installation.

Request approval

Request approval to be added to the CheckPage to use AutoWikiBrowser.

Discussion

Discuss the application and ask questions.

Bugs

Report bugs in the application.

Feature Requests

Request new features to be implemented into AWB

User manual

The full user manual.

Developer Talk Page · Typos · IW Order · User talk templates · Plugins · IRCMonitor · Projects which have used AWB · Changelog · AWB Sandbox · Settings · Custom Modules · WikiFunctions.dll · Custom style.css · Userbox · SVN Snapshots · Usage Stats

WikiFunctions.dll is a Microsoft dotnet framework dynamically linked library containing various classes and user interface elements related to wiki editing. Besides being a repository for code shared between various AWB executables, WikiFunctions also contains much in the way of standalone code reusable by other projects and AWB plugins.

Since AWB version 4.0, WikiFunctions incorporates the features formerly shipped in Kingboyk's WikiFunctions2. Most notable amongst these features is a logging suite usable by 3rd party applications (and now used in AWB).

[edit] Objects

WikiFunctions contains various objects and modules used by AutoWikiBrowser, other AWB products, and AWB plugins. It also contains various items which may be of use to 3rd party developers, some of which are:

WikiFunctions.Browser.WebControl Provides a WebBrowser component adapted and extended for use with Wikis.
WikiFunctions.Controls.Help Provides a web-based help browser. Must be inherited.
WikiFunctions.Controls.LED A simple "LED" control. Can be seen on the AWB logging-to-file tab.
WikiFunctions.Controls.TransparentLabel A label that can be transparent.
WikiFunctions.Controls.Lists namespace Various controls for manipulating lists.
WikiFunctions.DatabaseScanner.DatabaseScanner Provides a form and functions for searching XML data dumps.
WikiFunctions.DotNetWikiBot More info needed as I'm not sure what this is for. For use with DotNetWikiBot
WikiFunctions.Editor A simple wiki-editing class. The class must be instantiated and persists login data. May be used in conjunction with AWB Profiles.
WikiFunctions.ErrorHandler This class provides one static function, Handle(Exception ex), useful for displaying detailed information about exceptions your exception caught.
WikiFunctions.Encryption.RijndaelSimple Contains an easy to use wrapper around Rijndael encryption. The class uses a symmetric key algorithm (Rijndael/AES) to encrypt and decrypt data. As long as encryption and decryption routines use the same parameters to generate the keys, the keys are guaranteed to be the same.
WikiFunctions.IRC.WikiIRC Contains functions to monitor IRC channels.
WikiFunctions.Lists.GetLists Provides functionality to create and manipulate Lists of pages from many different sources.
WikiFunctions.Logging.IMyTraceListener An interface implemented by all trace (logging) classes including the trace manager
WikiFunctions.Logging.TraceListenerBase This abstract class can be used to build trace listener classes
WikiFunctions.Logging.TraceListenerUploadableBase An abstract class for building auto-uploading trace listeners
WikiFunctions.Logging.TraceManager An inheritable implementation of a Logging manager, built around a generic collection of IMyTraceListener objects and String keys
WikiFunctions.Logging.WikiTraceListener This class logs in Mediawiki-markup format
WikiFunctions.Logging.XHTMLTraceListener This class logs in XHTML format
WikiFunctions.Logging.Uploader.ITraceStatusProvider Implemented by classes which expose a TraceStatus object
WikiFunctions.Logging.Uploader.LogEntry Object which contains details of target pages for log entries (see e.g. User:Kingbotk/Logs, Wikipedia:WikiProject Biography/Automation/Logs)
WikiFunctions.Logging.Uploader.LogUploader A class which uploads logs to Wikipedia. Inherits from WikiFunctions.Editor in AWB's DLL
WikiFunctions.Logging.Uploader.TraceStatus A class which keeps track of statistics and not-yet-uploaded log entries.
WikiFunctions.Logging.Uploader.UploadableLogSettings A simple settings class for logging solutions
WikiFunctions.Logging.Uploader.UploadableLogSettings2 An extended base class with extra properties for a comprehensive logging solution
WikiFunctions.Logging.Uploader.UploadingPleaseWaitForm A form for displaying when the application is busy uploading
WikiFunctions.Logging.UploaderUsernamePassword Stores the user's login details/cookies
WikiFunctions.TalkPages.TalkPageHeaders.ProcessTalkPage Parses a talk page for a {{talkheader}} and/or {{skiptotoc}} template and moves them to the top.
WikiFunctions.Tools Provides various tools as static methods, such as getting the html of a page.