Loading...
 
Skip to main content
Introduction to modules

Module

In Tiki, a module is simply a box of content (which may or may not have "chrome" such as borders and title backgrounds). All side-column information of this site is presented through modules. The Modules Admin page is used to add modules to and manage modules in the module zones of a Tiki site.

Here's a screenshot:

Module
Default Tiki page with the Menu module in the left column.
Some common uses for modules are to:
  • Display menus
  • Add special features
  • Display custom information to users
  • List most recent or most frequent actions or items


After adding modules, you can re-order them, assign permissions to them (so they appear only for specific user groups ), or even allow them to be customized by specific users.

 Note
Even though they are called modules, nearly all are included with the default Tiki installation. There are no additional "add-ons" to be installed in order to use these modules.

Configuring and Displaying Modules

For site-wide module settings, click the General icon on the Admin Panel or Access http://example.org/tiki-admin.php?page=general.
These settings will apply to all modules on the site and are explained in more detail at Module Admin.

There are two ways to configure and display individual modules:

  1. Using the Admin Modules Panel
    • Located at Admin->Modules or tiki_admin_modules.php
    • Allows you to:
      • Set module parameters
      • Create custom modules
      • Place modules in the left or right column and, since Tiki7, other areas like the page header and footer
    • Documentation at Module Admin
  2. Using PluginModule
    • Allows you to:
      • Display a module in a page or within other features (like blogs, articles, etc.) besides the left or right columns
      • Also place module content inside of a user module
      • Set module parameters
    • See Index of Modules

Modules vs. Plugins

The distinction between modules and plugins is a little blurry. Technically speaking, modules are the containers and plugins are the content. However, the predefined modules included with the default Tiki installation contain plugins/content, but they are commonly called modules, too.

Where to Go From Here

Related Pages

Alias