History: Module
Source of version: 80 (current)
Copy to clipboard
! {{page}} {DIV(class="lead")}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.{DIV} Here's a screenshot: {img fileId="442" thumb="y" rel="box[g]" width="200" alt="Module" desc="Default Tiki page with the Menu module in the left column." stylebox="border:1px solid darkgray; float:left; margin-right:70px;margin-left:50px" imalign="center" button="y"} {DIV(float="left" width="250px")}^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^{DIV}{DIV(clear=both)}{DIV} 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. {REMARKSBOX(type=tip, title=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.''{REMARKSBOX} !!!Configuring and Displaying Modules For site-wide module settings, click the __General__ icon {icon name="admin_module" size="2" title="Image may vary depending on icon set in use."} on the ((Admin Panels|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: # 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)) # 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 __((wiki plugin|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 * ((Module Admin))--Introduction to the module admin pages for site-wide and individual module settings ** ((Assigning Modules))--How to select a module to configure it ** ((Module Settings Interface))--Interface for configuring individual module settings ** ((Module Settings Parameters))--Explanation of standard parameter settings for modules ** ((Creating Custom Modules))--How to create custom modules * ((Index of Modules))--Links to the documentation of individual modules -=Related Pages=- * ((User Modules))--how (if the feature is active) users can choose and place their modules * ((Creating Custom Modules))--how to create simple and advanced custom modules includin small tutorial * ((Mods Type Modules))--links to modules that are installed as components -=Alias=- * (alias(ModulesDoc)) * (alias(Modules)) ---