I can even document myself :-)

This commit is contained in:
AstRobot 2006-01-21 19:30:18 +00:00
parent d6fd40152f
commit 151dee0ed1

View File

@ -2,8 +2,6 @@
==MediaWiki==
test
===MediaWiki::dotfile(myrealm=nil)===
dotfile function reads the user's MediaWiki config and creates a Wiki instance.
@ -63,6 +61,9 @@ This will only return @name, but may be overriden by descendants to include name
: [String] Full name
===MediaWiki::Article#parse(html)===
===MediaWiki::Article#protect(reason, moves_only=false)===
Protect this article
@ -76,7 +77,7 @@ Protect this article
Reload Article#text, should be done by Article#initialize.
===MediaWiki::Article#submit(summary, minor_edit=false, watch_this=false)===
===MediaWiki::Article#submit(summary, minor_edit=false, watch_this=false, retries=10)===
Push the '''Submit''' button
@ -211,6 +212,8 @@ Will switch to MiniBrowser#get_content upon HTTP redirect.
Inherited from '''Object'''
The MediaWiki::Table class is used to parse existing tables from mediawiki articles and to create tables from arrays. Currently only the mediawiki pipe syntax is supported.
===MediaWiki::Table#data (RW)===
@ -223,21 +226,31 @@ Inherited from '''Object'''
===MediaWiki::Table#row_style (RW)===
===MediaWiki::Table#table_style (RW)===
===MediaWiki::Table#style (RW)===
===MediaWiki::Table::new( data = [], header = [] )===
Initialize a Table instance
; data:
: [Array] 2-dimensional Array with the tables and cells
; header:
: [Array] 1-dimensional Array used as 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
Parses the wiki markup of a table and returns a 2-dimensional array representing rows and columns of the table. Currently only the mediawiki pipe syntax is supported.
TODO: fill member variables according to parsed tables
; text:
: [String] String to parse
===MediaWiki::Table#text()===
Creates the mediawiki markup to be put in an article
==MediaWiki::Wiki==