[Show/Hide Right Column]

noteNote
This page is to document what Tiki does. For feature requests and bug reports, please see corresponding page on dev site

Print
Tags: modules

Modules

Modules in Tikiwiki most simply defined as a box of content (not the content itself). The Modules Admin page explains how modules are created as boxes to the left or right of the main content window in tikiwiki. Once created, they can be restacked in any order, given permissions so they appear only to defined user group, and, if the site settings allow, can be customized to the preferences of individual users.

A common use of modules in Tiki is to add custom menus. Otherwise there is a long (and growing) list of pre-programmed modules which can facilitate navigation, add special features, and provide custom information to individual users.

The distinction between modules and plugins is a little blurry - technically speaking, modules are the containers and plugins are the content, but the set of pre-programmed modules (with plugins already inside) that are native to the tikiwiki are also commonly referred to as modules.

Module admin - explains how to create, choose and place modules on the site. User modules - explains how (if the feature is active) users can choose and place their modules. Module Parameters - description of module parameters that are available to all modules .

Immediately below, the modules are organized into categories. Below that is a table of contents of the documentation for each module.

Feature
Feature Modules
Module Name (as listed on Admin Modules) Title (as displayed — English) Short DescriptionSpecific Params (as indicated by module source file) tw release
articles Articles title, type, topicId, topic, start
breadcrumb Recently visited pages Lists recently-visited pages. maxlen
calendar Calendar-Filter
categories Displays category objects. type, deep, categId, style 1.10
change_category id, shy (show only if page is in categ)
comm_received_objects
directory_stats Directory stats
featured_links Featured links Displays featured links.
minichat Mini chat Shows a small box for chat updated at real time without browser refresh.
random_pages Displays a link to a random wiki page.
random_images Displays a random image thumbnail. galleryId
shoutbox post comments in to the module for all to see tooltip
who_is_there Online users Lists usernames of logged-in users. cluster
logged_users Online users Shows the number of logged-in users.
login_box The login/logout boxinput_size (since 1.10)=size in characters of the text input box
online_users Online users Lists real names of logged-in users.

User's Config
User's Configuration Modules
Module Name Title Short DescriptionSpecific Paramstw release
switch_lang Switch site language (dropdown list selector). title, nobox, flip, decorations
switch_lang2 Switch site language (select among text links). title, nobox, flip, decorations
switch_theme Allows users to switch site theme

Navigation
Navigation Modules
Module Name Title Short DescriptionSpecific Paramstw release
directory_last_sites Lists latest sites links added to Directory. nonums, absurl ( [yn] - If not set, default = relative)
directory_stats Shows Directory statistics.
directory_top_sites Shows most-visited sites in Directory.
whats_related Lists objects in same category as current page/object.

Recent Changes

Recent Changes Modules
Module Name Title Short Description Specific Paramstw release
forums_last_posts Lists recent forum posts. nonums
forums_last_topics Lists recent new forum topics. Or in version 1.10, also recently replied to forum topics nonums, absurl
since_last_visit Shows changes in various features since last login
since_last_visit_new Shows changes in various features since last loginshowuser ,showtracker
wiki_last_comments Most recently added wiki comments moretooltips, nonums
last_actions Displays latest users' actions. showuser, showdate, nonums, maxlen
last_articles Displays latest articles. type, topicId. topic, nonums, absurl
last_blog_posts display latest blog posts blogid, title, nonums
last_category_objects Recently categorized objects type, id
last_created_blogs Recently created blogs nonums
last_created_faqs Recently created FAQs nonums
last_created_quizzes Recently created Quiz nonums
directory_last_sites Last Sites Recently added links in Directory.
last_files Displays files uploaded since last visit galleryId, nonums
last_file_galleries Displays file galleries modified since last visit
last_image_galleries Displays latest Image Gallery modified since last visit nonums
last_images Lists most-recent image uploads. galleryId, nonums
last_images_th Shows thumbnails of most-recent image uploads. galleryId
last_modified_blogs Display blogs modified since last visit. nonums
last_modif_events calendarId, maxlen, nonums
last_modif_pages Displays most recently edited wiki pages minor, maxlen, nonums, absurl
last_modif_tracker_items Lists the tracker items added since last visit name, trackerId, nonums
last_submissions Lists the tracker items added since last visit. nonums
last_tracker_comments trackerId, itemId, nonums
last_tracker_items Lists the last tracker items added.status, name, trackerId, nonums
last_visitors Lists recent logged-in visitors. maxlen, nonums

