Difference between revisions of "Configuration"

From Tweeki
Jump to: navigation, search
Line 5: Line 5:
 
=== Hiding Page Elements ===
 
=== Hiding Page Elements ===
  
<code><nowiki>$wgTweekiSkinHideAll = array();</nowiki></code>
+
$wgTweekiSkinHideAll = array();
 
:This variable can be used to hide elements from everybody. The [[#Tweekihide parser function|<nowiki>{{#tweekihide}}</nowiki> parser function]] will add to this array. Attention: Only hiding of elements that are also listed in <nowiki>$wgTweekiSkinHideable</nowiki> will actually be put into effect.
 
:This variable can be used to hide elements from everybody. The [[#Tweekihide parser function|<nowiki>{{#tweekihide}}</nowiki> parser function]] will add to this array. Attention: Only hiding of elements that are also listed in <nowiki>$wgTweekiSkinHideable</nowiki> will actually be put into effect.
  
<code><nowiki>$wgTweekiSkinHideable = array( 'firstHeading' );</nowiki></code>
+
$wgTweekiSkinHideable = array( 'firstHeading' );
 
:In order to prevent abuse, only elements listed in this array are allowed to be hidden by the [[#Tweekihide parser function|<nowiki>{{#tweekihide}}</nowiki> parser function]].
 
:In order to prevent abuse, only elements listed in this array are allowed to be hidden by the [[#Tweekihide parser function|<nowiki>{{#tweekihide}}</nowiki> parser function]].
  
<code><nowiki>$wgTweekiSkinHideAnon = array();</nowiki></code>
+
$wgTweekiSkinHideAnon = array();
 
:Elements in this array will be hidden for users who are not logged in.
 
:Elements in this array will be hidden for users who are not logged in.
  
<code><nowiki>$wgTweekiSkinHideNonPoweruser = array( 'TOOLBOX', 'EDIT-EXT-special' );</nowiki></code>
+
$wgTweekiSkinHideNonPoweruser = array( 'TOOLBOX', 'EDIT-EXT-special' );
 
:Elements in this array will only be shown to users who have chosen in their preferences to be "powerusers".
 
:Elements in this array will only be shown to users who have chosen in their preferences to be "powerusers".
  
=== Footer Icons ===
+
=== Footer ===
  
<code><nowiki>$wgTweekiSkinFooterIcons = true;</nowiki></code>
+
$wgTweekiSkinFooterIcons = true;
 
:If set to false, the icons in the footer will be replaced by text aquivalents.
 
:If set to false, the icons in the footer will be replaced by text aquivalents.
  

Revision as of 10:09, 27 August 2014

Configuration Options (and their defaults)

This options can be set in LocalSettings.php (after the inclusion of tweeki.php):

Hiding Page Elements

$wgTweekiSkinHideAll = array();
This variable can be used to hide elements from everybody. The {{#tweekihide}} parser function will add to this array. Attention: Only hiding of elements that are also listed in $wgTweekiSkinHideable will actually be put into effect.
$wgTweekiSkinHideable = array( 'firstHeading' );
In order to prevent abuse, only elements listed in this array are allowed to be hidden by the {{#tweekihide}} parser function.
$wgTweekiSkinHideAnon = array();
Elements in this array will be hidden for users who are not logged in.
$wgTweekiSkinHideNonPoweruser = array( 'TOOLBOX', 'EDIT-EXT-special' );
Elements in this array will only be shown to users who have chosen in their preferences to be "powerusers".

Footer

$wgTweekiSkinFooterIcons = true;
If set to false, the icons in the footer will be replaced by text aquivalents.

Messages (and their defaults)

Navbar

Mediawiki:Tweeki-navbar-brand: Tweeki

Content of the "brand" link.

Mediawiki:Tweeki-navbar-left: empty

Content of the left side of the navbar.

Mediawiki:Tweeki-navbar-right: SEARCH,TOOLBOX,PERSONAL

Content of the right side of the navbar.

Subnavigation

Mediawiki:Tweeki-subnav: SIDEBAR

Content of the sub navigation. Set to "-" to not show a sub navigation.

Sidebar

Mediawiki:Tweeki-sidebar: EDIT-EXT,TOC

Content of the sidebar.

Link Customization

Mediawiki:Tweeki-login: Log in / Create account

Text used for the login link.

Mediawiki:Tweeki-toolbox: empty

Custom link content for toolbox dropdown. (e.g. <i class="icon icon-cog"></i>)

Tweekihide parser function

Usage: {{#tweekihide:element1|element2|...}}

This parser function can be used to hide elements from a specific page (e.g. the main page).

You can use the following elements:

  • page sections: navbar, navbar-brand, navbar-left, navbar-right, subnav, sidebar, firstHeading, footer
  • navigational elements: EDIT, EDIT-EXT, PAGE, TOOLBOX, VARIANTS, VIEW, ACTIONS, PERSONAL, LOGIN, SIDEBAR, LANGUAGES, SEARCH, LOGO, FIRSTHEADING, TOC

Special navigational elements

EDIT

an "Edit Page" button for the current page

EDIT-EXT

to be used in the sidebar: a split dropdown with "Edit Page" and the other ACTIONS in the dropdown menu