gitolite/c3d2-wiki
gitolite/c3d2-wiki
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

I can even document myself :-)

Browse Source
This commit is contained in:
AstRobot 2006-06-10 09:48:21 +00:00
parent 2018e7bc26
commit e87894a1c7
1 changed files with 33 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Ruby-MediaWiki%2FDocumentation.mw
View File

@ -2,13 +2,13 @@
==MediaWiki==
===MediaWiki::dotfile(myrealm=nil)===
===MediaWiki::dotfile(myrealm=nil,mywiki=nil)===
dotfile function reads the user's MediaWiki config and creates a Wiki instance.
The filename is determined by the environment variable MEDIAWIKI_RC or defaults to ~/.mediawikirc .
A configured wiki can be chosen with the MEDIAWIKI_WIKI environment variable, or defaults to the wiki pointed by default.
A configured wiki can be chosen with the MEDIAWIKI_WIKI environment variable, by the option mywiki or defaults to the wiki pointed by default.
A robot may set [myrealm] to retrieve a second result output: a section with this name in the current wiki's configuration file for configuration of specific robot tasks.
@ -24,6 +24,11 @@ The Article class represents MediaWiki articles.
Article name, will be refreshed upon Article#reload
===MediaWiki::Article#read_only (RW)===
this Article is read_only
===MediaWiki::Article#text (RW)===
Article text, will be set by Article#reload
@ -91,6 +96,9 @@ Send the modified Article#text to the MediaWiki.
: [Boolean] Watch this article
===MediaWiki::Article#to_rexml( html )===
===MediaWiki::Article#unprotect(reason)===
Unprotect this article
@ -158,7 +166,7 @@ The MiniBrowser is used to perform GET and POST requests over HTTP and HTTPS, su
All interaction with MiniBrowser is normally done by MediaWiki::Wiki.
===MediaWiki::MiniBrowser::new(url)===
===MediaWiki::MiniBrowser::new(url,logger)===
Initialize a MiniBrowser instance
@ -208,6 +216,17 @@ Will switch to MiniBrowser#get_content upon HTTP redirect.
: [String] Document
==MediaWiki::SpecialPage==
Inherited from '''Article'''
The SpecialPage class represents MediaWiki special pages.
===MediaWiki::SpecialPage#xhtml_reload()===
Reload the xhtml, will be automatically done by SpecialPage#xhtml if not already cached.
==MediaWiki::Table==
Inherited from '''Object'''
@ -261,7 +280,12 @@ Inherited from '''Object'''
The MiniBrowser instance used by this Wiki. This must be readable as it's used by Article and Category to fetch themselves.
===MediaWiki::Wiki::new(url, user = nil, password = nil)===
===MediaWiki::Wiki#logger (R)===
The Logger used by this Wiki.
===MediaWiki::Wiki::new(url, user = nil, password = nil, loglevel = Logger::WARN)===
Initialize a new Wiki instance.
@ -271,6 +295,8 @@ Initialize a new Wiki instance.
: [String] If not nil, log in with that MediaWiki username (see Wiki#login)
; password:
: [String] If not nil, log in with that MediaWiki password (see Wiki#login)
; loglevel:
: [Integer] Loglevel, default is to log all messages >= Logger::WARN = 2
===MediaWiki::Wiki#allpages()===
@ -313,6 +339,9 @@ Return a new Category instance with given name, will be constructed with [self]
: [String] Category name (to be prepended with "Category:")
===MediaWiki::Wiki#full_article_url(name, section=nil)===
===MediaWiki::Wiki#login( username, password )===
Log in into MediaWiki