Siebrand has uploaded a new change for review.
https://gerrit.wikimedia.org/r/169534
Change subject: Sample of API documentation update
......................................................................
Sample of API documentation update
As discussed previously with Brad, for your consideration. I've done the
first 10% or so of the documentation. We should be able to discuss all the
different style and consistency updates I've applied that need discussing.
Once we reach some kind of consensus, I can update more messages.
Change-Id: Iaef77a14b2bc184ca28bac02087e67744d4573d4
---
M includes/api/i18n/en.json
1 file changed, 28 insertions(+), 28 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/34/169534/1
diff --git a/includes/api/i18n/en.json b/includes/api/i18n/en.json
index 2bec759..8f9c773 100644
--- a/includes/api/i18n/en.json
+++ b/includes/api/i18n/en.json
@@ -5,38 +5,38 @@
]
},
- "apihelp-main-description": "<div class=\"hlist plainlinks
api-main-links\">\n* [https://www.mediawiki.org/wiki/API:Main_page
Documentation]\n* [https://www.mediawiki.org/wiki/API:FAQ FAQ]\n*
[https://lists.wikimedia.org/mailman/listinfo/mediawiki-api Mailing list]\n*
[https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce API
Announcements]\n*
[https://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts
Bugs & requests]\n</div>\n<strong>Status:</strong> All features shown on this
page should be working, but the API is still in active development, and may
change at any time. Subscribe to
[https://lists.wikimedia.org/pipermail/mediawiki-api-announce/ the
mediawiki-api-announce mailing list] for notice of
updates.\n\n<strong>Erroneous requests:</strong> When erroneous requests are
sent to the API, a HTTP header will be sent with the key
\"MediaWiki-API-Error\" and then both the value of the header and the error
code sent back will be set to the same value. For more information see
https://www.mediawiki.org/wiki/API:Errors_and_warnings.";,
+ "apihelp-main-description": "<div class=\"hlist plainlinks
api-main-links\">\n* [https://www.mediawiki.org/wiki/API:Main_page
Documentation]\n* [https://www.mediawiki.org/wiki/API:FAQ FAQ]\n*
[https://lists.wikimedia.org/mailman/listinfo/mediawiki-api Mailing list]\n*
[https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce API
Announcements]\n*
[https://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts
Bugs & requests]\n</div>\n<strong>Status:</strong> All features shown on this
page should be working, but the API is still in active development, and may
change at any time. Subscribe to
[https://lists.wikimedia.org/pipermail/mediawiki-api-announce/ the
mediawiki-api-announce mailing list] for notice of
updates.\n\n<strong>Erroneous requests:</strong> When erroneous requests are
sent to the API, a HTTP header will be sent with the key
\"MediaWiki-API-Error\" and then both the value of the header and the error
code sent back will be set to the same value. For more information see
[https://www.mediawiki.org/wiki/API:Errors_and_warnings API: Errors and
warnings].",
"apihelp-main-param-action": "Which action to perform.",
"apihelp-main-param-format": "The format of the output.",
- "apihelp-main-param-maxlag": "Maximum lag can be used when MediaWiki is
installed on a database replicated cluster. To save actions causing any more
site replication lag, this parameter can make the client wait until the
replication lag is less than the specified value. In case of excessive lag,
error code \"maxlag\" is returned with a message like \"Waiting for $host: $lag
seconds lagged\".<br />See
https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information.",
- "apihelp-main-param-smaxage": "Set the s-maxage header to this many
seconds. Errors are never cached.",
- "apihelp-main-param-maxage": "Set the max-age header to this many
seconds. Errors are never cached.",
- "apihelp-main-param-assert": "Verify the user is logged in if set to
\"user\", or has the bot userright if \"bot\".",
+ "apihelp-main-param-maxlag": "Maximum lag can be used when MediaWiki is
installed on a database replicated cluster. To save actions causing any more
site replication lag, this parameter can make the client wait until the
replication lag is less than the specified value. In case of excessive lag,
error code \"<code>maxlag</code>\" is returned with a message like
\"<samp>Waiting for $host: $lag seconds lagged</samp>samp>\".<br />See
[https://www.mediawiki.org/wiki/Manual:Maxlag_parameter Manual: Maxlag
parameter] for more information.",
+ "apihelp-main-param-smaxage": "Set the <code>s-maxage</code>code>
header to this many seconds. Errors are never cached.",
+ "apihelp-main-param-maxage": "Set the <code>max-age</code>code> header
to this many seconds. Errors are never cached.",
+ "apihelp-main-param-assert": "Verify the user is logged in if set to
\"<var>user</var>\", or has the bot userright if \"<var>bot</var>\".",
"apihelp-main-param-requestid": "Any value given here will be included
in the response. May be used to distinguish requests.",
"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
Origin: header exactly, so it has to be set to something like
http://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does
not match the Origin: header, a 403 response will be returned. If this
parameter matches the Origin: header and the origin is whitelisted, an
Access-Control-Allow-Origin header will be set.",
- "apihelp-main-param-uselang": "Language to use for message
translations. A list of codes may be fetched from
[[Special:ApiHelp/query+siteinfo|action=query&meta=siteinfo&siprop=languages]],
or specify \"user\" to use the current user's language preference.",
+ "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
http://en.wikipedia.org or https://meta.wikimedia.org. 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
[[Special:ApiHelp/query+siteinfo|action=query&meta=siteinfo&siprop=languages]],
or specify \"<var>user</var>\" to use the current user's language preference.",
"apihelp-block-description": "Block a user.",
- "apihelp-block-param-user": "Username, IP address or IP range you want
to block.",
- "apihelp-block-param-expiry": "Expiry time. May be relative (e.g. \"5
months\" or \"2 weeks\") or absolute (e.g. \"2014-09-18T12:34:56Z\"). If set to
\"infinite\", \"indefinite\" or \"never\", the block will never expire.",
+ "apihelp-block-param-user": "Username, IP address or IP range to
block.",
+ "apihelp-block-param-expiry": "Expiry time. May be relative (e.g.
\"<samp>5 months</samp>\" or \"<samp>2 weeks</samp>\") or absolute (e.g.
\"<samp>2014-09-18T12:34:56Z</samp>\"). If set to \"<samp>infinite</samp>\",
\"<samp>indefinite</samp>\" or \"<samp>never</samp>\", the block will never
expire.",
"apihelp-block-param-reason": "Reason for block.",
- "apihelp-block-param-anononly": "Block anonymous users only (i.e.
disable anonymous edits for this IP).",
+ "apihelp-block-param-anononly": "Block anonymous users only (i.e.
disable anonymous edits for this IP address).",
"apihelp-block-param-nocreate": "Prevent account creation.",
"apihelp-block-param-autoblock": "Automatically block the last used IP
address, and any subsequent IP addresses they try to login from.",
- "apihelp-block-param-noemail": "Prevent user from sending email through
the wiki. (Requires the \"blockemail\" right).",
- "apihelp-block-param-hidename": "Hide the username from the block log.
(Requires the \"hideuser\" right).",
- "apihelp-block-param-allowusertalk": "Allow the user to edit their own
talk page (depends on $wgBlockAllowsUTEdit).",
+ "apihelp-block-param-noemail": "Prevent user from sending email through
the wiki. (Requires the \"<code>blockemail</code>\" right).",
+ "apihelp-block-param-hidename": "Hide the username from the block log.
(Requires the \"<code>hideuser</code>\" right).",
+ "apihelp-block-param-allowusertalk": "Allow the user to edit their own
talk page (depends on <var>$wgBlockAllowsUTEdit</var>).",
"apihelp-block-param-reblock": "If the user is already blocked,
overwrite the existing block.",
- "apihelp-block-param-watchuser": "Watch the user's or IP's user and
talk pages.",
- "apihelp-block-example-ip-simple": "Block IP 192.0.2.5 for three days
with reason \"First strike\"",
- "apihelp-block-example-user-complex": "Block user Vandal indefinitely
with reason \"Vandalism\", and prevent new account creation and email",
+ "apihelp-block-param-watchuser": "Watch the user's or IP address's user
and talk pages.",
+ "apihelp-block-example-ip-simple": "Block IP address 192.0.2.5 for
three days with reason \"<code>First strike</code>\"",
+ "apihelp-block-example-user-complex": "Block user <code>Vandal</code>
indefinitely with reason \"<code>Vandalism</code>\", and prevent new account
creation and email sending.",
- "apihelp-clearhasmsg-description": "Clears the hasmsg flag for current
user.",
- "apihelp-clearhasmsg-example-1": "Clear the hasmsg flag for current
user",
+ "apihelp-clearhasmsg-description": "Clears the <code>hasmsg</code> flag
for current user.",
+ "apihelp-clearhasmsg-example-1": "Clear the <code>hasmsg</code> flag
for current user.",
- "apihelp-compare-description": "Get the difference between 2
pages.\n\nYou must pass a revision number, a page title, or a page ID for both
\"from\" and \"to\".",
+ "apihelp-compare-description": "Get the difference between 2
pages.\n\nA revision number, a page title, or a page ID for both
\"<var>from</var>\" and \"<var>to</var>\" must be passed.",
"apihelp-compare-param-fromtitle": "First title to compare.",
"apihelp-compare-param-fromid": "First page ID to compare.",
"apihelp-compare-param-fromrev": "First revision to compare.",
@@ -47,7 +47,7 @@
"apihelp-createaccount-description": "Create a new user account.",
"apihelp-createaccount-param-name": "Username.",
- "apihelp-createaccount-param-password": "Password (ignored if
$1mailpassword is set).",
+ "apihelp-createaccount-param-password": "Password (ignored if
<var>$1mailpassword</var> is set).",
"apihelp-createaccount-param-domain": "Domain for external
authentication (optional).",
"apihelp-createaccount-param-token": "Account creation token obtained
in first request.",
"apihelp-createaccount-param-email": "Email address of user
(optional).",
@@ -55,19 +55,19 @@
"apihelp-createaccount-param-mailpassword": "If set to any value, a
random password will be emailed to the user.",
"apihelp-createaccount-param-reason": "Optional reason for creating the
account to be put in the logs.",
"apihelp-createaccount-param-language": "Language code to set as
default for the user (optional, defaults to content language).",
- "apihelp-createaccount-example-pass": "Create user \"testuser\" with
password \"test123\"",
- "apihelp-createaccount-example-mail": "Create user \"testmailuser\" and
email a randomly-generated password",
+ "apihelp-createaccount-example-pass": "Create user
\"<code>testuser</code>\" with password \"<code>test123</code>\"",
+ "apihelp-createaccount-example-mail": "Create user
\"<code>testmailuser</code>\" and email a randomly-generated password",
"apihelp-delete-description": "Delete a page.",
- "apihelp-delete-param-title": "Title of the page you want to delete.
Cannot be used together with $1pageid.",
- "apihelp-delete-param-pageid": "Page ID of the page you want to delete.
Cannot be used together with $1title.",
+ "apihelp-delete-param-title": "Title of the page to delete. Cannot be
used together with <var>$1pageid</var>.",
+ "apihelp-delete-param-pageid": "Page ID of the page to delete. Cannot
be used together with <var>$1title</var>.",
"apihelp-delete-param-reason": "Reason for the deletion. If not set, an
automatically generated reason will be used.",
- "apihelp-delete-param-watch": "Add the page to your watchlist.",
- "apihelp-delete-param-watchlist": "Unconditionally add or remove the
page from your watchlist, use preferences or do not change watch.",
- "apihelp-delete-param-unwatch": "Remove the page from your watchlist.",
+ "apihelp-delete-param-watch": "Add the page to the logged in user's
watchlist.",
+ "apihelp-delete-param-watchlist": "Unconditionally add or remove the
page from the logged in user's watchlist, use preferences or do not change
watch.",
+ "apihelp-delete-param-unwatch": "Remove the page from the logged in
user's watchlist.",
"apihelp-delete-param-oldimage": "The name of the old image to delete
as provided by
[[Special:ApiHelp/query+imageinfo|action=query&prop=imageinfo&iiprop=archivename]].",
"apihelp-delete-example-simple": "Delete the Main Page",
- "apihelp-delete-example-reason": "Delete the Main Page with the reason
\"Preparing for move\"",
+ "apihelp-delete-example-reason": "Delete the Main Page with the reason
\"<code>Preparing for move</code>\"",
"apihelp-disabled-description": "This module has been disabled.",
--
To view, visit https://gerrit.wikimedia.org/r/169534
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Iaef77a14b2bc184ca28bac02087e67744d4573d4
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Siebrand <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
