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(myrealm=nil)===
+
===MediaWiki::dotfile===
  
 
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 15: Zeile 15:
  
 
==MediaWiki::Article==
 
==MediaWiki::Article==
 +
 +
Inherited from '''Object'''
  
 
The Article class represents MediaWiki articles.
 
The Article class represents MediaWiki articles.
  
===MediaWiki::Article::new(wiki, name, section = nil, load_text=true)===
+
===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===
  
 
Create a new Article instance
 
Create a new Article instance
Zeile 32: Zeile 44:
  
  
===MediaWiki::Article#delete(reason)===
+
===MediaWiki::Article#delete===
  
 
Delete this article
 
Delete this article
Zeile 40: Zeile 52:
  
  
===MediaWiki::Article#protect(reason, moves_only=false)===
+
===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===
  
 
Protect this article
 
Protect this article
Zeile 48: 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(summary, minor_edit=false, watch_this=false)===
+
===MediaWiki::Article#submit===
  
 
Push the '''Submit''' button
 
Push the '''Submit''' button
Zeile 67: Zeile 89:
  
  
===MediaWiki::Article#unprotect(reason)===
+
===MediaWiki::Article#unprotect===
  
 
Unprotect this article
 
Unprotect this article
Zeile 75: 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 83: 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 91: 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 97: Zeile 119:
  
 
==MediaWiki::Category==
 
==MediaWiki::Category==
 +
 +
Inherited from '''Article'''
  
 
The Category class represents MediaWiki categories.
 
The Category class represents MediaWiki categories.
  
===MediaWiki::Category::new(wiki, name)===
+
===MediaWiki::Category#articles===
  
Create a new Category instance
+
Which articles belong to this category?
  
; wiki:
+
; result:
: [Wiki] instance to be used to theive the MiniBrowser
+
: [Array] of [String] Article names
; name:
 
: [String] Category name, to be prefixed with "Category:" when being fetched
 
  
  
===MediaWiki::Category#articles()===
+
===MediaWiki::Category#full_name===
  
Which articles belong to this category?
+
This returns the full article name prefixed with "Category:" instead of the name, which should not carry a prefix.
  
; result:
 
: [Array] of [String] Article names
 
  
 +
===MediaWiki::Category#reload===
  
===MediaWiki::Category#reload()===
+
Calls the reload function of the super-class (Article#reload) but removes the prefix (namespace) then.
  
Reload the XML, will be invoked by Category#articles, if not already cached.
+
Use to full_name to obtain the name with namespace.
  
  
 
==MediaWiki::MiniBrowser==
 
==MediaWiki::MiniBrowser==
  
===MediaWiki::MiniBrowser::new( url )===
+
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===
 +
 
 +
Initialize a MiniBrowser instance
 +
 
 +
; url:
 +
: [URI::HTTP] or [URI::HTTPS]
 +
 
 +
 
 +
===MediaWiki::MiniBrowser#add_cookie===
 +
 
 +
Add cookies to the volatile cookie cache
 +
 
 +
; cookies:
 +
: [Array]
 +
 
  
 +
===MediaWiki::MiniBrowser#cookies===
  
===MediaWiki::MiniBrowser#add_cookie( cookies )===
+
Get the cookie cache in a serialized form ready for HTTP.
  
 +
; result:
 +
: [String]
  
===MediaWiki::MiniBrowser#cookies()===
 
  
 +
===MediaWiki::MiniBrowser#get_content===
  
===MediaWiki::MiniBrowser#get_content(url)===
+
Perform a GET request
  
 +
This method accepts 10 HTTP redirects at max.
  
===MediaWiki::MiniBrowser#post_content( url, data )===
+
; url:
 +
: [String]
 +
; result:
 +
: [String] Document
 +
 
 +
 
 +
===MediaWiki::MiniBrowser#post_content===
 +
 
 +
Perform a POST request
 +
 
 +
Will switch to MiniBrowser#get_content upon HTTP redirect.
 +
 
 +
; url:
 +
: [String]
 +
; data:
 +
: [Hash] POST data
 +
; result:
 +
: [String] Document
  
  
 
==MediaWiki::Table==
 
==MediaWiki::Table==
  
===MediaWiki::Table::new( data = [], header = [] )===
+
Inherited from '''Object'''
 +
 
 +
===MediaWiki::Table#data (RW)===
 +
 
 +
 
 +
===MediaWiki::Table#header (RW)===
 +
 
 +
 
 +
===MediaWiki::Table#header_style (RW)===
 +
 
 +
 
 +
===MediaWiki::Table#row_style (RW)===
  
  
===MediaWiki::Table::parse( text )===
+
===MediaWiki::Table#table_style (RW)===
 +
 
 +
 
 +
===MediaWiki::Table::new===
 +
 
 +
 
 +
===MediaWiki::Table::parse===
  
 
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 152: Zeile 235:
  
  
===MediaWiki::Table#text()===
+
===MediaWiki::Table#text===
  
  
 
==MediaWiki::Wiki==
 
==MediaWiki::Wiki==
  
===MediaWiki::Wiki::new(url, user = nil, password = nil)===
+
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===
  
 
Initialize a new Wiki instance.
 
Initialize a new Wiki instance.
Zeile 169: Zeile 259:
  
  
===MediaWiki::Wiki#allpages()===
+
===MediaWiki::Wiki#allpages===
  
 
Returns the pages listed on "Special:Allpages"
 
Returns the pages listed on "Special:Allpages"
Zeile 177: Zeile 267:
  
  
===MediaWiki::Wiki#article(name, section = nil)===
+
===MediaWiki::Wiki#article===
  
 
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 187: Zeile 277:
  
  
===MediaWiki::Wiki#article_url(name, section = nil)===
+
===MediaWiki::Wiki#article_url===
  
 
Construct the URL to a specific article
 
Construct the URL to a specific article
Zeile 201: Zeile 291:
  
  
===MediaWiki::Wiki#category(name)===
+
===MediaWiki::Wiki#category===
  
 
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 209: Zeile 299:
  
  
===MediaWiki::Wiki#login( username, password )===
+
===MediaWiki::Wiki#login===
  
 
Log in into MediaWiki
 
Log in into MediaWiki

Version vom 15. Dezember 2005, 01:32 Uhr

Ruby-MediaWiki Documentation

MediaWiki

MediaWiki::dotfile

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

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

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

Protect this article

reason
[String] Protect reason


MediaWiki::Article#reload

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


MediaWiki::Article#submit

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

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

Initialize a MiniBrowser instance

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


MediaWiki::MiniBrowser#add_cookie

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

Perform a GET request

This method accepts 10 HTTP redirects at max.

url
[String]
result
[String] Document


MediaWiki::MiniBrowser#post_content

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

MediaWiki::Table::parse

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

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

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

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

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

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