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 2005-12-14 00:10:50 +00:00
parent e18ab9f8ad
commit a2320c4950
1 changed files with 40 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
Ruby-MediaWiki%2FDocumentation.mw
View File

@ -16,10 +16,12 @@ The Article class represents MediaWiki articles.
===MediaWiki::Article#delete===
Delete this article
* '''reason:''' [String] Delete reason===MediaWiki::Article#protect===
* '''reason:''' [String] Delete reason
===MediaWiki::Article#protect===
Protect this article
* '''reason:''' [String] Protect reason===MediaWiki::Article#reload===
* '''reason:''' [String] Protect reason
===MediaWiki::Article#reload===
Reload Article#text, should be done by Article#initialize.
===MediaWiki::Article#submit===
@ -27,34 +29,47 @@ Push the '''Submit''' button
Send the modified Article#text to the MediaWiki.
* '''summary:''' [String] Change summary* '''minor_edit:''' [Boolean] This is a Minor Edit* '''watch_this:''' [Boolean] Watch this article===MediaWiki::Article#unprotect===
* '''summary:''' [String] Change summary
* '''minor_edit:''' [Boolean] This is a Minor Edit
* '''watch_this:''' [Boolean] Watch this article
===MediaWiki::Article#unprotect===
Unprotect this article
* '''reason:''' [String] Unprotect reason===MediaWiki::Article#what_links_here===
* '''reason:''' [String] Unprotect reason
===MediaWiki::Article#what_links_here===
What articles link to this article?
* '''result:''' [Array] of [String] Article names===MediaWiki::Article#xhtml===
* '''result:''' [Array] of [String] Article names
===MediaWiki::Article#xhtml===
Get the XHTML, will invoke Article#xhtml_reload if not already cached
* '''result:''' [REXML::Element] html root element===MediaWiki::Article#xhtml_reload===
* '''result:''' [REXML::Element] html root element
===MediaWiki::Article#xhtml_reload===
Reload the xhtml, will be automatically done by Article#xhtml if not already cached.
===MediaWiki::Article::new===
Create a new Article instance
* '''wiki:''' [Wiki] instance to be used to theive the MiniBrowser* '''name:''' [String] Article name* '''section:''' [Fixnum] Optional article section number* '''load_text:''' [Boolean] Invoke Article#reload to retrieve Article#text==MediaWiki::Category==
* '''wiki:''' [Wiki] instance to be used to theive the MiniBrowser
* '''name:''' [String] Article name
* '''section:''' [Fixnum] Optional article section number
* '''load_text:''' [Boolean] Invoke Article#reload to retrieve Article#text
==MediaWiki::Category==
The Category class represents MediaWiki categories.
===MediaWiki::Category#articles===
Which articles belong to this category?
* '''result:''' [Array] of [String] Article names===MediaWiki::Category#reload===
* '''result:''' [Array] of [String] Article names
===MediaWiki::Category#reload===
Reload the XML, will be invoked by Category#articles, if not already cached.
===MediaWiki::Category::new===
Create a new Category instance
* '''wiki:''' [Wiki] instance to be used to theive the MiniBrowser* '''name:''' [String] Category name, to be prefixed with "Category:" when being fetched==MediaWiki::MiniBrowser==
* '''wiki:''' [Wiki] instance to be used to theive the MiniBrowser
* '''name:''' [String] Category name, to be prefixed with "Category:" when being fetched
==MediaWiki::MiniBrowser==
===MediaWiki::MiniBrowser#add_cookie===
===MediaWiki::MiniBrowser#cookies===
===MediaWiki::MiniBrowser#get_content===
@ -70,27 +85,37 @@ takes the wiki markup of a table and returns a 2-dimensional array representing
===MediaWiki::Wiki#allpages===
Returns the pages listed on "Special:Allpages"
* '''result:''' [Array] of [String] Articlenames===MediaWiki::Wiki#article===
* '''result:''' [Array] of [String] Articlenames
===MediaWiki::Wiki#article===
Return a new Article instance with given name, will be constructed with [self] (for MiniBrowser usage)
* '''name:''' [String] Article name* '''section:''' [Fixnum] Optional section number===MediaWiki::Wiki#article_url===
* '''name:''' [String] Article name
* '''section:''' [Fixnum] Optional section number
===MediaWiki::Wiki#article_url===
Construct the URL to a specific article
Uses the [url] the Wiki instance was constructed with, appends "index.php", the name parameter and, optionally, the section.
Often called by Article, Category, ...
* '''name:''' [String] Article name* '''section:''' [Fixnum] Optional section number===MediaWiki::Wiki#category===
* '''name:''' [String] Article name
* '''section:''' [Fixnum] Optional section number
===MediaWiki::Wiki#category===
Return a new Category instance with given name, will be constructed with [self] (for MiniBrowser usage)
* '''name:''' [String] Category name (to be prepended with "Category:")===MediaWiki::Wiki#login===
* '''name:''' [String] Category name (to be prepended with "Category:")
===MediaWiki::Wiki#login===
Log in into MediaWiki
This is '''not''' HTTP authentication (put HTTP-Auth into [url] of Wiki#initialize!)
* '''user:''' [String] MediaWiki username* '''password:''' [String] MediaWiki passwordMay raise an exception if cannot authenticate
* '''user:''' [String] MediaWiki username
* '''password:''' [String] MediaWiki password
May raise an exception if cannot authenticate
===MediaWiki::Wiki::new===
Initialize a new Wiki instance.
* '''url:''' [String] URL-Path to index.php (without index.php), may containt <tt>user:password</tt> combination.* '''user:''' [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)
* '''url:''' [String] URL-Path to index.php (without index.php), may containt <tt>user:password</tt> combination.
* '''user:''' [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)