Browse Source

More settings - bigger readme

Have a look for examples of NavWrapperType
ardiman 11 years ago
parent
commit
92a4cb9054
1 changed files with 27 additions and 2 deletions
  1. 27 2
      README.md

+ 27 - 2
README.md

@@ -33,15 +33,40 @@ To activate Foreground for all users and anonymous visitors, you need to set the
 Use following features in `LocalSettings.php` to change the behavior. 
 
 - `showActionsForAnon => true` displays page actions for non-logged-in visitors.
-- `makeNavFixed => true` menu will be fixed on top. 
+- `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".
+- `IeEdgeCode => 1` will produce a meta tag with "X-UA-Compatible" content="IE=edge", `2` will sent a header, `0` nothing will be done
 
 These are the default values:
 
     $wgForegroundFeatures = array(
       'showActionsForAnon' => true,
-      'makeNavFixed' => false,
+      'NavWrapperType' => 'divonly',
+      'showHelpUnderTools' => true,
+      'showRecentChangesUnderTools' => true,
+      'IeEdgeCode' => 1
     );
 
+### Usage of NavWrapperType
+
+With a setting like:
+
+    'NavWrapperType' => 'divonly'
+
+and the created div called `navwrapper` anonymous visitors can change the setting of navbar (fixed or sticky) by 
+User-Script (Firefox-extensions like greasemonkey or scriptish), users can take a gadget or their JavaScript, CSS ... :
+
+    $('#navwrapper').addClass('sticky');
+
+
+Or you set class in LocalSettings.php with:
+
+    'NavWrapperType' => 'contain-to-grid fixed'
+
+and visitors will be able to remove this class by their own JavaScript or gadget ...
+
+
 ### Notes on other skins
 
 As you build a wiki out with Foreground you will likely use the responsive grid from Foundation. This is key to making a responsive wiki, and is one of the largest _migration_ requirements when you want to move a wiki that ppreviously used Vector (and likely a lot of tables for layout) to Foreground. Once you do this, the ability of a user to select whatever skin will be removed. If you take full advantage of Foreground in your templates the lack of the Foundation grid will make viewing the wiki using [Vector](http://wikiapiary.com/wiki/Skin:Vector) or [MonoBook](http://wikiapiary.com/wiki/Skin:MonoBook) very difficult.