From 051a71b941d369a146c35685d3ae3697883d4df1 Mon Sep 17 00:00:00 2001 From: AstRobot Date: Sat, 10 Jun 2006 22:47:44 +0000 Subject: [PATCH] I can even document myself :-) --- Ruby-MediaWiki%2FDocumentation.mw | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/Ruby-MediaWiki%2FDocumentation.mw b/Ruby-MediaWiki%2FDocumentation.mw index 00d2dc9d..bff079f4 100644 --- a/Ruby-MediaWiki%2FDocumentation.mw +++ b/Ruby-MediaWiki%2FDocumentation.mw @@ -2,6 +2,8 @@ ==MediaWiki== +Logger is required by article.rb + ===MediaWiki::dotfile(myrealm=nil,mywiki=nil)=== dotfile function reads the user's MediaWiki config and creates a Wiki instance. @@ -283,11 +285,6 @@ 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#logger (R)=== - -The Logger used by this Wiki. - - ===MediaWiki::Wiki::new(url, user = nil, password = nil, loglevel = Logger::WARN)=== Initialize a new Wiki instance. @@ -302,10 +299,14 @@ Initialize a new Wiki instance. : [Integer] Loglevel, default is to log all messages >= Logger::WARN = 2 -===MediaWiki::Wiki#allpages()=== +===MediaWiki::Wiki#allpages(namespace_id=nil)=== Returns the pages listed on "Special:Allpages" +TODO: Handle big wikis with chunked Special:Allpages + +; namespace_id: +: Optional namespace for article index (see Wiki#namespace_ids to retrieve id) ; result: : [Array] of [String] Articlenames @@ -357,3 +358,11 @@ This is '''not''' HTTP authentication (put HTTP-Auth into [url] of Wiki#initiali : [String] MediaWiki password May raise an exception if cannot authenticate + + +===MediaWiki::Wiki#namespace_ids()=== + +Retrieve all namespaces and their IDs, which could be used for Wiki#allpages + +; result: +: [Hash] String => Fixnum