Difference between revisions of "Installation"

Latest revision as of 18:39, 5 March 2022

Compatibility

Tweeki	Bootstrap	MediaWiki	Latest Release	Note
3.0.0	5	1.39+	expected earliest end of 2022	only Bootstrap 5
2.0.1	4	1.35-1.39	2022-01-12	only Bootstrap 4
1.2.7	3/4	1.31-1.35	2021-09-28	major code refactoring, introducing Bootstrap 4 via opt-in
1.1.3	3	1.31-1.35	2020-11-15

Installation

You can Download Tweeki from GitHub or get it directly with git:

Change to the "skins" subdirectory of your MediaWiki installation:

cd skins

Clone the repository:

git clone https://github.com/thaider/Tweeki

To checkout a specific (tagged) version:

git checkout v1.2.7

Add the following to LocalSettings.php:

require_once( "$IP/skins/Tweeki/Tweeki.php" );
$wgDefaultSkin = "tweeki";

(You may safely remove or comment out other mentions of $wgDefaultSkin.)

For 1.2.x versions add the following to LocalSettings.php if you want to use Bootstrap 4:

$wgTweekiSkinUseBootstrap4 = true;

Example configurations

Have a look at the setup for tweeki.kollabor.at (this page) to get an idea of how to achieve similar results.

Basic Configuration

Change the navigation according to your needs, e.g. change the content of MediaWiki:Tweeki-navbar-left to Products to link to a page of that name.

@@ Line 1: / Line 1: @@
 __TOC__
+=== Compatibility ===
+{| class="table table-bordered table-sm
+! Tweeki !! Bootstrap !! MediaWiki !! Latest Release !! Note
+|-
+! ''3.0.0''
+| 5 || 1.39+ || ''expected earliest end of 2022'' || only Bootstrap 5
+|-
+! 2.0.1 [https://github.com/thaider/Tweeki/archive/v2.0.1.zip <i class="fa fa-download" data-toggle="tooltip" title="Download as ZIP"></i>]
+| 4 || 1.35-1.39 || 2022-01-12 || only Bootstrap 4
+|-
+! 1.2.7 [https://github.com/thaider/Tweeki/archive/v1.2.7.zip <i class="fa fa-download" data-toggle="tooltip" title="Download as ZIP"></i>]
+| 3/4 || 1.31-1.35 || 2021-09-28 || major code refactoring, <br>introducing Bootstrap 4 via opt-in
+|-
+! 1.1.3 [https://github.com/thaider/Tweeki/archive/v1.1.3.zip <i class="fa fa-download" data-toggle="tooltip" title="Download as ZIP"></i>]
+| 3 || 1.31-1.35 || 2020-11-15 ||
+|}
 === Installation ===
@@ Line 10: / Line 28: @@
 Clone the repository:
-  git clone https://github.com/thaider/Tweeki
+ git clone https://github.com/thaider/Tweeki
+To checkout a specific (tagged) version:
+ git checkout v1.2.7
 Add the following to LocalSettings.php:
-  require_once( "$IP/skins/Tweeki/Tweeki.php" );
+ require_once( "$IP/skins/Tweeki/Tweeki.php" );
-  $wgDefaultSkin = "tweeki";
+ $wgDefaultSkin = "tweeki";
 (You may safely remove or comment out other mentions of $wgDefaultSkin.)
+For 1.2.x versions add the following to LocalSettings.php if you want to use '''Bootstrap 4''':
+ $wgTweekiSkinUseBootstrap4 = true;
 === Example configurations ===
-Have a look at the [[setup for tweeki.thai-land.at]] to get an idea of how to achieve similar results or look at [[setup for skriptenforum.net]] for a more elaborate example.
+Have a look at the [[setup for tweeki.kollabor.at]] (this page) to get an idea of how to achieve similar results.
 === Basic Configuration ===
 * Change the navigation according to your needs, e.g. change the content of <code>MediaWiki:Tweeki-navbar-left</code> to <code>Products</code> to link to a page of that name.