C# Class AutoWikiBrowser.Plugins.Kingbotk.PluginBase

SDK Software's base class for template-manipulating AWB plugins

Show file Open project: reedy/AutoWikiBrowser Class Usage Examples

Protected Properties

Property	Type	Description
LastKnownGoodRedirects	string
MainRegex	System.Text.RegularExpressions.Regex
OurMenuItem	System.Windows.Forms.ToolStripMenuItem
PreferredTemplateNameRegex	System.Text.RegularExpressions.Regex
PreferredTemplateNameRegexCreator	System.Text.RegularExpressions.Regex
SecondChanceRegex	System.Text.RegularExpressions.Regex
Template	Templating
TheArticle	Article

Private Properties

Property	Type	Description
PluginBase	System
PluginBase	System
ReadXMLRedirects	void
ReqPhoto	void
TemplateWritingAndPlacement	void
WriteXMLRedirects	void
ourmenuitem_CheckedChanged	void

Protected Methods

Method	Description
AddAndLogNewParamWithAYesValue ( string paramName ) : void
AddEmptyParam ( string paramName ) : void
AddNewParamWithAYesValue ( string paramName ) : void
BotModeChanged ( bool botMode ) : void
ConvertRedirectsToString ( List redirects ) : string
GetRedirects ( string target ) : List	Load the redirects for a template from Wikipedia
GotNewAlternateNamesString ( string alternateNames, bool senderIsGenericTemplateForm = false ) : void	Called when we have a new Redirects list (at startup, from Wikipedia, or from the user in the case of generic templates)
GotTemplateNotPreferredName ( string templateName ) : void
ImportanceParameter ( Importance importance ) : void
Initialise ( ) : void
InitialiseBase ( ) : void
MatchEvaluator ( Match match ) : string
PluginCheckTemplateName ( string templateName ) : void
PreferredTemplateNameWikiMatchEvaluator ( Match match ) : string
ProcessArticleFinish ( ) : void
ProcessArticleFinishNonStandardMode ( Classification classification, Importance importance, bool forceNeedsInfobox, bool forceNeedsAttention, bool removeAutoStub ) : void
ProcessTalkPage ( Article article, Classification classification, Importance importance, bool forceNeedsInfobox, bool forceNeedsAttention, bool removeAutoStub, ProcessTalkPageMode processTalkPageMode, bool addReqPhotoParm ) : bool
ProcessTalkPage ( Article article, bool addReqPhotoParm ) : bool
ReadXML ( XmlTextReader reader ) : void
Reset ( ) : void
ShowHideOurObjects ( bool visible ) : void
SkipIfContains ( ) : bool
StubClass ( ) : void
TemplateFound ( ) : bool	Send the template to the plugin for preinspection
TemplateNotFound ( ) : void
WriteOutParameterToHeader ( string paramName ) : string
WriteTemplateHeader ( ) : string
WriteXML ( XmlTextWriter writer ) : void

Private Methods

Method	Description
PluginBase ( bool iamAGenericTemplate ) : System
PluginBase ( string defaultRegexpmiddle ) : System
ReadXMLRedirects ( XmlTextReader reader ) : void
ReqPhoto ( ) : void
TemplateWritingAndPlacement ( ) : void
WriteXMLRedirects ( XmlTextWriter writer ) : void
ourmenuitem_CheckedChanged ( object sender, EventArgs e ) : void

Method Details

AddAndLogNewParamWithAYesValue() protected method

protected AddAndLogNewParamWithAYesValue ( string paramName ) : void
paramName	string
return	void

AddEmptyParam() protected method

protected AddEmptyParam ( string paramName ) : void
paramName	string
return	void

AddNewParamWithAYesValue() protected method

protected AddNewParamWithAYesValue ( string paramName ) : void
paramName	string
return	void

BotModeChanged() protected method

protected BotModeChanged ( bool botMode ) : void
botMode	bool
return	void

ConvertRedirectsToString() protected static method

protected static ConvertRedirectsToString ( List redirects ) : string
redirects	List
return	string

GetRedirects() protected static method

Load the redirects for a template from Wikipedia

protected static GetRedirects ( string target ) : List
target	string	Template name
return	List

GotNewAlternateNamesString() protected method

Called when we have a new Redirects list (at startup, from Wikipedia, or from the user in the case of generic templates)

