Cancel Fullscreen

Mods


Tiki comes built-in with over a 1000 features, settings, plugins, modules, etc. This should be sufficient for the vast majority of Tiki users.

However, sometimes, there is some interesting code than isn't (experimental or deprecated things) or can't (because of licensing issues) be bundled in Tiki. This is when mods are used. More info at dev:To Mods Or Not To Mods



(A modular install for Tikiwiki components)

The tikimods feature is in 1.9+ Tikiwiki release the new tool for distribution, install, upgrade and removal of Tikiwiki components, also called mods. A Mod can be a feature, a plugin, a module, a theme, a language file, a replacement for an existing feature, or a combination of all the previous items.

The tikimods tool is available in versions 1.9 and above. Tikimods allows you to distribute, install , upgrade and remove a Tikiwiki Mod. Mods can consist of features, plugins, modules, themes, language files, or any combination of those packaged together. Here are two examples:

  • Modules:Clock is a single module that allows you to put a clock in the left or right column.
  • tinvoice is a feature that will allow you to generate invoices from Tikiwiki. This mod consists of many files including php files, templates, and sql statements to create additonal tables.

Basic principle

The Tiki Mods behaves like many package management software that is known in the unix world, and could be compared to the debian apt, the redhat yum; mandrake urpmi; or gentoo emerge, but adapted to the tikiwiki environment. It's a web-based tool for update operations on some tikiwiki extensions. It fulfills the following functions:
  • listing of a remote mods server, by default http://mods.tikiwiki.org/
  • maintenance of locally stored mods : comparison with remote, downloading of new versions
  • installation of local mods, upgrade and removal

Manual install.

If installing via mods doesn't work for you, because of your server configuration (ex.: some shared hosts), you can still install the mods manually:
  1. Download from mods.tikiwiki.org (or from wherever) the tgz file you want to install (e.g., features-aulawiki-1.6.tgz).
  2. Extract the file. You will find several directories, but only one with the name Packages. Within it you have the XXXX.info.txt file which describes the mod you have downloaded.
  3. Copy all the directories and files (except Packages) to your tiki installation. It should be fairly obvious where to install the files within them.
  4. Now the tricky point, only for the mods which require modifications to the database (if you install just a wiki plugin or lib, for instance, you can skip this point since they usually don't require database changes). Go back into the XXXX.info.txt. Open it. You will find a section that starts with sql-install: and ends with sql-remove:.Image
    sql-install:
    DROP TABLE IF EXISTS `tiki_workspace_role_wstype`;
    DROP TABLE IF EXISTS `tiki_workspace_roles`;
    DROP TABLE IF EXISTS `tiki_workspaces`;
    ...
    and more SQL nice syntax! :D
    ...
    sql-remove:
  5. Copy all these SQL sentences between sql-install: and sql-remove:.
  6. To finish the installation you only have to execute them in your database, e.g. with phpmyadmin.
  7. Now the tiki magic will do the rest.



Related pages



Contributors to this page: Marc Laporte9138 points  , Xavi67871 points  , Roberto López159 points  , Jürgen Heckes473 points  , dthacker1483 points  and system .
Page last modified on Friday 28 August, 2009 11:43:51 UTC by Marc Laporte9138 points .
The content on this page is licensed under the terms of the Creative Commons Attribution-ShareAlike License.