API: mention how to get page property names
authorS Page <spage@wikimedia.org>
Mon, 13 Jul 2015 19:54:38 +0000 (12:54 -0700)
committerBrad Jorsch <bjorsch@wikimedia.org>
Thu, 1 Oct 2015 14:06:25 +0000 (10:06 -0400)
Mention action=query&list=pagepropnames to get a list of properties in
use.
Also rephrase apihelp-main-param-uselang to use active voice.

To test, visit
  api.php?action=help
  api.php?action=help&modules=query%2Bpagepropnames
  api.php?action=help&modules=query%2Bpageswithprop

Change-Id: Ic13f6c00396aed1a1c016bfcf6a39d621a4ebc06

includes/api/i18n/en.json

index 009cc7b..30182c1 100644 (file)
@@ -17,7 +17,7 @@
        "apihelp-main-param-servedby": "Include the hostname that served the request in the results.",
        "apihelp-main-param-curtimestamp": "Include the current timestamp in the result.",
        "apihelp-main-param-origin": "When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body). This must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like <kbd>https://en.wikipedia.org</kbd> or <kbd>https://meta.wikimedia.org</kbd>. If this parameter does not match the <code>Origin</code> header, a 403 response will be returned. If this parameter matches the <code>Origin</code> header and the origin is whitelisted, an <code>Access-Control-Allow-Origin</code> header will be set.",
-       "apihelp-main-param-uselang": "Language to use for message translations. A list of codes may be fetched from <kbd>[[Special:ApiHelp/query+siteinfo|action=query&meta=siteinfo]]</kbd> with <kbd>siprop=languages</kbd>, or specify <kbd>user</kbd> to use the current user's language preference, or specify <kbd>content</kbd> to use this wiki's content language.",
+       "apihelp-main-param-uselang": "Language to use for message translations. <kbd>[[Special:ApiHelp/query+siteinfo|action=query&meta=siteinfo]]</kbd> with <kbd>siprop=languages</kbd> returns a list of language codes, or specify <kbd>user</kbd> to use the current user's language preference, or specify <kbd>content</kbd> to use this wiki's content language.",
 
        "apihelp-block-description": "Block a user.",
        "apihelp-block-param-user": "Username, IP address, or IP range to block.",
        "apihelp-query+pagepropnames-param-limit": "The maximum number of names to return.",
        "apihelp-query+pagepropnames-example-simple": "Get first 10 property names.",
 
-       "apihelp-query+pageprops-description": "Get various properties defined in the page content.",
-       "apihelp-query+pageprops-param-prop": "Only list these props. Useful for checking whether a certain page uses a certain page prop.",
+       "apihelp-query+pageprops-description": "Get various page properties defined in the page content.",
+       "apihelp-query+pageprops-param-prop": "Only list these page properties (<kbd>[[Special:ApiHelp/query+pagepropnames|action=query&list=pagepropnames]]</kbd> returns page property names in use). Useful for checking whether pages use a certain page property.",
        "apihelp-query+pageprops-example-simple": "Get properties for the pages <kbd>Main Page</kbd> and <kbd>MediaWiki</kbd>.",
 
        "apihelp-query+pageswithprop-description": "List all pages using a given page property.",
-       "apihelp-query+pageswithprop-param-propname": "Page prop for which to enumerate pages.",
+       "apihelp-query+pageswithprop-param-propname": "Page property for which to enumerate pages (<kbd>[[Special:ApiHelp/query+pagepropnames|action=query&list=pagepropnames]]</kbd> returns page property names in use).",
        "apihelp-query+pageswithprop-param-prop": "Which pieces of information to include:",
        "apihelp-query+pageswithprop-paramvalue-prop-ids": "Adds the page ID.",
        "apihelp-query+pageswithprop-paramvalue-prop-title": "Adds the title and namespace ID of the page.",
-       "apihelp-query+pageswithprop-paramvalue-prop-value": "Adds the value of the page prop.",
+       "apihelp-query+pageswithprop-paramvalue-prop-value": "Adds the value of the page property.",
        "apihelp-query+pageswithprop-param-limit": "The maximum number of pages to return.",
        "apihelp-query+pageswithprop-param-dir": "In which direction to sort.",
        "apihelp-query+pageswithprop-example-simple": "List the first 10 pages using <code>&#123;&#123;DISPLAYTITLE:&#125;&#125;</code>.",