From 88c6d7b9a16bcd17a20363b623f86a04e7147737 Mon Sep 17 00:00:00 2001
From: Sam Reed <reedy@users.mediawiki.org>
Date: Fri, 10 Feb 2012 14:39:12 +0000
Subject: [PATCH] * (bug 34313) MediaWiki API intro message about "HTML format"
 should mention the format parameter.

---
 RELEASE-NOTES-1.20             | 2 ++
 includes/api/ApiFormatBase.php | 6 ++++--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/RELEASE-NOTES-1.20 b/RELEASE-NOTES-1.20
index 9150fad437..4d85e88fd8 100644
--- a/RELEASE-NOTES-1.20
+++ b/RELEASE-NOTES-1.20
@@ -25,6 +25,8 @@ production.
 
 === API changes in 1.20 ===
 * (bug 34316) Add ability to retrieve maximum upload size from MediaWiki API.
+* (bug 34313) MediaWiki API intro message about "HTML format" should mention
+  the format parameter.
 
 === Languages updated in 1.20 ===
 
diff --git a/includes/api/ApiFormatBase.php b/includes/api/ApiFormatBase.php
index 543c90ce08..57c641df56 100644
--- a/includes/api/ApiFormatBase.php
+++ b/includes/api/ApiFormatBase.php
@@ -163,8 +163,10 @@ abstract class ApiFormatBase extends ApiBase {
 <br />
 <small>
 You are looking at the HTML representation of the <?php echo( $this->mFormat ); ?> format.<br />
-HTML is good for debugging, but probably is not suitable for your application.<br />
-See <a href='https://www.mediawiki.org/wiki/API'>complete documentation</a>, or
+HTML is good for debugging, but is unsuitable for application use.<br />
+Specify the format parameter to change the output format.<br />
+To see the non HTML representation of the <?php echo( $this->mFormat ); ?> format, set format=<?php echo( $this->mFormat ); ?>.<br />
+See the <a href='https://www.mediawiki.org/wiki/API'>complete documentation</a>, or
 <a href='<?php echo( $script ); ?>'>API help</a> for more information.
 </small>
 <?php
-- 
2.20.1