From b0818acd868d7e5851fccd3c7d77f1c0b28b075b Mon Sep 17 00:00:00 2001 From: Sam Reed Date: Sat, 17 Dec 2011 19:10:33 +0000 Subject: [PATCH] More example conversions/additions Ping r106439 --- includes/api/ApiComparePages.php | 2 +- includes/api/ApiDelete.php | 4 ++-- includes/api/ApiEditPage.php | 14 ++++++++------ includes/api/ApiEmailUser.php | 2 +- includes/api/ApiFileRevert.php | 4 ++-- includes/api/ApiFormatBase.php | 5 ++++- includes/api/ApiHelp.php | 15 +++++---------- includes/api/ApiImport.php | 4 ++-- includes/api/ApiLogout.php | 2 +- includes/api/ApiPurge.php | 2 +- includes/api/ApiUpload.php | 8 ++++---- 11 files changed, 31 insertions(+), 31 deletions(-) diff --git a/includes/api/ApiComparePages.php b/includes/api/ApiComparePages.php index 6c22f18d8f..7328902436 100644 --- a/includes/api/ApiComparePages.php +++ b/includes/api/ApiComparePages.php @@ -120,7 +120,7 @@ class ApiComparePages extends ApiBase { public function getExamples() { return array( - 'api.php?action=compare&fromrev=1&torev=2', + 'api.php?action=compare&fromrev=1&torev=2' => 'Creates a diff between revision 1 and 2', ); } diff --git a/includes/api/ApiDelete.php b/includes/api/ApiDelete.php index 6d9a3004bd..fe53b02b0c 100644 --- a/includes/api/ApiDelete.php +++ b/includes/api/ApiDelete.php @@ -268,8 +268,8 @@ class ApiDelete extends ApiBase { public function getExamples() { return array( - 'api.php?action=delete&title=Main%20Page&token=123ABC', - 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move' + 'api.php?action=delete&title=Main%20Page&token=123ABC' => 'Deletes the Main Page', + 'api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move' => 'Deletes the Main Page with the reason "Preparing for move"', ); } diff --git a/includes/api/ApiEditPage.php b/includes/api/ApiEditPage.php index 3fa8b0444e..5179075e71 100644 --- a/includes/api/ApiEditPage.php +++ b/includes/api/ApiEditPage.php @@ -493,12 +493,14 @@ class ApiEditPage extends ApiBase { public function getExamples() { return array( - 'Edit a page (anonymous user):', - ' api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=20070824123454&token=%2B\\', - 'Prepend __NOTOC__ to a page (anonymous user):', - ' api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=20070824123454&token=%2B\\', - 'Undo r13579 through r13585 with autosummary (anonymous user):', - ' api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=20070824123454&token=%2B\\', + + 'api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=20070824123454&token=%2B\\' + => 'Edit a page (anonymous user)', + + 'api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=20070824123454&token=%2B\\' + => 'Prepend __NOTOC__ to a page (anonymous user)', + 'api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=20070824123454&token=%2B\\' + => 'Undo r13579 through r13585 with autosummary (anonymous user)', ); } diff --git a/includes/api/ApiEmailUser.php b/includes/api/ApiEmailUser.php index 5a01ae9776..004ca73601 100644 --- a/includes/api/ApiEmailUser.php +++ b/includes/api/ApiEmailUser.php @@ -133,7 +133,7 @@ class ApiEmailUser extends ApiBase { public function getExamples() { return array( - 'api.php?action=emailuser&target=WikiSysop&text=Content' + 'api.php?action=emailuser&target=WikiSysop&text=Content' => 'Sends an email to the User "WikiSysop" with the text "Content"', ); } diff --git a/includes/api/ApiFileRevert.php b/includes/api/ApiFileRevert.php index 0a21680954..7ef1da0af1 100644 --- a/includes/api/ApiFileRevert.php +++ b/includes/api/ApiFileRevert.php @@ -171,8 +171,8 @@ class ApiFileRevert extends ApiBase { public function getExamples() { return array( - 'Revert Wiki.png to the version of 20110305152740:', - ' api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=+\\', + 'api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=+\\' + => 'Revert Wiki.png to the version of 20110305152740', ); } diff --git a/includes/api/ApiFormatBase.php b/includes/api/ApiFormatBase.php index a0138ac366..7a53b64105 100644 --- a/includes/api/ApiFormatBase.php +++ b/includes/api/ApiFormatBase.php @@ -286,7 +286,10 @@ See complete documentation, or } public function getExamples() { - return 'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName(); + return array( + 'api.php?action=query&meta=siteinfo&siprop=namespaces&format=' . $this->getModuleName() + => "Formats the query result in the {$this->getModuleName()} format", + ); } public function getHelpUrls() { diff --git a/includes/api/ApiHelp.php b/includes/api/ApiHelp.php index d94132a59d..97da786b1e 100644 --- a/includes/api/ApiHelp.php +++ b/includes/api/ApiHelp.php @@ -136,16 +136,11 @@ class ApiHelp extends ApiBase { public function getExamples() { return array( - 'Whole help page:', - ' api.php?action=help', - 'Module (action) help page:', - ' api.php?action=help&modules=protect', - 'Query (list) modules help page:', - ' api.php?action=help&querymodules=categorymembers', - 'Query (prop) modules help page:', - ' api.php?action=help&querymodules=info', - 'Query (meta) modules help page:', - ' api.php?action=help&querymodules=siteinfo', + 'api.php?action=help' => 'Whole help page', + 'api.php?action=help&modules=protect' => 'Module (action) help page', + 'api.php?action=help&querymodules=categorymembers' => 'Query (list) modules help page', + 'api.php?action=help&querymodules=info' => 'Query (prop) modules help page', + 'api.php?action=help&querymodules=siteinfo' => 'Query (meta) modules help page', ); } diff --git a/includes/api/ApiImport.php b/includes/api/ApiImport.php index d38aaf8d5a..ade9f1f3fd 100644 --- a/includes/api/ApiImport.php +++ b/includes/api/ApiImport.php @@ -154,8 +154,8 @@ class ApiImport extends ApiBase { public function getExamples() { return array( - 'Import [[meta:Help:Parserfunctions]] to namespace 100 with full history:', - ' api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC', + 'api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC' + => 'Import [[meta:Help:Parserfunctions]] to namespace 100 with full history', ); } diff --git a/includes/api/ApiLogout.php b/includes/api/ApiLogout.php index f530e87522..0e4ae5378f 100644 --- a/includes/api/ApiLogout.php +++ b/includes/api/ApiLogout.php @@ -64,7 +64,7 @@ class ApiLogout extends ApiBase { public function getExamples() { return array( - 'api.php?action=logout' + 'api.php?action=logout' => 'Logs the current user out', ); } diff --git a/includes/api/ApiPurge.php b/includes/api/ApiPurge.php index d2e0777744..6bf5cb8f25 100644 --- a/includes/api/ApiPurge.php +++ b/includes/api/ApiPurge.php @@ -149,7 +149,7 @@ class ApiPurge extends ApiBase { public function getExamples() { return array( - 'api.php?action=purge&titles=Main_Page|API' + 'api.php?action=purge&titles=Main_Page|API' => 'Purges the "Main Page" and the "API" page', ); } diff --git a/includes/api/ApiUpload.php b/includes/api/ApiUpload.php index 0ac7fb42a6..e8fc52ade1 100644 --- a/includes/api/ApiUpload.php +++ b/includes/api/ApiUpload.php @@ -646,10 +646,10 @@ class ApiUpload extends ApiBase { public function getExamples() { return array( - 'Upload from a URL:', - ' api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png', - 'Complete an upload that failed due to warnings:', - ' api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1', + 'api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png' + => 'Upload from a URL', + 'api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1' + => 'Complete an upload that failed due to warnings', ); } -- 2.20.1