Best Of
"Best of" Modules
Module Name Title Short Description Specific Paramstw release
forums_best_voted_topics Top topics nonums
forums_most_commented_forums nonums
forums_most_read_topics nonums
forums_most_visited_forums nonums
top_active_blogs nonums
top_articles Lists Articles by number of hits nonums
top_files Lists files by number of hits (downloads?) nonums
top_file_galleries Lists file galleries by number of hits. nonums
top_forum_posters Lists most-active forum posters. nonums
top_games Lists Games by number of hits. nonums
top_images Lists Images by number of hits. nonums
top_images_th Shows thumbnails of most-viewed images.
top_image_galleries Lists Image Gallery pages by number of hits. nonums
top_objects Lists most-viewed objects (pages, galleries, etc.). nonums
top_pages Lists Wiki pages by number of hits. nonums
top_quizzes Lists Quiz by number of hits. nonums
top_visited_blogs Lists Blog by number of hits. nonums
top_visited_faqs Lists FAQs by number of hits. nonums

Help
Help and Support Modules
Module Name Title Short Description Specific Paramstw release
assistant Tikiwiki Assistant Welcome message to admin of new Tiki installation.
live_support Starts the live support feature

Search
Search Modules
Module Name Title Short Description Specific Paramstw release
google Google Search Web search
search_box Search in entire site or by feature.
search_new Search in entire site or by feature.
search_wiki_page Search for wiki page name.

MyTiki
MyTiki Modules
Module Name Title Short Description Specific Paramstw release
user_blogs Lists "my Blogs" from the MyTiki feature nonums
user_bookmarks Lists "my Bookmarks" from the MyTiki feature
user_image_galleries Lists "my Pages" from the MyTiki feature nonums
user_pages Lists "my Pages" from the MyTiki feature nonums
user_tasks Lists tasks from the MyTiki feature
messages_unread_messages Displays the number of new user messages

Miscellaneous
Misc. Modules
Module Name Title Short Description Specific Paramstw release
events Current events Displays calendar (?)
menupage Displays a wiki page's content. name
num_submissions
old_articles
quick_edit title, templateId, submit, size, mod_quickedit_heading, categId
wikistructure Dynamic navigation menu created on the fly from a given structre toc id, maxdepth (in theory, same as toc) 2.x, some params only in 3.0 like "maxdepth".
tail (used by devs) file, title, max, reverse, filter
upcoming_events calendarId, maxDays, maxlen, nonums, date_format
action_similarcontent Similar Content Display similar content to current object using FreeTags contentType 5.0
poll Displays a poll in a wiki page pollId

More information,

Please see the following pages:

alias

Contributors to this page: lindon2331 points  , xavi36278 points  , system , sylvie4333 points  , Scot Wilcoxon680 points  , SCO2land384 points  , Rick7121 points  , pascalstjean382 points  , Oliver Hertel26 points  , nkoth22 points  , Mose96 points  , mlpvolt1895 points  , Marc Laporte5511 points  , jimmy5 points  , jasondiceman5 points  , Gary Cunningham-Lee996 points  and Philippe Cloutier367 points  .
Page last modified on Saturday 14 August, 2010 04:13:38 UTC by lindon2331 points .

Find by Page Name

Exact match

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki documentation and should correspond to development keywords (bug reports and feature requests):