浏览代码

Draft of changes and use of new features

Tom Hutchison 10 年之前
父节点
当前提交
b8f90d9522
共有 1 个文件被更改,包括 30 次插入2 次删除
  1. 30 2
      README.md

+ 30 - 2
README.md

@@ -36,16 +36,24 @@ Use following features in `LocalSettings.php` to change the behavior.
 - `NavWrapperType => 'divonly'`: only a div with id `navwrapper` will be created. `'0'` - no div will be created (old behavior), other values will be used as class. 
 - `showHelpUnderTools => true` a Link to "Help" will be created under "Tools".
 - `showRecentChangesUnderTools => true` a Link to "recent changes" will be created under "Tools".
+- `wikiName => 'Alternate WikiName'` sets top navbar name to a different output of the wiki's name. Useful if your `$wgSitename` is long but need to keep it for other purposes.
+- `navbarIcon => true` to display an icon in the top navbar. See below for more information.
 - `IeEdgeCode => 1` will produce a meta tag with "X-UA-Compatible" content="IE=edge", `2` will sent a header, `0` nothing will be done
+- `showFooterIcons => 0 suppresses the output of footer icons. Set to `true` or `1` to display them.
+- `addThisFollowPUBID => 'your-id'` add an id to display Follow Us horizontal bar of icons from various social media sites available on [addThis](http://addthis.com).
 
 These are the default values:
 
-    $wgForegroundFeatures = array(
+    $wgForegroundFeaturesDefaults = array(      
       'showActionsForAnon' => true,
       'NavWrapperType' => 'divonly',
       'showHelpUnderTools' => true,
       'showRecentChangesUnderTools' => true,
-      'IeEdgeCode' => 1
+      'wikiName' => &$GLOBALS['wgSitename'],
+      'navbarIcon' => false,
+      'IeEdgeCode' => 1,
+      'showFooterIcons' => 0,
+      'addThisFollowPUBID' => ''
     );
 
 ### Usage of NavWrapperType
@@ -66,6 +74,26 @@ Or you set class in LocalSettings.php with:
 
 and visitors will be able to remove this class by their own JavaScript or gadget ...
 
+### Navbar Icon
+
+With a setting like:
+
+    'navbarIcon' => true
+
+A top navbar icon will be set using the current image set by `$wgLogo` in `LocalSettings.php`. See http://www.mediawiki.org/wiki/Manual:$wgLogo for more information about `$wgLogo`.
+
+The icon will be resized to fit into a maximum width of 64px x 36px wide or a 16:9 ratio.
+
+### AddThis Buttons
+
+With a setting like:
+
+    'addThisFollowPUBID' => 'yourAddThis-PubID'
+
+Important, this feature uses the free or paid version of the http://addthis.com horizontal Follow Buttons only. Choose which social media FollowUs buttons(Twitter, Facebook, YouTube, etc.) and at the bottom of the screen locate the script. Within the script you will see something similar `...#pubid=ra-5378f4902d02197">`. Everything after the `=` sign is up to the `">` is your Publisher ID. To turn on social follow icons, insert your publisher id:
+
+    'addThisFollowPUBID' => 'ra-5378f4902d02197'
+
 
 ### Notes on other skins