https://bugzilla.wikimedia.org/show_bug.cgi?id=34313
Web browser: ---
Bug #: 34313
Summary: MediaWiki API intro message about "HTML format" should
mention format parameter
Product: MediaWiki
Version: unspecified
Platform: All
OS/Version: All
Status: NEW
Severity: normal
Priority: Unprioritized
Component: API
AssignedTo: [email protected]
ReportedBy: [email protected]
CC: [email protected], [email protected],
[email protected], [email protected]
Classification: Unclassified
At a URL like <https://en.wikipedia.org/w/api.php?action=query&list=blocks>,
the API currently says:
---
You are looking at the HTML representation of the XML format.
HTML is good for debugging, but probably is not suitable for your application.
See [complete documentation], or [API help] for more information.
---
I think this blurb should mention the format parameter. I think it's
non-obvious that the default format is xmlfm. Maybe even mention the format
parameter with a more direct link to the section of the documentation about the
format parameter. But nobody wants a wall of text of documentation. They just
want to know how to make the output _not_ the HTML format.
Also, I think the language "probably is not suitable for your application"
should be toughened up (remove the "probably"), but I'm too lazy to file a
separate bug.
Ideally the language would be something like...
---
You are looking at the HTML representation of the XML format.
HTML is good for debugging, but is unsuitable for application use.
Specify the [format parameter] to change the output format.
Please see the [complete documentation] or [API help] for more information.
---
--
Configure bugmail: https://bugzilla.wikimedia.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.
You are on the CC list for the bug.
_______________________________________________
Wikibugs-l mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/wikibugs-l
