Ruby-MediaWiki/Documentation: Unterschied zwischen den Versionen

Aus C3D2
Wechseln zu: Navigation, Suche
(I can even document myself :-))
(I can even document myself :-))
Zeile 3: Zeile 3:
 
==MediaWiki==
 
==MediaWiki==
  
===MediaWiki::dotfile===
+
===MediaWiki::dotfile(myrealm=nil)===
  
 
dotfile function reads the user's MediaWiki config and creates a Wiki instance.
 
dotfile function reads the user's MediaWiki config and creates a Wiki instance.
Zeile 30: Zeile 30:
  
  
===MediaWiki::Article::new===
+
===MediaWiki::Article::new(wiki, name, section = nil, load_text=true)===
  
 
Create a new Article instance
 
Create a new Article instance
Zeile 44: Zeile 44:
  
  
===MediaWiki::Article#delete===
+
===MediaWiki::Article#delete(reason)===
  
 
Delete this article
 
Delete this article
Zeile 52: Zeile 52:
  
  
===MediaWiki::Article#full_name===
+
===MediaWiki::Article#full_name()===
  
 
Return the full article name
 
Return the full article name
Zeile 62: Zeile 62:
  
  
===MediaWiki::Article#protect===
+
===MediaWiki::Article#protect(reason, moves_only=false)===
  
 
Protect this article
 
Protect this article
Zeile 70: Zeile 70:
  
  
===MediaWiki::Article#reload===
+
===MediaWiki::Article#reload()===
  
 
Reload Article#text, should be done by Article#initialize.
 
Reload Article#text, should be done by Article#initialize.
  
  
===MediaWiki::Article#submit===
+
===MediaWiki::Article#submit(summary, minor_edit=false, watch_this=false)===
  
 
Push the '''Submit''' button
 
Push the '''Submit''' button
Zeile 89: Zeile 89:
  
  
===MediaWiki::Article#unprotect===
+
===MediaWiki::Article#unprotect(reason)===
  
 
Unprotect this article
 
Unprotect this article
Zeile 97: Zeile 97:
  
  
===MediaWiki::Article#what_links_here===
+
===MediaWiki::Article#what_links_here()===
  
 
What articles link to this article?
 
What articles link to this article?
Zeile 105: Zeile 105:
  
  
===MediaWiki::Article#xhtml===
+
===MediaWiki::Article#xhtml()===
  
 
Get the XHTML, will invoke Article#xhtml_reload if not already cached
 
Get the XHTML, will invoke Article#xhtml_reload if not already cached
Zeile 113: Zeile 113:
  
  
===MediaWiki::Article#xhtml_reload===
+
===MediaWiki::Article#xhtml_reload()===
  
 
Reload the xhtml, will be automatically done by Article#xhtml if not already cached.
 
Reload the xhtml, will be automatically done by Article#xhtml if not already cached.
Zeile 124: Zeile 124:
 
The Category class represents MediaWiki categories.
 
The Category class represents MediaWiki categories.
  
===MediaWiki::Category#articles===
+
===MediaWiki::Category#articles()===
  
 
Which articles belong to this category?
 
Which articles belong to this category?
Zeile 132: Zeile 132:
  
  
===MediaWiki::Category#full_name===
+
===MediaWiki::Category#full_name()===
  
 
This returns the full article name prefixed with "Category:" instead of the name, which should not carry a prefix.
 