protected GotNewAlternateNamesString ( string alternateNames, bool senderIsGenericTemplateForm = false ) : void
alternateNames	string
senderIsGenericTemplateForm	bool
return	void

GotTemplateNotPreferredName() protected method

protected GotTemplateNotPreferredName ( string templateName ) : void
templateName	string
return	void

ImportanceParameter() protected method

protected ImportanceParameter ( Importance importance ) : void
importance	Importance
return	void

Initialise() protected abstract method

protected abstract Initialise ( ) : void
return	void

InitialiseBase() protected method

protected InitialiseBase ( ) : void
return	void

MatchEvaluator() protected method

protected MatchEvaluator ( Match match ) : string
match	Match
return	string

PluginCheckTemplateName() protected method

protected PluginCheckTemplateName ( string templateName ) : void
templateName	string
return	void

PreferredTemplateNameWikiMatchEvaluator() protected method

protected PreferredTemplateNameWikiMatchEvaluator ( Match match ) : string
match	Match
return	string

ProcessArticleFinish() protected abstract method

protected abstract ProcessArticleFinish ( ) : void
return	void

ProcessArticleFinishNonStandardMode() protected method

protected ProcessArticleFinishNonStandardMode ( Classification classification, Importance importance, bool forceNeedsInfobox, bool forceNeedsAttention, bool removeAutoStub ) : void
classification	Classification
importance	Importance
forceNeedsInfobox	bool
forceNeedsAttention	bool
removeAutoStub	bool
return	void

ProcessTalkPage() protected method

protected ProcessTalkPage ( Article article, Classification classification, Importance importance, bool forceNeedsInfobox, bool forceNeedsAttention, bool removeAutoStub, ProcessTalkPageMode processTalkPageMode, bool addReqPhotoParm ) : bool
article	Article
classification	Classification
importance	Importance
forceNeedsInfobox	bool
forceNeedsAttention	bool
removeAutoStub	bool
processTalkPageMode	ProcessTalkPageMode
addReqPhotoParm	bool
return	bool

ProcessTalkPage() protected method

protected ProcessTalkPage ( Article article, bool addReqPhotoParm ) : bool
article	Article
addReqPhotoParm	bool
return	bool

ReadXML() protected abstract method

protected abstract ReadXML ( XmlTextReader reader ) : void
reader	System.Xml.XmlTextReader
return	void

Reset() protected abstract method

protected abstract Reset ( ) : void
return	void

ShowHideOurObjects() protected abstract method

protected abstract ShowHideOurObjects ( bool visible ) : void
visible	bool
return	void

SkipIfContains() protected abstract method

protected abstract SkipIfContains ( ) : bool
return	bool

StubClass() protected method

protected StubClass ( ) : void
return	void

TemplateFound() protected abstract method

Send the template to the plugin for preinspection

protected abstract TemplateFound ( ) : bool
return	bool

TemplateNotFound() protected method

protected TemplateNotFound ( ) : void
return	void

WriteOutParameterToHeader() protected method

protected WriteOutParameterToHeader ( string paramName ) : string
paramName	string
return	string

WriteTemplateHeader() protected abstract method

protected abstract WriteTemplateHeader ( ) : string
return	string

WriteXML() protected abstract method

protected abstract WriteXML ( XmlTextWriter writer ) : void
writer	System.Xml.XmlTextWriter
return	void

Property Details

LastKnownGoodRedirects protected property

protected string LastKnownGoodRedirects
return	string

MainRegex protected property

protected Regex,System.Text.RegularExpressions MainRegex
return	System.Text.RegularExpressions.Regex

OurMenuItem protected property

protected ToolStripMenuItem,System.Windows.Forms OurMenuItem
return	System.Windows.Forms.ToolStripMenuItem

PreferredTemplateNameRegex protected property

protected Regex,System.Text.RegularExpressions PreferredTemplateNameRegex
return	System.Text.RegularExpressions.Regex

PreferredTemplateNameRegexCreator protected static property

protected static Regex,System.Text.RegularExpressions PreferredTemplateNameRegexCreator
return	System.Text.RegularExpressions.Regex

SecondChanceRegex protected property

protected Regex,System.Text.RegularExpressions SecondChanceRegex
return	System.Text.RegularExpressions.Regex

Template protected property

protected Templating,AutoWikiBrowser.Plugins.Kingbotk Template
return	Templating

TheArticle protected property

protected Article,AutoWikiBrowser.Plugins.Kingbotk TheArticle
return	Article