Last modified: 2014-06-12 20:29:29 UTC
The current documentation for action=featuredfeeds reads: --- * action=featuredfeed * Returns a user contributions feed This module requires read rights Parameters: feedformat - The format of the feed One value: rss, atom Default: rss feed - Feed name This parameter is required One value: language - Feed language code. Ignored by some feeds. Examples: Retrieve feed `featured' api.php?action=featuredfeed&feed=featured --- I find this documentation incredibly confusing. First, "Returns a user contributions feed". Is this true? You're not inputting a username or user ID to get a list of contributions, so this seems to be at least misleading. Second, the "feed" parameter is associated with some kind of magical "Feed name". It's a required parameter without a default (apparently) and the possible values are... null (though it only takes one!). Third, the "language" parameter doesn't specify what kind of language code you're looking for. Two letters? Three letters? The example also doesn't really make much sense to me, though perhaps I'm just being thick.
(In reply to comment #0) > Third, the "language" parameter doesn't specify what kind of language code > you're looking for. Two letters? Three letters? As this is technical documentation, if there's a technical answer here (such as ISO-639-2 or ISO-639-3 or whatever), you can say so. :-) You can also cross-reference to some other list of language codes if possible (maybe they're exposed in action=sitematrix or elsewhere?).
(In reply to comment #0) > Third, the "language" parameter doesn't specify what kind of language code > you're looking for. Two letters? Three letters? How many letters are there in "zh-min-nan"? > As this is technical documentation, if there's a technical answer here (such as > ISO-639-2 or ISO-639-3 or whatever), you can say so. :-) You can also > cross-reference to some other list of language codes if possible (maybe they're > exposed in action=sitematrix or elsewhere?). And which of them standardises "simple" or "be-x-old"? We have *MediaWiki* language codes and nothing else, now matter how much we pretend that it's not the case.
(In reply to comment #2) > (In reply to comment #0) > > Third, the "language" parameter doesn't specify what kind of language code > > you're looking for. Two letters? Three letters? > > How many letters are there in "zh-min-nan"? > > > As this is technical documentation, if there's a technical answer here (such as > > ISO-639-2 or ISO-639-3 or whatever), you can say so. :-) You can also > > cross-reference to some other list of language codes if possible (maybe they're > > exposed in action=sitematrix or elsewhere?). > > And which of them standardises "simple" or "be-x-old"? > > We have *MediaWiki* language codes and nothing else, now matter how much we > pretend that it's not the case. Okay, so is there a way to list "MediaWiki language codes"? The current documentation reads kind of like magic. People need to be able to read it and figure out what you mean by language codes. Provide documentation or cross-reference to list=mediawikilanguagecodes or something, right?
(In reply to comment #0) > First, "Returns a user contributions feed". Is this true? You're not inputting > a username or user ID to get a list of contributions, so this seems to be at > least misleading. r113021 > Second, the "feed" parameter is associated with some kind of magical "Feed > name". It's a required parameter without a default (apparently) and the > possible values are... null (though it only takes one!). It shows only feeds actually available and set up on site. > The example also doesn't really make much sense to me, though perhaps I'm just > being thick. On wikis with no feeds set up it indeed doesn't work. Just like examples for prop will fail if pages they mention don't exist.
Prioritization and scheduling of this bug is tracked on Trello card https://trello.com/c/CAnlNLT8
