Difference between revisions of "Configuration"

From Tweeki
Jump to: navigation, search
Line 1: Line 1:
== Default Configuration Options ==
+
== Configuration Options (and their defaults) ==
 +
 
 
This options can be set in LocalSettings.php (after the inclusion of tweeki.php):
 
This options can be set in LocalSettings.php (after the inclusion of tweeki.php):
 +
 +
=== Hiding Page Elements ===
  
 
<code><nowiki>$wgTweekiSkinHideAll = array();</nowiki></code>
 
<code><nowiki>$wgTweekiSkinHideAll = array();</nowiki></code>
Line 13: Line 16:
 
<code><nowiki>$wgTweekiSkinHideNonPoweruser = array( 'TOOLBOX', 'EDIT-EXT-special' );</nowiki></code>
 
<code><nowiki>$wgTweekiSkinHideNonPoweruser = array( 'TOOLBOX', 'EDIT-EXT-special' );</nowiki></code>
 
: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 ===
  
 
<code><nowiki>$wgTweekiSkinFooterIcons = true;</nowiki></code>
 
<code><nowiki>$wgTweekiSkinFooterIcons = true;</nowiki></code>
Line 18: Line 23:
  
 
== Messages ==
 
== Messages ==
 +
 +
=== Navbar ===
  
 
[[Mediawiki:Tweeki-navbar-brand]]
 
[[Mediawiki:Tweeki-navbar-brand]]
 
:Content of the "brand" link.
 
:Content of the "brand" link.
 +
 
[[Mediawiki:Tweeki-navbar-left]]
 
[[Mediawiki:Tweeki-navbar-left]]
 
:Content of the left side of the navbar.
 
:Content of the left side of the navbar.
Line 26: Line 34:
 
[[Mediawiki:Tweeki-navbar-right]]
 
[[Mediawiki:Tweeki-navbar-right]]
 
:Content of the right side of the navbar.
 
:Content of the right side of the navbar.
 +
 +
=== Subnavigation ===
  
 
[[Mediawiki:Tweeki-subnav]]
 
[[Mediawiki:Tweeki-subnav]]
 
:Content of the sub navigation. Set to "-" to not show a sub navigation.
 
:Content of the sub navigation. Set to "-" to not show a sub navigation.
 +
 +
=== Sidebar ===
  
 
[[Mediawiki:Tweeki-sidebar]]
 
[[Mediawiki:Tweeki-sidebar]]
 
:Content of the sidebar.
 
:Content of the sidebar.
 +
 +
=== Link Customization ===
  
 
[[Mediawiki:Tweeki-login]]
 
[[Mediawiki:Tweeki-login]]
Line 48: Line 62:
 
* page sections: navbar, navbar-brand, navbar-left, navbar-right, subnav, sidebar, firstHeading, footer
 
* 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
 
* 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

Revision as of 09:56, 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. 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 Icons

$wgTweekiSkinFooterIcons = true;

If set to false, the icons in the footer will be replaced by text aquivalents.

Messages

Navbar

Mediawiki:Tweeki-navbar-brand

Content of the "brand" link.

Mediawiki:Tweeki-navbar-left

Content of the left side of the navbar.

Mediawiki:Tweeki-navbar-right

Content of the right side of the navbar.

Subnavigation

Mediawiki:Tweeki-subnav

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

Sidebar

Mediawiki:Tweeki-sidebar

Content of the sidebar.

Link Customization

Mediawiki:Tweeki-login

Text used for the login link.

Mediawiki:Tweeki-toolbox

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