jenkins-bot has submitted this change and it was merged.
Change subject: Convert API help to use i18n pt.3
......................................................................
Convert API help to use i18n pt.3
- API help modified to use i18n messages
- i18n messages edited to add said messages
Bug: T74704
Change-Id: I742729f002bd58a816a86b6137f7c5d68ab1915e
---
M repo/i18n/en.json
M repo/i18n/qqq.json
M repo/includes/api/RemoveClaims.php
M repo/includes/api/RemoveQualifiers.php
M repo/includes/api/RemoveReferences.php
M repo/includes/api/SearchEntities.php
M repo/includes/api/SetAliases.php
7 files changed, 101 insertions(+), 177 deletions(-)
Approvals:
Aude: Looks good to me, approved
jenkins-bot: Verified
diff --git a/repo/i18n/en.json b/repo/i18n/en.json
index f246361..a04f08a 100644
--- a/repo/i18n/en.json
+++ b/repo/i18n/en.json
@@ -520,5 +520,40 @@
"apihelp-wbparsevalue-param-values": "The values to parse",
"apihelp-wbparsevalue-param-options": "The options the parser should
use. Provided as a JSON object.",
"apihelp-wbparsevalue-example-1": "No change to the format of the
string.",
- "apihelp-wbparsevalue-example-2": "Parse 1994-02-08 to a date format
with a precision of 9 (the year)."
+ "apihelp-wbparsevalue-example-2": "Parse 1994-02-08 to a date format
with a precision of 9 (the year).",
+ "apihelp-wbremoveclaims-description": "Removes Wikibase claims.",
+ "apihelp-wbremoveclaims-param-claim": "One GUID or several
(pipe-separated) GUIDs identifying the claims to be removed.\nAll claims must
belong to the same entity.",
+ "apihelp-wbremoveclaims-example-1": "Remove claim with GUID of
\"Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0N\"",
+ "apihelp-wbremovequalifiers-description": "Removes a qualifier from a
claim.",
+ "apihelp-wbremovequalifiers-param-claim": "A GUID identifying the claim
from which to remove qualifiers",
+ "apihelp-wbremovequalifiers-param-qualifiers": "Snak hashes of the
qualifiers to remove",
+ "apihelp-wbremovequalifiers-example-1": "Remove qualifier with hash
\"1eb8793c002b1d9820c833d234a1b54c8e94187e\" from claim with GUID of
\"Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F\"",
+ "apihelp-wbremovereferences-description": "Removes one or more
references of the same statement.",
+ "apihelp-wbremovereferences-param-statement": "A GUID identifying the
statement for which a reference is being set",
+ "apihelp-wbremovereferences-param-references": "The hashes of the
references that should be removed",
+ "apihelp-wbremovereferences-example-1": "Remove reference with hash
\"455481eeac76e6a8af71a6b493c073d54788e7e9\" from claim with GUID of
\"Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F\"",
+ "apihelp-wbsearchentities-description": "Searches for entities.",
+ "apihelp-wbsearchentities-param-search": "Search for this text.",
+ "apihelp-wbsearchentities-param-language": "Search in this language.",
+ "apihelp-wbsearchentities-param-type": "Search for this type of
entity.",
+ "apihelp-wbsearchentities-param-limit": "Maximal number of results",
+ "apihelp-wbsearchentities-param-continue": "Offset where to continue a
search",
+ "apihelp-wbsearchentities-example-1": "Search for \"abc\" in English
language, with defaults for type and limit",
+ "apihelp-wbsearchentities-example-2": "Search for \"abc\" in English
language with a limit of 50",
+ "apihelp-wbsearchentities-example-3": "Search for \"alphabet\" in
English language for type property",
+ "apihelp-wbsetaliases-description": "Sets the aliases for a Wikibase
entity.",
+ "apihelp-wbsetaliases-param-id": "The identifier for the entity,
including the prefix.\nUse either 'id' or 'site' and 'title' together.",
+ "apihelp-wbsetaliases-param-site": "An identifier for the site on which
the page resides.\nUse together with 'title' to make a complete sitelink.",
+ "apihelp-wbsetaliases-param-title": "Title of the page to
associate.\nUse together with 'site' to make a complete sitelink.",
+ "apihelp-wbsetaliases-param-baserevid": "The numeric identifier for the
revision to base the modification on.\nThis is used for detecting conflicts
during save.",
+ "apihelp-wbsetaliases-param-summary": "Summary for the edit.\nWill be
prepended by an automatically generated comment. The length limit of
the\nautocomment together with the summary is 260 characters. Be aware that
everything above that\nlimit will be cut off.",
+ "apihelp-wbsetaliases-param-bot": "Mark this edit as bot\nThis URL flag
will only be respected if the user belongs to the group \"bot\".",
+ "apihelp-wbsetaliases-param-add": "List of aliases to add (can be
combined with remove)",
+ "apihelp-wbsetaliases-param-remove": "List of aliases to remove (can be
combined with add)",
+ "apihelp-wbsetaliases-param-set": "A list of aliases that will replace
the current list (can not be combined with neither add nor remove)",
+ "apihelp-wbsetaliases-param-language": "The language of which to set
the aliases",
+ "apihelp-wbsetaliases-example-1": "Set the English aliases for the
entity with ID Q1 to Foo and Bar",
+ "apihelp-wbsetaliases-example-2": "Add Foo and Bar to the list of
English aliases for the entity with ID Q1",
+ "apihelp-wbsetaliases-example-3": "Remove Foo and Bar from the list of
English aliases for the entity with ID Q1",
+ "apihelp-wbsetaliases-example-4": "Remove Foo from the list of English
aliases for the entity with ID Q1 while adding Bar to it"
}
diff --git a/repo/i18n/qqq.json b/repo/i18n/qqq.json
index 010f67e..f6d4cf9 100644
--- a/repo/i18n/qqq.json
+++ b/repo/i18n/qqq.json
@@ -459,7 +459,6 @@
"apihelp-wbcreateredirect-description":
"{{doc-apihelp-description|wbcreateredirect}}",
"apihelp-wbcreateredirect-param-from":
"{{doc-apihelp-param|wbcreateclaim|from}}",
"apihelp-wbcreateredirect-param-to":
"{{doc-apihelp-param|wbcreateclaim|to}}",
- "apihelp-wbcreateredirect-param-token":
"{{doc-apihelp-param|wbcreateclaim|token}}",
"apihelp-wbcreateredirect-param-bot":
"{{doc-apihelp-param|wbcreateclaim|bot}}",
"apihelp-wbcreateredirect-example-1":
"{{doc-apihelp-example|wbcreateredirect}}",
"apihelp-wbeditentity-description":
"{{doc-apihelp-description|wbeditentity}}",
@@ -468,7 +467,6 @@
"apihelp-wbeditentity-param-title":
"{{doc-apihelp-param|wbeditentity|title}}",
"apihelp-wbeditentity-param-baserevid":
"{{doc-apihelp-param|wbeditentity|baserevid}}",
"apihelp-wbeditentity-param-summary":
"{{doc-apihelp-param|wbeditentity|summary}}",
- "apihelp-wbeditentity-param-token":
"{{doc-apihelp-param|wbeditentity|token}}",
"apihelp-wbeditentity-param-bot":
"{{doc-apihelp-param|wbeditentity|bot}}",
"apihelp-wbeditentity-param-data":
"{{doc-apihelp-param|wbeditentity|data}}",
"apihelp-wbeditentity-param-clear":
"{{doc-apihelp-param|wbeditentity|clear}}",
@@ -529,14 +527,12 @@
"apihelp-wblinktitles-param-totitle":
"{{doc-apihelp-param|wblinktitles|totitle}}",
"apihelp-wblinktitles-param-fromsite":
"{{doc-apihelp-param|wblinktitles|fromsite}}",
"apihelp-wblinktitles-param-fromtitle":
"{{doc-apihelp-param|wblinktitles|fromtitle}}",
- "apihelp-wblinktitles-param-token":
"{{doc-apihelp-param|wblinktitles|token}}",
"apihelp-wblinktitles-param-bot":
"{{doc-apihelp-param|wblinktitles|bot}}",
"apihelp-wblinktitles-example-1":
"{{doc-apihelp-example|wblinktitles}}",
"apihelp-wbmergeitems-description":
"{{doc-apihelp-description|wbmergeitems}}",
"apihelp-wbmergeitems-param-fromid":
"{{doc-apihelp-param|wbmergeitems|fromid}}",
"apihelp-wbmergeitems-param-toid":
"{{doc-apihelp-param|wbmergeitems|toid}}",
"apihelp-wbmergeitems-param-ignoreconflicts":
"{{doc-apihelp-param|wbmergeitems|ignoreconflicts}}",
- "apihelp-wbmergeitems-param-token":
"{{doc-apihelp-param|wbmergeitems|token}}",
"apihelp-wbmergeitems-param-summary":
"{{doc-apihelp-param|wbmergeitems|summary}}",
"apihelp-wbmergeitems-param-bot":
"{{doc-apihelp-param|wbmergeitems|bot}}",
"apihelp-wbmergeitems-example-1":
"{{doc-apihelp-example|wbmergeitems}}",
@@ -548,5 +544,40 @@
"apihelp-wbparsevalue-param-values":
"{{doc-apihelp-param|wbparsevalue|values}}",
"apihelp-wbparsevalue-param-options":
"{{doc-apihelp-param|wbparsevalue|options}}",
"apihelp-wbparsevalue-example-1":
"{{doc-apihelp-example|wbparsevalue}}",
- "apihelp-wbparsevalue-example-2": "{{doc-apihelp-example|wbparsevalue}}"
+ "apihelp-wbparsevalue-example-2":
"{{doc-apihelp-example|wbparsevalue}}",
+ "apihelp-wbremoveclaims-description":
"{{doc-apihelp-description|wbremoveclaims}}",
+ "apihelp-wbremoveclaims-param-claim":
"{{doc-apihelp-param|wbremoveclaims|claim}}",
+ "apihelp-wbremoveclaims-example-1":
"{{doc-apihelp-example|wbremoveclaim}}",
+ "apihelp-wbremovequalifiers-description":
"{{doc-apihelp-description|wbremovequalifiers}}",
+ "apihelp-wbremovequalifiers-param-claim":
"{{doc-apihelp-param|wbremovequalifiers|claim}}",
+ "apihelp-wbremovequalifiers-param-qualifiers":
"{{doc-apihelp-param|wbremovequalifiers|qualifiers}}",
+ "apihelp-wbremovequalifiers-example-1":
"{{doc-apihelp-example|wbremovequalifiers}}",
+ "apihelp-wbremovereferences-description":
"{{doc-apihelp-description|wbremovereferences}}",
+ "apihelp-wbremovereferences-param-statement":
"{{doc-apihelp-param|wbremovereferences|statement}}",
+ "apihelp-wbremovereferences-param-references":
"{{doc-apihelp-param|wbremovereferences|references}}",
+ "apihelp-wbremovereferences-example-1":
"{{doc-apihelp-example|wbremovereferences}}",
+ "apihelp-wbsearchentities-description":
"{{doc-apihelp-description|wbsearchentities}}",
+ "apihelp-wbsearchentities-param-search":
"{{doc-apihelp-param|wbsearchentities|search}}",
+ "apihelp-wbsearchentities-param-language":
"{{doc-apihelp-param|wbsearchentities|language}}",
+ "apihelp-wbsearchentities-param-type":
"{{doc-apihelp-param|wbsearchentities|type}}",
+ "apihelp-wbsearchentities-param-limit":
"{{doc-apihelp-param|wbsearchentities|limit}}",
+ "apihelp-wbsearchentities-param-continue":
"{{doc-apihelp-param|wbsearchentities|continue}}",
+ "apihelp-wbsearchentities-example-1":
"{{doc-apihelp-example|wbsearchentities}}",
+ "apihelp-wbsearchentities-example-2":
"{{doc-apihelp-example|wbsearchentities}}",
+ "apihelp-wbsearchentities-example-3":
"{{doc-apihelp-example|wbsearchentities}}",
+ "apihelp-wbsetaliases-description":
"{{doc-apihelp-description|wbsetaliases}}",
+ "apihelp-wbsetaliases-param-id":
"{{doc-apihelp-param|wbsetaliases|id}}",
+ "apihelp-wbsetaliases-param-site":
"{{doc-apihelp-param|wbsetaliases|site}}",
+ "apihelp-wbsetaliases-param-title":
"{{doc-apihelp-param|wbsetaliases|title}}",
+ "apihelp-wbsetaliases-param-baserevid":
"{{doc-apihelp-param|wbsetaliases|baserevid}}",
+ "apihelp-wbsetaliases-param-summary":
"{{doc-apihelp-param|wbsetaliases|summary}}",
+ "apihelp-wbsetaliases-param-bot":
"{{doc-apihelp-param|wbsetaliases|bot}}",
+ "apihelp-wbsetaliases-param-add":
"{{doc-apihelp-param|wbsetaliases|add}}",
+ "apihelp-wbsetaliases-param-remove":
"{{doc-apihelp-param|wbsetaliases|remove}}",
+ "apihelp-wbsetaliases-param-set":
"{{doc-apihelp-param|wbsetaliases|set}}",
+ "apihelp-wbsetaliases-param-language":
"{{doc-apihelp-param|wbsetaliases|language}}",
+ "apihelp-wbsetaliases-example-1":
"{{doc-apihelp-example|wbsetaliases}}",
+ "apihelp-wbsetaliases-example-2":
"{{doc-apihelp-example|wbsetaliases}}",
+ "apihelp-wbsetaliases-example-3":
"{{doc-apihelp-example|wbsetaliases}}",
+ "apihelp-wbsetaliases-example-4": "{{doc-apihelp-example|wbsetaliases}}"
}
diff --git a/repo/includes/api/RemoveClaims.php
b/repo/includes/api/RemoveClaims.php
index 54dc85e..9db7824 100644
--- a/repo/includes/api/RemoveClaims.php
+++ b/repo/includes/api/RemoveClaims.php
@@ -163,46 +163,13 @@
}
/**
- * @see \ApiBase::getParamDescription
- *
- * @since 0.3
+ * @see ApiBase::getExamplesMessages()
*
* @return array
*/
- public function getParamDescription() {
- return array_merge(
- parent::getParamDescription(),
- array(
- 'claim' => array( 'One GUID or several
(pipe-separated) GUIDs identifying the claims to be removed.',
- 'All claims must belong to the same
entity.'
- ),
- )
- );
- }
-
- /**
- * @see \ApiBase::getDescription
- *
- * @since 0.3
- *
- * @return string
- */
- public function getDescription() {
+ protected function getExamplesMessages() {
return array(
- 'API module for removing Wikibase claims.'
- );
- }
-
- /**
- * @see \ApiBase::getExamples
- *
- * @since 0.3
- *
- * @return array
- */
- protected function getExamples() {
- return array(
-
'api.php?action=wbremoveclaims&claim=Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0N&token=foobar&baserevid=7201010'
=> 'Remove claim with GUID of "Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0N"',
+
'action=wbremoveclaims&claim=Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0N&token=foobar&baserevid=7201010'
=> 'apihelp-wbremoveclaims-example-1',
);
}
diff --git a/repo/includes/api/RemoveQualifiers.php
b/repo/includes/api/RemoveQualifiers.php
index b08391e..0000f0f 100644
--- a/repo/includes/api/RemoveQualifiers.php
+++ b/repo/includes/api/RemoveQualifiers.php
@@ -148,46 +148,14 @@
}
/**
- * @see \ApiBase::getParamDescription
- *
- * @since 0.3
+ * @see ApiBase::getExamplesMessages()
*
* @return array
*/
- public function getParamDescription() {
- return array_merge(
- parent::getParamDescription(),
- array(
- 'claim' => 'A GUID identifying the claim from
which to remove qualifiers',
- 'qualifiers' => 'Snak hashes of the qualifiers
to remove',
- )
- );
- }
-
- /**
- * @see \ApiBase::getDescription
- *
- * @since 0.3
- *
- * @return string
- */
- public function getDescription() {
+ protected function getExamplesMessages() {
return array(
- 'API module for removing a qualifier from a claim.'
- );
- }
-
- /**
- * @see \ApiBase::getExamples
- *
- * @since 0.3
- *
- * @return array
- */
- protected function getExamples() {
- return array(
-
'api.php?action=wbremovequalifiers&statement=Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F&references=1eb8793c002b1d9820c833d234a1b54c8e94187e&token=foobar&baserevid=7201010'=>
- 'Remove qualifier with hash
"1eb8793c002b1d9820c833d234a1b54c8e94187e" from claim with GUID of
"Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F"',
+
'action=wbremovequalifiers&statement=Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F&references=1eb8793c002b1d9820c833d234a1b54c8e94187e&token=foobar&baserevid=7201010'=>
+ 'apihelp-wbremovequalifiers-example-1',
);
}
diff --git a/repo/includes/api/RemoveReferences.php
b/repo/includes/api/RemoveReferences.php
index 33a579d..02bed42 100644
--- a/repo/includes/api/RemoveReferences.php
+++ b/repo/includes/api/RemoveReferences.php
@@ -152,45 +152,13 @@
}
/**
- * @see ApiBase::getParamDescription
- *
- * @since 0.3
+ * @see ApiBase::getExamplesMessages()
*
* @return array
*/
- public function getParamDescription() {
- return array_merge(
- parent::getParamDescription(),
- array(
- 'statement' => 'A GUID identifying the
statement for which a reference is being set',
- 'references' => 'The hashes of the references
that should be removed',
- )
- );
- }
-
- /**
- * @see ApiBase::getDescription
- *
- * @since 0.3
- *
- * @return string
- */
- public function getDescription() {
+ protected function getExamplesMessages() {
return array(
- 'API module for removing one or more references of the
same statement.'
- );
- }
-
- /**
- * @see ApiBase::getExamples
- *
- * @since 0.3
- *
- * @return array
- */
- protected function getExamples() {
- return array(
-
'api.php?action=wbremovereferences&statement=Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F&references=455481eeac76e6a8af71a6b493c073d54788e7e9&token=foobar&baserevid=7201010'
=> 'Remove reference with hash "455481eeac76e6a8af71a6b493c073d54788e7e9" from
claim with GUID of "Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F"',
+
'action=wbremovereferences&statement=Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F&references=455481eeac76e6a8af71a6b493c073d54788e7e9&token=foobar&baserevid=7201010'
=> 'apihelp-wbremovereferences-example-1',
);
}
diff --git a/repo/includes/api/SearchEntities.php
b/repo/includes/api/SearchEntities.php
index d09863d..2a464d4 100644
--- a/repo/includes/api/SearchEntities.php
+++ b/repo/includes/api/SearchEntities.php
@@ -354,35 +354,15 @@
}
/**
- * @see ApiBase::getParamDescription
+ * @see ApiBase::getExamplesMessages()
+ *
+ * @return array
*/
- public function getParamDescription() {
+ protected function getExamplesMessages() {
return array(
- 'search' => 'Search for this text.',
- 'language' => 'Search in this language.',
- 'type' => 'Search for this type of entity.',
- 'limit' => 'Maximal number of results',
- 'continue' => 'Offset where to continue a search',
- );
- }
-
- /**
- * @see ApiBase::getDescription
- */
- public function getDescription() {
- return array(
- 'API module to search for entities.'
- );
- }
-
- /**
- * @see ApiBase::getExamples
- */
- protected function getExamples() {
- return array(
-
'api.php?action=wbsearchentities&search=abc&language=en' => 'Search for "abc"
in English language, with defaults for type and limit',
-
'api.php?action=wbsearchentities&search=abc&language=en&limit=50' => 'Search
for "abc" in English language with a limit of 50',
-
'api.php?action=wbsearchentities&search=alphabet&language=en&type=property' =>
'Search for "alphabet" in English language for type property',
+ 'action=wbsearchentities&search=abc&language=en' =>
'apihelp-wbsearchentities-example-1',
+
'action=wbsearchentities&search=abc&language=en&limit=50' =>
'apihelp-wbsearchentities-example-2',
+
'action=wbsearchentities&search=alphabet&language=en&type=property' =>
'apihelp-wbsearchentities-example-3',
);
}
diff --git a/repo/includes/api/SetAliases.php b/repo/includes/api/SetAliases.php
index 45b4303..3ed903c 100644
--- a/repo/includes/api/SetAliases.php
+++ b/repo/includes/api/SetAliases.php
@@ -217,48 +217,23 @@
}
/**
- * @see ApiBase::getParamDescription()
+ * @see ApiBase::getExamplesMessages()
+ *
+ * @return array
*/
- public function getParamDescription() {
- return array_merge(
- parent::getParamDescription(),
- parent::getParamDescriptionForId(),
- parent::getParamDescriptionForSiteLink(),
- parent::getParamDescriptionForEntity(),
- array(
- 'add' => 'List of aliases to add (can be
combined with remove)',
- 'remove' => 'List of aliases to remove (can be
combined with add)',
- 'set' => 'A list of aliases that will replace
the current list (can not be combined with neither add nor remove)',
- 'language' => 'The language of which to set the
aliases',
- )
- );
- }
-
- /**
- * @see ApiBase::getDescription()
- */
- public function getDescription() {
+ protected function getExamplesMessages() {
return array(
- 'API module to set the aliases for a Wikibase entity.'
- );
- }
+ 'action=wbsetaliases&language=en&id=Q1&set=Foo|Bar'
+ => 'apihelp-wbsetaliases-example-1',
- /**
- * @see ApiBase::getExamples()
- */
- protected function getExamples() {
- return array(
-
'api.php?action=wbsetaliases&language=en&id=Q1&set=Foo|Bar'
- => 'Set the English aliases for the entity with
id Q1 to Foo and Bar',
+ 'action=wbsetaliases&language=en&id=Q1&add=Foo|Bar'
+ => 'apihelp-wbsetaliases-example-2',
-
'api.php?action=wbsetaliases&language=en&id=Q1&add=Foo|Bar'
- => 'Add Foo and Bar to the list of English
aliases for the entity with id Q1',
+ 'action=wbsetaliases&language=en&id=Q1&remove=Foo|Bar'
+ => 'apihelp-wbsetaliases-example-3',
-
'api.php?action=wbsetaliases&language=en&id=Q1&remove=Foo|Bar'
- => 'Remove Foo and Bar from the list of English
aliases for the entity with id Q1',
-
-
'api.php?action=wbsetaliases&language=en&id=Q1&remove=Foo&add=Bar'
- => 'Remove Foo from the list of English aliases
for the entity with id Q1 while adding Bar to it',
+
'action=wbsetaliases&language=en&id=Q1&remove=Foo&add=Bar'
+ => 'apihelp-wbsetaliases-example-4',
);
}
--
To view, visit https://gerrit.wikimedia.org/r/178080
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I742729f002bd58a816a86b6137f7c5d68ab1915e
Gerrit-PatchSet: 9
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Sn1per <[email protected]>
Gerrit-Reviewer: Addshore <[email protected]>
Gerrit-Reviewer: Anomie <[email protected]>
Gerrit-Reviewer: Aude <[email protected]>
Gerrit-Reviewer: Hoo man <[email protected]>
Gerrit-Reviewer: Legoktm <[email protected]>
Gerrit-Reviewer: Siebrand <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
