Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Revert r106439, r106441 - bad formatting mushing separate lines together

Browse source
This commit is contained in:
Brion Vibber 2011-12-20 22:11:29 +00:00
parent adf5768359
commit ad0d48d6bc
15 changed files with 57 additions and 104 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
RELEASE-NOTES-1.19
View file

@ -218,7 +218,6 @@ production.
* (bug 32415) Empty page get no size attribute in API output.
* (bug 31759) Undefined property notice in querypages API.
* (bug 32495) API should allow purge by pageids.
* (bug 33147) API examples should explain what they do.
=== Languages updated in 1.19 ===

32
includes/api/ApiBase.php
View file

@ -267,29 +267,7 @@ abstract class ApiBase extends ContextSource {
$msg .= "Parameters:\n$paramsMsg";
}
$examples = $this->getExamples();
if ( $examples !== false ) {
if ( !is_array( $examples ) ) {
$examples = array(
$examples
);
}
$msg .= "Example" . ( count( $examples ) > 1 ? 's' : '' ) . ":\n";
foreach( $examples as $k => $v ) {
if ( is_numeric( $k ) ) {
$msg .= " $v\n";
} else {
if ( is_array( $v ) ) {
$msg .= implode( "\n", array_map( array( $this, 'indentExampleText' ), $v ) );
} else {
$msg .= " $v";
}
$msg .= "\n $k";
}
}
}
$msg .= "\n";
$msg .= $this->makeHelpArrayToString( $lnPrfx, "Example", $this->getExamples() );
$msg .= $this->makeHelpArrayToString( $lnPrfx, "Help page", $this->getHelpUrls() );
if ( $this->getMain()->getShowVersions() ) {
@ -313,14 +291,6 @@ abstract class ApiBase extends ContextSource {
return $msg;
}
/**
* @param $item string
* @return string
*/
private function indentExampleText( $item ) {
return " " . $item;
}
/**
* @param $prefix string Text to split output items
* @param $title string What is being output

30
includes/api/ApiParamInfo.php
View file

@ -114,9 +114,8 @@ class ApiParamInfo extends ApiBase {
$result = $this->getResult();
$retval['classname'] = get_class( $obj );
$retval['description'] = implode( "\n", (array)$obj->getFinalDescription() );
$retval['examples'] = '';
$examples = (array)$obj->getExamples();
$retval['examples'] = implode( "\n", $examples );
$retval['version'] = implode( "\n", (array)$obj->getVersion() );
$retval['prefix'] = $obj->getModulePrefix();
@ -144,28 +143,9 @@ class ApiParamInfo extends ApiBase {
}
$result->setIndexedTagName( $retval['helpurls'], 'helpurl' );
$examples = $obj->getExamples();
$retval['allexamples'] = array();
if ( $examples !== false ) {
foreach( $examples as $k => $v ) {
if ( strlen( $retval['examples'] ) ) {
$retval['examples'] .= ' ';
}
$item = array();
if ( is_numeric( $k ) ) {
$retval['examples'] .= $v;
$result->setContent( $item, $v );
} else {
if ( !is_array( $v ) ) {
$item['description'] = $v;
} else {
$item['description'] = implode( $v, "\n" );
}
$retval['examples'] .= $item['description'] . ' ' . $k;
$result->setContent( $item, $k );
}
$retval['allexamples'][] = $item;
}
$retval['allexamples'] = $examples;
if ( isset( $retval['allexamples'][0] ) && $retval['allexamples'][0] === false ) {
$retval['allexamples'] = array();
}
$result->setIndexedTagName( $retval['allexamples'], 'example' );

14
includes/api/ApiQueryAllimages.php
View file

@ -246,14 +246,12 @@ class ApiQueryAllimages extends ApiQueryGeneratorBase {
public function getExamples() {
return array(
'api.php?action=query&list=allimages&aifrom=B' => array(
'Simple Use',
'Show a list of images starting at the letter "B"',
),
'api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo' => array(
'Using as Generator',
'Show info about 4 images starting at the letter "T"',
),
'Simple Use',
' Show a list of images starting at the letter "B"',
' api.php?action=query&list=allimages&aifrom=B',
'Using as Generator',
' Show info about 4 images starting at the letter "T"',
' api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo',
);
}

19
includes/api/ApiQueryAllpages.php
View file

@ -309,17 +309,14 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
public function getExamples() {
return array(
'api.php?action=query&list=allpages&apfrom=B' => array(
'Simple Use',
'Show a list of pages starting at the letter "B"',
),
'api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info' => array(
'Using as Generator',
'Show info about 4 pages starting at the letter "T"',
),
'api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content' => array(
'Show content of first 2 non-redirect pages begining at "Re"',
)
'Simple Use',
' Show a list of pages starting at the letter "B"',
' api.php?action=query&list=allpages&apfrom=B',
'Using as Generator',
' Show info about 4 pages starting at the letter "T"',
' api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info',
' Show content of first 2 non-redirect pages begining at "Re"',
' api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
);
}

6
includes/api/ApiQueryCategories.php
View file

@ -251,8 +251,10 @@ class ApiQueryCategories extends ApiQueryGeneratorBase {
public function getExamples() {
return array(
'api.php?action=query&prop=categories&titles=Albert%20Einstein' => 'Get a list of categories [[Albert Einstein]] belongs to:',
'api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info' => 'Get information about all categories used in the [[Albert Einstein]]:',
'Get a list of categories [[Albert Einstein]] belongs to:',
' api.php?action=query&prop=categories&titles=Albert%20Einstein',
'Get information about all categories used in the [[Albert Einstein]]:',
' api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info'
);
}

6
includes/api/ApiQueryCategoryMembers.php
View file

@ -389,8 +389,10 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase {
public function getExamples() {
return array(
'api.php?action=query&list=categorymembers&cmtitle=Category:Physics' => 'Get first 10 pages in [[Category:Physics]]:',
'api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info' => 'Get page info about first 10 pages in [[Category:Physics]]:',
'Get first 10 pages in [[Category:Physics]]:',
' api.php?action=query&list=categorymembers&cmtitle=Category:Physics',
'Get page info about first 10 pages in [[Category:Physics]]:',
' api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info',
);
}

16
includes/api/ApiQueryDeletedrevs.php
View file

@ -393,14 +393,14 @@ class ApiQueryDeletedrevs extends ApiQueryBase {
public function getExamples() {
return array(
'api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content'
=> 'List the last deleted revisions of Main Page and Talk:Main Page, with content (mode 1):',
'api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50'
=> 'List the last 50 deleted contributions by Bob (mode 2):',
'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50'
=> 'List the first 50 deleted revisions in the main namespace (mode 3):',
'api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique='
=> 'List the first 50 deleted pages in the Talk namespace (mode 3):',
'List the last deleted revisions of Main Page and Talk:Main Page, with content (mode 1):',
' api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content',
'List the last 50 deleted contributions by Bob (mode 2):',
' api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50',
'List the first 50 deleted revisions in the main namespace (mode 3):',
' api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50',
'List the first 50 deleted pages in the Talk namespace (mode 3):',
' api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique=',
);
}

3
includes/api/ApiQueryExternalLinks.php
View file

@ -145,7 +145,8 @@ class ApiQueryExternalLinks extends ApiQueryBase {
public function getExamples() {
return array(
'api.php?action=query&prop=extlinks&titles=Main%20Page' => 'Get a list of external links on the [[Main Page]]:',
'Get a list of external links on the [[Main Page]]:',
' api.php?action=query&prop=extlinks&titles=Main%20Page',
);
}

7
includes/api/ApiQueryFilearchive.php
View file

@ -282,10 +282,9 @@ class ApiQueryFilearchive extends ApiQueryBase {
public function getExamples() {
return array(
'api.php?action=query&list=filearchive' => array(
'Simple Use',
'Show a list of all deleted files',
),
'Simple Use',
' Show a list of all deleted files',
' api.php?action=query&list=filearchive',
);
}

3
includes/api/ApiQueryIWLinks.php
View file

@ -178,7 +178,8 @@ class ApiQueryIWLinks extends ApiQueryBase {
public function getExamples() {
return array(
'api.php?action=query&prop=iwlinks&titles=Main%20Page' => 'Get interwiki links from the [[Main Page]]:',
'Get interwiki links from the [[Main Page]]:',
' api.php?action=query&prop=iwlinks&titles=Main%20Page',
);
}

6
includes/api/ApiQueryImages.php
View file

@ -185,8 +185,10 @@ class ApiQueryImages extends ApiQueryGeneratorBase {
public function getExamples() {
return array(
'api.php?action=query&prop=images&titles=Main%20Page' => 'Get a list of images used in the [[Main Page]]:',
'api.php?action=query&generator=images&titles=Main%20Page&prop=info' => 'Get information about all images used in the [[Main Page]]:',
'Get a list of images used in the [[Main Page]]:',
' api.php?action=query&prop=images&titles=Main%20Page',
'Get information about all images used in the [[Main Page]]:',
' api.php?action=query&generator=images&titles=Main%20Page&prop=info'
);
}

3
includes/api/ApiQueryLangLinks.php
View file

@ -171,7 +171,8 @@ class ApiQueryLangLinks extends ApiQueryBase {
public function getExamples() {
return array(
'api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=' => 'Get interlanguage links from the [[Main Page]]:',
'Get interlanguage links from the [[Main Page]]:',
' api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=',
);
}

11
includes/api/ApiQueryLinks.php
View file

@ -231,12 +231,13 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
}
public function getExamples() {
$desc = $this->description;
$name = $this->getModuleName();
return array(
"api.php?action=query&prop={$name}&titles=Main%20Page" => "Get {$desc}s from the [[Main Page]]:",
"api.php?action=query&generator={$name}&titles=Main%20Page&prop=info" => "Get information about the {$desc} pages in the [[Main Page]]:",
"api.php?action=query&prop={$name}&titles=Main%20Page&{$this->prefix}namespace=2|10" => "Get {$desc}s from the Main Page in the User and Template namespaces:",
"Get {$this->description}s from the [[Main Page]]:",
" api.php?action=query&prop={$this->getModuleName()}&titles=Main%20Page",
"Get information about the {$this->description} pages in the [[Main Page]]:",
" api.php?action=query&generator={$this->getModuleName()}&titles=Main%20Page&prop=info",
"Get {$this->description}s from the Main Page in the User and Template namespaces:",
" api.php?action=query&prop={$this->getModuleName()}&titles=Main%20Page&{$this->prefix}namespace=2|10"
);
}

4
includes/api/ApiWatch.php
View file

@ -114,8 +114,8 @@ class ApiWatch extends ApiBase {
public function getExamples() {
return array(
'api.php?action=watch&title=Main_Page' => 'Watch the page "Main Page"',
'api.php?action=watch&title=Main_Page&unwatch=' => 'Unwatch the page "Main Page"',
'api.php?action=watch&title=Main_Page',
'api.php?action=watch&title=Main_Page&unwatch=',
);
}