From a03e2a48d50ad2b4b975e28a5ee5451ae72bb04c Mon Sep 17 00:00:00 2001
From: Aryeh Gregor <simetrical@users.mediawiki.org>
Date: Fri, 4 Jan 2008 13:58:40 +0000
Subject: [PATCH] Improve clarity of error message when no text is given for a
 reference.

---
 Cite.i18n.php       |  2 +-
 Cite.php            | 16 ++++++++++------
 citeParserTests.txt |  4 ++--
 3 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/Cite.i18n.php b/Cite.i18n.php
index a5bcba83b..d19d19af4 100644
--- a/Cite.i18n.php
+++ b/Cite.i18n.php
@@ -27,7 +27,7 @@ $messages['en'] = array(
 <code>&lt;references /&gt;</code>',
 	'cite_error_references_invalid_parameters' => 'Invalid <code>&lt;references&gt;</code> tag; no parameters are allowed, use <code>&lt;references /&gt;</code>',
 	'cite_error_references_no_backlink_label'  => "Ran out of custom backlink labels, define more in the \"''cite_references_link_many_format_backlink_labels''\" message",
-	'cite_error_references_no_text'            => 'No text given.',
+	'cite_error_references_no_text'            => 'Invalid <code>&lt;ref&gt;</code> tag; no text was provided for refs named <code>$1</code>',
 
 	/*
 	   Output formatting
diff --git a/Cite.php b/Cite.php
index 636a797c7..0f48b1f20 100644
--- a/Cite.php
+++ b/Cite.php
@@ -353,7 +353,7 @@ function wfCite() {
 						'cite_references_link_one',
 						$this->referencesKey( $key ),
 						$this->refKey( $key, $val['count'] ),
-						$this->error( 'cite_error_references_no_text' )
+						$this->error( 'cite_error_references_no_text', $key )
 					);
 			// Standalone named reference, I want to format this like an
 			// anonymous reference because displaying "1. 1.1 Ref text" is
@@ -365,7 +365,7 @@ function wfCite() {
 						'cite_references_link_one',
 						$this->referencesKey( $key ),
 						$this->refKey( $key, $val['count'] ),
-						( $val['text'] != '' ? $val['text'] : $this->error( 'cite_error_references_no_text' ) )
+						( $val['text'] != '' ? $val['text'] : $this->error( 'cite_error_references_no_text', $key ) )
 					);
 			// Named references with >1 occurrences
 			else {
@@ -386,7 +386,7 @@ function wfCite() {
 					wfMsgForContentNoTrans( 'cite_references_link_many',
 						$this->referencesKey( $key ),
 						$list,
-						( $val['text'] != '' ? $val['text'] : $this->error( 'cite_error_references_no_text' ) )
+						( $val['text'] != '' ? $val['text'] : $this->error( 'cite_error_references_no_text', $key ) )
 					);
 			}
 		}
@@ -619,14 +619,18 @@ function wfCite() {
 		/**
 		 * Return an error message based on an error ID
 		 *
-		 * @param string $key Message name for the error
+		 * @param string $key   Message name for the error
+		 * @param string $param Parameter to pass to the message
 		 * @return string XHTML ready for output
 		 */
-		function error( $key ) {
+		function error( $key, $param=null ) {
+			# We rely on the fact that PHP is okay with passing unused argu-
+			# ments to functions.  If $1 is not used in the message, wfMsg will
+			# just ignore the extra parameter.
 			return 
 				$this->parse(
 					'<strong class="error">' .
-					wfMsg( 'cite_error', wfMsg( $key ) ) .
+					wfMsg( 'cite_error', wfMsg( $key, $param ) ) .
 					'</strong>'
 				);
 		}
diff --git a/citeParserTests.txt b/citeParserTests.txt
index 1177a510f..8b6f72a2c 100644
--- a/citeParserTests.txt
+++ b/citeParserTests.txt
@@ -236,8 +236,8 @@ Erroneous refs
 </p><p><strong class="error">Cite error: Invalid <code>&lt;references&gt;</code> tag; no parameters are allowed, use <code>&lt;references /&gt;</code></strong>
 </p>
 <ol class="references"><li id="_note-0"><a href="#_ref-0" title="">↑</a> Also zero, but differently! (Normal ref)</li>
-<li id="_note-bar"><a href="#_ref-bar_0" title="">↑</a> <strong class="error">Cite error: No text given.</strong></li>
-<li id="_note-blankwithnoreference"><a href="#_ref-blankwithnoreference_0" title="">↑</a> <strong class="error">Cite error: No text given.</strong></li></ol>
+<li id="_note-bar"><a href="#_ref-bar_0" title="">↑</a> <strong class="error">Cite error: Invalid <code>&lt;ref&gt;</code> tag; no text was provided for refs named <code>bar</code></strong></li>
+<li id="_note-blankwithnoreference"><a href="#_ref-blankwithnoreference_0" title="">↑</a> <strong class="error">Cite error: Invalid <code>&lt;ref&gt;</code> tag; no text was provided for refs named <code>blankwithnoreference</code></strong></li></ol>
 
 !! end