Folowup r77763, add documentation for $wgFooterIcons.

diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php
index 0dc2d9f..4e948ab 100644 (file)
--- a/includes/DefaultSettings.php
+++ b/includes/DefaultSettings.php
@@ -2267,6 +2267,21 @@ $wgExperimentalHtmlIds = true;
  * You can add new icons to the built in copyright or poweredby, or you can create
  * a new block. Though note that you may need to add some custom css to get good styling
  * of new blocks in monobook. vector and modern should work without any special css.
+ * 
+ * $wgFooterIcons itself is a key/value array. The key being the name of a block that
+ * icons will be wrapped in. The final id varries by skin.
+ * The value being a key/value array of icons. The key may or may not be used by the
+ * skin but it can be used to find the icon and unset it or change the icon if needed.
+ * The innermost array has the following keys:
+ *   src: An absolute url to the image to use for the icon, this is recommended
+ *        but not required, however some skins will ignore icons without an image
+ *   url: The url to use in the <a> arround the text or icon, if not set an <a> will not be outputted
+ *   alt: This is the text form of the icon, it will be displayed without an image in
+ *        skins like Modern or if src is not set, and will otherwise be used as
+ *        the alt="" for the image. This key is required.
+ *   width and height: If the icon specified by src is not of the standard size
+ *                     you can specify the size of image to use with these keys.
+ *                     Otherwise they will default to the standard 88x31.
  */
 $wgFooterIcons = array(
        "copyright" => array(

diff --git a/includes/Skin.php b/includes/Skin.php
index 1aefb1b..59c89bb 100644 (file)
--- a/includes/Skin.php
+++ b/includes/Skin.php
@@ -1632,7 +1632,7 @@ class Skin extends Linker {
 
        /**
         * Renders a $wgFooterIcons icon acording to the method's arguments
-        * @param $icon Array: The icon to build the html for
+        * @param $icon Array: The icon to build the html for, see $wgFooterIcons for the format of this array
         * @param $withImage Boolean: Whether to use the icon's image or output a text-only footericon
         */
        function makeFooterIcon( $icon, $withImage = 'withImage' ) {