Difference between revisions of "Installation"

From Tweeki
Jump to: navigation, search
(Created page with "=== Installation === You can [https://github.com/thaider/tweeki Download Tweeki from GitHub] or get it directly with git: Change to the "skins" subdirectory of your MediaWik...")
 
 
(55 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__TOC__
 +
=== Compatibility ===
 +
 +
{| class="table table-bordered table-sm
 +
! Tweeki !! Bootstrap !! MediaWiki !! Latest Release !! Branches !! Note
 +
|-
 +
! 5.43.1 [https://github.com/thaider/Tweeki/archive/v5.43.1.zip <i class="fa fa-download" data-toggle="tooltip" title="Download as ZIP"></i>]
 +
| 5.3.3 || 1.43-1.47 || 2025-08-11 || 5.43* <br>REL1_44<br>REL1_43 || stable
 +
|-
 +
! 5.39.1 [https://github.com/thaider/Tweeki/archive/v5.39.1.zip <i class="fa fa-download" data-toggle="tooltip" title="Download as ZIP"></i>]
 +
| 5.3.3 || 1.39-1.43 || 2025-03-14 || 5.39* || Bootstrap 5
 +
|-
 +
! 4.39.2 [https://github.com/thaider/Tweeki/archive/v4.39.2.zip <i class="fa fa-download" data-toggle="tooltip" title="Download as ZIP"></i>]
 +
| 4.6.2 || 1.39-1.43 || 2025-03-14 || 4.39*<br>REL1_42<br>REL1_41<br>REL1_42<br>REL1_39 ||
 +
|-
 +
! 2.0.3 [https://github.com/thaider/Tweeki/archive/v2.0.3.zip <i class="fa fa-download" data-toggle="tooltip" title="Download as ZIP"></i>]
 +
| 4.6.2 || 1.35-1.39 || 2023-07-17 || REL1_38<br>REL1_37<br>REL1_36<br>REL1_35 || 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 || REL1_34<br>REL1_33<br>REL1_32<br>REL1_31 || 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 ||  ||
 +
|}
 +
<small>* including latest patches</small>
 +
 +
Since version 4.39.x a release's major version corresponds to the version of Bootstrap in use, the minor version to the supported MediaWiki LTS release.
 +
 +
So release 4.39.0 uses the latest version of Bootstrap 4 and works with MediaWiki 1.39+. It's patches have the goal to support MediaWiki releases at least up to and including the next LTS version.
 +
 +
The <code>master</code> branch contains latest patches for the stable branch (currently 5.43.x).
 +
 
=== Installation ===
 
=== Installation ===
  
You can [https://github.com/thaider/tweeki Download Tweeki from GitHub] or get it directly with git:
+
You can [https://github.com/thaider/Tweeki Download Tweeki from GitHub] or get it directly with git:
  
 
Change to the "skins" subdirectory of your MediaWiki installation:
 
Change to the "skins" subdirectory of your MediaWiki installation:
Line 9: Line 41:
 
Clone the repository:
 
Clone the repository:
  
  git clone https://github.com/thaider/tweeki tweeki
+
git clone https://github.com/thaider/Tweeki
 +
 
 +
To checkout a specific (tagged) version:
 +
 
 +
git checkout v5.43.1
  
 
Add the following to LocalSettings.php:
 
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.)
 
(You may safely remove or comment out other mentions of $wgDefaultSkin.)
 +
 +
=== 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 <code>MediaWiki:Tweeki-navbar-left</code> to <code>Products</code> to link to a page of that name.

Latest revision as of 12:28, 11 August 2025

Compatibility

Tweeki Bootstrap MediaWiki Latest Release Branches Note
5.43.1 5.3.3 1.43-1.47 2025-08-11 5.43*
REL1_44
REL1_43
stable
5.39.1 5.3.3 1.39-1.43 2025-03-14 5.39* Bootstrap 5
4.39.2 4.6.2 1.39-1.43 2025-03-14 4.39*
REL1_42
REL1_41
REL1_42
REL1_39
2.0.3 4.6.2 1.35-1.39 2023-07-17 REL1_38
REL1_37
REL1_36
REL1_35
only Bootstrap 4
1.2.7 3/4 1.31-1.35 2021-09-28 REL1_34
REL1_33
REL1_32
REL1_31
major code refactoring,
introducing Bootstrap 4 via opt-in
1.1.3 3 1.31-1.35 2020-11-15

* including latest patches

Since version 4.39.x a release's major version corresponds to the version of Bootstrap in use, the minor version to the supported MediaWiki LTS release.

So release 4.39.0 uses the latest version of Bootstrap 4 and works with MediaWiki 1.39+. It's patches have the goal to support MediaWiki releases at least up to and including the next LTS version.

The master branch contains latest patches for the stable branch (currently 5.43.x).

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 v5.43.1

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.)

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.