Update documentation for $wgExtensionMessagesFiles
authorKevin Israel <pleasestand@live.com>
Thu, 17 Apr 2014 20:46:56 +0000 (16:46 -0400)
committerKevin Israel <pleasestand@live.com>
Thu, 17 Apr 2014 20:46:56 +0000 (16:46 -0400)
Follows-up e0043257c02e.

Change-Id: Id8212fca83fde09a89891ead1e0a107ff0d66398

includes/DefaultSettings.php

index 6c6c3f0..c0c2e22 100644 (file)
@@ -5979,13 +5979,13 @@ $wgExtensionFunctions = array();
  *
  * Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store
  * messages in JSON format and use $wgMessagesDirs. For setting other variables than
- * $messages, $wgExtensionMessagesFiles should still be used.
+ * $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because
+ * any entry having a key that also exists in $wgMessagesDirs will be ignored.
  *
- * If there is an entry in $wgMessagesDirs with the same key as one in
- * $wgExtensionMessagesFiles, then any $messages variables set in the $wgExtensionMessagesFiles file
- * will be ignored. This means an extension that only provides messages can be backwards compatible
- * by using both $wgExtensionMessagesFiles and $wgMessagesDirs, and only one of the two
- * will be used depending on what the version of MediaWiki supports.
+ * Extensions using the JSON message format can preserve backward compatibility with
+ * earlier versions of MediaWiki by using a compatibility shim, such as one generated
+ * by the generateJsonI18n.php maintenance script, listing it under the SAME key
+ * as for the $wgMessagesDirs entry.
  *
  * @par Example:
  * @code