This returns the full article name prefixed with "Category:" instead of the name, which should not carry a prefix.
  
  
===MediaWiki::Category#reload===
+
===MediaWiki::Category#reload()===
  
 
Calls the reload function of the super-class (Article#reload) but removes the prefix (namespace) then.
 
Calls the reload function of the super-class (Article#reload) but removes the prefix (namespace) then.
Zeile 156: Zeile 156:
 
All interaction with MiniBrowser is normally done by MediaWiki::Wiki.
 
All interaction with MiniBrowser is normally done by MediaWiki::Wiki.
  
===MediaWiki::MiniBrowser::new===
+
===MediaWiki::MiniBrowser::new(url)===
  
 
Initialize a MiniBrowser instance
 
Initialize a MiniBrowser instance
Zeile 164: Zeile 164:
  
  
===MediaWiki::MiniBrowser#add_cookie===
+
===MediaWiki::MiniBrowser#add_cookie(cookies)===
  
 
Add cookies to the volatile cookie cache
 
Add cookies to the volatile cookie cache
Zeile 172: Zeile 172:
  
  
===MediaWiki::MiniBrowser#cookies===
+
===MediaWiki::MiniBrowser#cookies()===
  
 
Get the cookie cache in a serialized form ready for HTTP.
 
Get the cookie cache in a serialized form ready for HTTP.
Zeile 180: Zeile 180:
  
  
===MediaWiki::MiniBrowser#get_content===
+
===MediaWiki::MiniBrowser#get_content(url)===
  
 
Perform a GET request
 
Perform a GET request
Zeile 192: Zeile 192:
  
  
===MediaWiki::MiniBrowser#post_content===
+
===MediaWiki::MiniBrowser#post_content(url, data)===
  
 
Perform a POST request
 
Perform a POST request
Zeile 225: Zeile 225:
  
  
===MediaWiki::Table::new===
+
===MediaWiki::Table::new( data = [], header = [] )===
  
  
===MediaWiki::Table::parse===
+
===MediaWiki::Table::parse( text )===
  
 
takes the wiki markup of a table and returns a 2-dimensional array representing the rows and columns of the table
 
takes the wiki markup of a table and returns a 2-dimensional array representing the rows and columns of the table
Zeile 235: Zeile 235:
  
  
===MediaWiki::Table#text===
+
===MediaWiki::Table#text()===
  
  
Zeile 247: Zeile 247:
  
  
===MediaWiki::Wiki::new===
+
===MediaWiki::Wiki::new(url, user = nil, password = nil)===
  
 
Initialize a new Wiki instance.
 
Initialize a new Wiki instance.
Zeile 259: Zeile 259:
  
  
===MediaWiki::Wiki#allpages===
+
===MediaWiki::Wiki#allpages()===
  
 
Returns the pages listed on "Special:Allpages"
 
Returns the pages listed on "Special:Allpages"
Zeile 267: Zeile 267:
  
  
===MediaWiki::Wiki#article===
+
===MediaWiki::Wiki#article(name, section = nil)===
  
 
Return a new Article instance with given name, will be constructed with [self] (for MiniBrowser usage)
 
Return a new Article instance with given name, will be constructed with [self] (for MiniBrowser usage)
Zeile 277: Zeile 277:
  
  
===MediaWiki::Wiki#article_url===
+
===MediaWiki::Wiki#article_url(name, section = nil)===
  
 
Construct the URL to a specific article
 
Construct the URL to a specific article
Zeile 291: Zeile 291:
  
  
===MediaWiki::Wiki#category===
+
===MediaWiki::Wiki#category(name)===
  
 
Return a new Category instance with given name, will be constructed with [self] (for MiniBrowser usage)
 
Return a new Category instance with given name, will be constructed with [self] (for MiniBrowser usage)
Zeile 299: Zeile 299:
  
  
===MediaWiki::Wiki#login===
+
===MediaWiki::Wiki#login( username, password )===
  
 
Log in into MediaWiki
 
Log in into MediaWiki

Version vom 15. Dezember 2005, 02:34 Uhr

Inhaltsverzeichnis

Ruby-MediaWiki Documentation

MediaWiki

MediaWiki::dotfile(myrealm=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 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.


MediaWiki::Article

Inherited from Object

The Article class represents MediaWiki articles.

MediaWiki::Article#name (RW)

Article name, will be refreshed upon Article#reload


MediaWiki::Article#text (RW)

Article text, will be set by Article#reload


MediaWiki::Article::new(wiki, name, section = nil, load_text=true)

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::Article#delete(reason)

Delete this article

reason
[String] Delete reason


MediaWiki::Article#full_name()

Return the full article name

This will only return @name, but may be overriden by descendants to include namespaces.

result
[String] Full name


MediaWiki::Article#protect(reason, moves_only=false)

Protect this article

reason
[String] Protect reason


MediaWiki::Article#reload()

Reload Article#text, should be done by Article#initialize.


MediaWiki::Article#submit(summary, minor_edit=false, watch_this=false)

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(reason)

Unprotect this article

reason
[String] Unprotect reason


MediaWiki::Article#what_links_here()

What articles link to this article?

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()

Reload the xhtml, will be automatically done by Article#xhtml if not already cached.


MediaWiki::Category

Inherited from Article

The Category class represents MediaWiki categories.

MediaWiki::Category#articles()

Which articles belong to this category?

result
[Array] of [String] Article names


MediaWiki::Category#full_name()

This returns the full article name prefixed with "Category:" instead of the name, which should not carry a prefix.


MediaWiki::Category#reload()

Calls the reload function of the super-class (Article#reload) but removes the prefix (namespace) then.

Use to full_name to obtain the name with namespace.


MediaWiki::MiniBrowser

Inherited from Object

The MiniBrowser is used to perform GET and POST requests over HTTP and HTTPS, supporting:

  • HTTP-Auth encoding in URLs (proto://user:password@host/...)
  • Cookie support
  • HTTP Redirection (max. 10 in a row)

All interaction with MiniBrowser is normally done by MediaWiki::Wiki.

MediaWiki::MiniBrowser::new(url)

Initialize a MiniBrowser instance

url
[URI::HTTP] or [URI::HTTPS]


MediaWiki::MiniBrowser#add_cookie(cookies)

Add cookies to the volatile cookie cache

cookies
[Array]


MediaWiki::MiniBrowser#cookies()

Get the cookie cache in a serialized form ready for HTTP.

result
[String]


MediaWiki::MiniBrowser#get_content(url)

Perform a GET request

This method accepts 10 HTTP redirects at max.

url
[String]
result
[String] Document


MediaWiki::MiniBrowser#post_content(url, data)

Perform a POST request

Will switch to MiniBrowser#get_content upon HTTP redirect.

url
[String]
data
[Hash] POST data
result
[String] Document


MediaWiki::Table

Inherited from Object

MediaWiki::Table#data (RW)

MediaWiki::Table#header (RW)

MediaWiki::Table#header_style (RW)

MediaWiki::Table#row_style (RW)

MediaWiki::Table#table_style (RW)

MediaWiki::Table::new( data = [], header = [] )

MediaWiki::Table::parse( text )

takes the wiki markup of a table and returns a 2-dimensional array representing the rows and columns of the table

TODO: fill member variables according to parsed tables


MediaWiki::Table#text()

MediaWiki::Wiki

Inherited from Object

MediaWiki::Wiki#browser (R)

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)

Initialize a new Wiki instance.

url
[String] URL-Path to index.php (without index.php), may containt user:password 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)


MediaWiki::Wiki#allpages()

Returns the pages listed on "Special:Allpages"

result
[Array] of [String] Articlenames


MediaWiki::Wiki#article(name, section = nil)

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, section = nil)

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)

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( username, password )

Log in into MediaWiki

This is not HTTP authentication (put HTTP-Auth into [url] of Wiki#initialize!)

user
[String] MediaWiki username
password
[String] MediaWiki password

May raise an exception if cannot authenticate