Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
wiki.techinc.nl/includes/api
History
Brad Jorsch df457f3809 API: HTMLize and internationalize the help, add Special:ApiHelp 
The existing API help, formatted as basically a plain-text document
embedded in XML and with a little bolding and a few links
syntax-highlighted in after the fact, works ok for experienced programmers
but isn't at all newbie-friendly. Further, all the help is hard-coded in
English, which isn't very friendly to non-English speakers.

So let's rewrite it. The help text is now obtained from i18n messages
and output in HTML, with the default display consisting of help for a
single module with links to help for other modules. This, of course,
necessitates deprecating many of the existing help-related methods and
hooks and replacing them with new ones, but backwards compatibility is
maintained for almost everything.

At the same time, action=paraminfo also needs to support the
'description' and other help-related fields being output in wikitext or
HTML, and I11cb063d (to access all modules via the 'modules' parameter
instead of having 'modules', 'formatmodules', 'querymodules', and so on)
is folded in.

And we also add Special:ApiHelp. When directly accessed, it simply
redirects to api.php with appropriate parameters. But it's also
transcludable to allow up-to-date API help text to be included within
the on-wiki documentation.

Note this patch doesn't actually add i18n messages for any API modules
besides ApiMain and ApiHelp. That will come in a followup patch, but for
the moment the backwards-compatibility code handles them nicely.

While we're messing with the documentation, we may as well add the
"internal" flag requested in bug 62905 (although the 'includeinternal'
parameter it also requests doesn't make much sense anymore) and a
"deprecated" flag that's needed by several modules now.

Bug: 30936
Bug: 38126
Bug: 42343
Bug: 45641
Bug: 62905
Bug: 63211
Change-Id: Ib14c00df06d85c2f6364d83b2b10ce34c7f513cc
2014-10-10 10:46:39 -04:00
..
i18n API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiBase.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiBlock.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiClearHasMsg.php API: created a new api to flag messages as read 2014-09-06 21:26:40 +00:00
ApiComparePages.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiCreateAccount.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiDelete.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiDisabled.php Add final period to API module descriptions 2014-03-10 09:04:08 +00:00
ApiEditPage.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiEmailUser.php SpecialEmailUser: Use Config instead of globals 2014-09-12 23:39:59 -07:00
ApiExpandTemplates.php API: Log usage of various deprecated features 2014-08-14 16:51:14 -07:00
ApiFeedContributions.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiFeedRecentChanges.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiFeedWatchlist.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiFileRevert.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiFormatBase.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiFormatDbg.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiFormatDump.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiFormatFeedWrapper.php API: Organize classes 2014-08-27 16:39:24 -04:00
ApiFormatJson.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiFormatNone.php api: remove duplicate __contruct calls 2013-01-29 09:38:17 +01:00
ApiFormatPhp.php api: remove duplicate __contruct calls 2013-01-29 09:38:17 +01:00
ApiFormatRaw.php Use precise ApiMain/ApiQuery type hints in all API modules 2014-05-16 11:07:23 -04:00
ApiFormatTxt.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiFormatWddx.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiFormatXml.php Restructure output of ApiExpandTemplates 2014-06-03 16:25:08 -04:00
ApiFormatYaml.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiHelp.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiImageRotate.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiImport.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiLogin.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiLogout.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiMain.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiModuleManager.php Add ApiModuleManager::getClassName() 2014-09-08 02:06:33 -07:00
ApiMove.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiOpenSearch.php Switch API to use Config classes 2014-06-15 23:56:38 +01:00
ApiOptions.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiPageSet.php Cleanup - let's make IDEs more useful 2014-08-13 16:02:59 -04:00
ApiParamInfo.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiParse.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiPatrol.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiProtect.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiPurge.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQuery.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiQueryAllCategories.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryAllImages.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryAllLinks.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryAllMessages.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryAllPages.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryAllUsers.php API: Add timestamp of block to blockinfo 2014-09-14 20:02:04 -03:00
ApiQueryBacklinks.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryBacklinksprop.php API: Add prop modules for backlinks 2014-09-18 17:04:42 -04:00
ApiQueryBase.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiQueryBlocks.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryCategories.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryCategoryInfo.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryCategoryMembers.php API: Deprecate binary sortkey input in ApiQueryCategoryMembers 2014-09-11 10:46:33 -04:00
ApiQueryContributors.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryDeletedrevs.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiQueryDisabled.php Add final period to API module descriptions 2014-03-10 09:04:08 +00:00
ApiQueryDuplicateFiles.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryExternalLinks.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryExtLinksUsage.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryFilearchive.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryFileRepoInfo.php Use precise ApiMain/ApiQuery type hints in all API modules 2014-05-16 11:07:23 -04:00
ApiQueryImageInfo.php Merge "Do not require iiurlwidth when getting thumbnails." 2014-09-18 17:48:00 +00:00
ApiQueryImages.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryInfo.php APIQueryInfo: Allow fetching the canonical url of a page 2014-09-05 03:20:27 -07:00
ApiQueryIWBacklinks.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryIWLinks.php API: Add iwprop=url, deprecate iwurl for prop=iwlinks 2014-08-20 09:40:01 -04:00
ApiQueryLangBacklinks.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryLangLinks.php API: Log usage of various deprecated features 2014-08-14 16:51:14 -07:00
ApiQueryLinks.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryLogEvents.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryORM.php Update formatting, return of the API classes 2013-11-14 18:25:45 +00:00
ApiQueryPagePropNames.php Use precise ApiMain/ApiQuery type hints in all API modules 2014-05-16 11:07:23 -04:00
ApiQueryPageProps.php Use precise ApiMain/ApiQuery type hints in all API modules 2014-05-16 11:07:23 -04:00
ApiQueryPagesWithProp.php Use precise ApiMain/ApiQuery type hints in all API modules 2014-05-16 11:07:23 -04:00
ApiQueryPrefixSearch.php Pass phpcs-strict on various files in includes/ 2014-04-24 21:50:01 +02:00
ApiQueryProtectedTitles.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryQueryPage.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryRandom.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryRecentChanges.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiQueryRevisions.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiQuerySearch.php Properly deprecate srprop=score|hasrelated 2014-09-12 09:29:18 -07:00
ApiQuerySiteinfo.php Allow callback functions for creating SpecialPages. 2014-09-18 14:47:34 +02:00
ApiQueryStashImageInfo.php API: Log usage of various deprecated features 2014-08-14 16:51:14 -07:00
ApiQueryTags.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryTokens.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiQueryUserContributions.php API: Log usage of various deprecated features 2014-08-14 16:51:14 -07:00
ApiQueryUserInfo.php API: Add timestamp of block to blockinfo 2014-09-14 20:02:04 -03:00
ApiQueryUsers.php API: Add timestamp of block to blockinfo 2014-09-14 20:02:04 -03:00
ApiQueryWatchlist.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiQueryWatchlistRaw.php API: Remove action=paraminfo 'props' and 'errors' result properties 2014-08-07 16:51:19 +01:00
ApiResult.php Cleanup - let's make IDEs more useful 2014-08-13 16:02:59 -04:00
ApiRevisionDelete.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiRollback.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiRsd.php Use precise ApiMain/ApiQuery type hints in all API modules 2014-05-16 11:07:23 -04:00
ApiSetNotificationTimestamp.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiTokens.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00
ApiUnblock.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiUndelete.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiUpload.php Chunked upload result should consistently have a "stage" value for "Poll" 2014-09-08 08:05:44 +02:00
ApiUserrights.php API: Overhaul token handling 2014-08-26 14:53:45 -04:00
ApiWatch.php API: HTMLize and internationalize the help, add Special:ApiHelp 2014-10-10 10:46:39 -04:00