Index of Modules
The following pages explain and illustrate the function of each module as well as the syntax to be used. Any parameters specific to that module are also explained. Parameters common to all or many modules are explained at Module Settings Interface.
An alphabetical table of contents follows. Below that is an index by category.
Alphabetical Index of Modules
- : Display a calendar of system events
- : List similar content based on Freetags
- : Display site logo, title and subtitle
- : Allows shapes to be drawn over the map.
- : Displays a menu or a structure as a menu
- : Display links to different Social Network (like, Share, Tweet, etc.)
- : Display links to different Social Network (like, Share, Tweet, etc.)
- : Add a Google Adsense advertisement to your Tiki
- : Display a list of articles
- : Simple welcome module with links to help new admins
- : Display articles by month
- : Display a small calendar
- : Display links to categories in a tree
- : Display controls to trigger category transitions
- : Allow users to change the category of a page
- : List most recently visited pages
- : Displays the number of pages received (via Communications).
- : Shows the credits a user has.
- : Displays the specified number of the directory sites most recently added.
- : Displays statistics about the directory, including the number of sites validated and to validate, the number of categories, of searches and of visited links.
- : Displays the specified number of the directory sites from most visited to least visited.
- : Shows the Wall of a user
- : Displays the site\'s first featured links.
- : Displays the specified number of the forum topics with the best ratings.
- : Displays the latest forum posts.
- : Display the specified number of the forums with the most comments.
- : Display the specified number of the forum topics with the most reads.
- : Display the specified number of the forums with the most visits.
- : Displays current tags on wiki pages and enables adding tags if permissions allow.
- : List pages with tags in common with the page being viewed
- : Displays the most popular freetags in a list or cloud
- : Displays to registered users the tags they prefer, based on the number of objects they tagged. Greater preference is indicated by a larger text size.
- : Displays a Google search box for searching the site or the web
- : Enables temporarily changing one's group memberships to see how users in fewer groups experience the site.
- : Displays the specified number of last actions.
- : Lists the specified number of blogs posts from newest to oldest.
- : Displays the most recently updated objects in a category
- : Displays the specified number of blogs from newest to oldest.
- : Displays a list of most recently created FAQs
- : Displays the specified number of quizzes from newest to oldest.
- : List the specified number of files, starting from the most recently added.
- : Display the specified number of file galleries, starting from the most recently modified.
- : Displays the specified number of blogs, starting from the most recently modified.
- : Display the specified number of calendar events, starting from the most recently modified.
- : List the specified number of pages, starting from the most recently modified.
- :
- : Lists the specified number of tracker comments (optionally restricting to those in a specific tracker or tracker item) starting from the most recently posted.
- : Displays the value of a field of the specified number of tracker items. If the specified tracker has no main field, either Field name or Field identifier is required.
- : Displays the specified number of validated questions FAQs from newest to oldest.
- : Displays the most recent registered visitors to the site
- : Display a YouTube playlist
- : Tells users whether a live support operator is present and allows them to request support if possible. If the user is an operator, links to the operator console.
- : A simple wrapper for PluginList as a module
- : Displays a login box
- : Displays a menu or a structure as a menu
- : Displays the content of a wiki page as a menu
- : Displays to users their number of new inter-user messages and a link to their message box.
- : Small live chat box
- : Link to articles or blog posts for the current month and those preceding it.
- : Displays the number of article submissions waiting examination and a link to the list.
- : Displays the specified number of old articles (which do not show on articles home page anymore).
- : Display information about users currently logged in.
- : List of active permissions for current object
- : Enables to change current perspective.
- : Powered by Tiki, and others
- : Enables to quickly create or edit Wiki pages.
- : Some helpful tools for administrators.
- : Consolidated admin bar with an easy access to quick admin links, recent changes, and important admin features
- : Displays the specified number of random wiki pages.
- : Permit anonymous visitors to create an account on the site.
- : Search for a wiki page by name.
- : List the relationships known for the Wiki page displayed. For each relation type contained in the page, it lists all the pages it links to or gets linked from.
- : The shoutbox is a quick messaging tool. Messages reload each time the page changes. Anyone with the right permission can see all messages. Another permission allows messages to be sent..
- : Displays to logged-in users the number of new or updated objects since their last login date and time.
- : Displays to logged-in users new or updated objects since a point in time, by default their last login date and time.
- : Displays a language picker to change the language of the site.
- : Switch between light, dark, and browser color scheme preference
- : Enables to quickly change the theme for the user.
- : Displays the specified number of blogs with links to them, from the most active one to the least.
- : Lists the specified number of articles with links to them, from the most visited one to the least.
- : Displays the specified number of files with links to them, starting with the one with most hits.
- : Displays the specified number of file galleries with links to them, starting with the one with most hits.
- : Displays the specified number of users who posted to forums, starting with the one having most posts.
- : Displays the specified number of objects, starting with the one having the most hits.
- : Displays the specified number of wiki pages with links to them, starting with the one having the most hits.
- : Displays the specified number of quizzes with links to them, starting with the one having the most hits.
- : Display the specified number of blogs with links to them, from the most visited one to the least.
- : Display the specified number of FAQs with links to them, from the most visited one to the least.
- : Display the fields of a tracker (name and identifier)
- : Shows the tweets from the Twitter timeline of a user
- : Lists the specified number of calendar events, ordered by their start date.
- : Displays to registered users their blogs.
- : Lightweight interface to user bookmarks, enabling to view them concisely, do some manipulations and bookmark the page being viewed
- : Displays to registered users the specified number of wiki pages which they were the last to edit.
- : Lightweight interface to user tasks, enabling to view them concisely and do some manipulations
- : Display a list of users with optional extra information from each.
- : Display the logged user\'s rank and score.
- : Display the specified number of users and their score, starting from the one with the highest score.
- : Lists objects which share a category with the viewed object.
- : Display information about users currently logged in.
- : Lists the specified number of comments starting from the most recently posted.
- : Displays YouTube videos and or a link to a YouTube user's page.
- : Can contain other modules so can be used as a Bootstrap navbar object, for example.
- : Search the group\'s Zotero library for entries with the specified tags
Modules by Category
Feature Modules
| Module Name1 | Module Title2 | Description | Parameters | Versions | ||
|---|---|---|---|---|---|---|
| Module articles | articles | Articles | title, type, topicId, topic, start | |||
| Module breadcrumb | breadcrumb | Recently visited pages | Lists recently-visited pages. | maxlen | ||
| Module calendar | calendar | Calendar-Filter | ||||
| Module calendar_new | calendar | Calendar-Filter | 3.x, 4.x, 5.x, 6.x | |||
| Module categories | categories | Displays category objects. | type, deep, categId, style | 1.10 | ||
| Module change_category | change_category | id, shy (show only if page is in categ) | ||||
| Module comm_received_objects | comm_received_objects | |||||
| Module current_activity | current_activity | Display users who are currently editing a page or a tracker | ||||
| Module directory_stats | directory_stats | Directory stats | ||||
| Module featured_links | featured_links | Featured links | Displays featured links. | |||
| Module minichat | minichat | Mini chat | Shows a small box for chat updated at real time without browser refresh. | |||
| Module package | package | A module that shows content from a Tiki Package View | ||||
| Module permissions | permission | List of active permissions for current object | ||||
| Module random_pages | random_pages | Displays a link to a random wiki page. | ||||
| Module random_images | random_images | Displays a random image thumbnail. | galleryId | |||
| Module shoutbox | shoutbox | post comments in to the module for all to see | tooltip | |||
| Module who_is_there | who_is_there | Online users | Lists usernames of logged-in users. | cluster | ||
| Module login_box | login_box | The login/logout box | input_size (since 1.10)=size in characters of the text input box | |||
| Module online_users | online_users | Online users | Lists real names of logged-in users. |
User's Configuration Modules
| Module Name1 | Module Title2 | Description | Parameters | Versions | |
|---|---|---|---|---|---|
| Module switch_lang | switch_lang | Switch site language (dropdown list selector). | title, nobox, flip, decorations | ||
| Module switch_lang2 | switch_lang2 | Switch site language (select among text links). | title, nobox, flip, decorations | ||
| Module switch_lang_admin | Displays a language picker to change the language of admin site | title, nobox, flip, decorations | |||
| Module switch_theme | switch_theme | Allows users to switch site theme | |||
| Module switch_color_mode | switch_color_mode | Allows users to switch site color mode (light, dark, auto (and, coming soon, custom) |
Navigation Modules
| Module Name1 | Module Title2 | Description | Parameters | Versions | ||
|---|---|---|---|---|---|---|
| Module directory_last_sites | directory_last_sites | Lists latest sites links added to Directory. | nonums, absurl ( [y | n] - If not set, default = relative) | ||
| Module directory_stats | directory_stats | Shows Directory statistics. | ||||
| Module directory_top_sites | directory_top_sites | Shows most-visited sites in Directory. | ||||
| Module list | list | List objects from the Unified Index | ||||
| Module whats_related | whats_related | Lists objects in same category as current page/object. |
Recent Changes Modules
| Module Name1 | Module Title2 | Description | Parameters | Versions | |
|---|---|---|---|---|---|
| Module forums_last_posts | forums_last_posts | Lists recent forum posts. | nonums | ||
| Module forums_last_topics | forums_last_topics | Lists recent new forum topics. Or in version 1.10, also recently replied to forum topics | nonums, absurl | ||
| Module since_last_visit | since_last_visit | Shows changes in various features since last login | |||
| Module since_last_visit_new | since_last_visit_new | Shows changes in various features since last login | showuser ,showtracker | ||
| Module wiki_last_comments | wiki_last_comments | Most recently added wiki comments | moretooltips, nonums | ||
| Module last_actions | last_actions | Displays latest users' actions. | showuser, showdate, nonums, maxlen | ||
| Module last_articles | last_articles | Displays latest articles. | type, topicId. topic, nonums, absurl | ||
| Module last_blog_posts | last_blog_posts | display latest blog posts | blogid, title, nonums | ||
| Module last_category_objects | last_category_objects | Recently categorized objects | type, id | ||
| Module last_created_blogs | last_created_blogs | Recently created blogs | nonums | ||
| Module last_created_faqs | last_created_faqs | Recently created FAQs | nonums | ||
| Module last_created_quizzes | last_created_quizzes | Recently created Quiz | nonums | ||
| Module directory_last_sites | directory_last_sites | Last Sites | Recently added links in Directory. | ||
| Module last_files | last_files | Displays files uploaded since last visit | galleryId, nonums | ||
| Module last_file_galleries | last_file_galleries | Displays file galleries modified since last visit | |||
| Module last_image_galleries | last_image_galleries | Displays latest Image Gallery modified since last visit | nonums | ||
| Module last_images | last_images | Lists most-recent image uploads. | galleryId, nonums | ||
| Module last_images_th | last_images_th | Shows thumbnails of most-recent image uploads. | galleryId | ||
| Module last_modified_blogs | last_modified_blogs | Display blogs modified since last visit. | nonums | ||
| Module last_modif_events | last_modif_events | calendarId, maxlen, nonums | |||
| Module last_modif_pages | last_modif_pages | Displays most recently edited wiki pages | minor, maxlen, nonums, absurl | ||
| Module last_modif_tracker_items | last_modif_tracker_items | Lists the tracker items added since last visit | name, trackerId, nonums | ||
| Module last_submissions | last_submissions | Lists the tracker items added since last visit. | nonums | ||
| Module last_tracker_comments | last_tracker_comments | trackerId, itemId, nonums | |||
| Module last_tracker_items | last_tracker_items | Lists the last tracker items added. | status, name, trackerId, nonums | ||
| Module last_visitors | last_visitors | Lists recent logged-in visitors. | maxlen, nonums |
"Best of" Modules
| Module Name1 | Module Title2 | Description | Parameters | Versions | ||
|---|---|---|---|---|---|---|
| Module forums_best_voted_topics | forums_best_voted_topics | Top topics | nonums | |||
| Module forums_most_commented_forums | forums_most_commented_forums | nonums | ||||
| Module forums_most_read_topics | forums_most_read_topics | nonums | ||||
| Module forums_most_visited_forums | forums_most_visited_forums | nonums | ||||
| Module top_active_blogs | top_active_blogs | nonums | ||||
| Module top_articles | top_articles | Lists Articles by number of hits | nonums | |||
| Module top_files | top_files | Lists files by number of hits (downloads?) | nonums | |||
| Module top_file_galleries | top_file_galleries | Lists File Gallery | file galleries by number of hits. | nonums | ||
| Module top_forum_posters | top_forum_posters | Lists most-active forum posters. | nonums | |||
| Module top_games | top_games | Lists Games by number of hits. | nonums | |||
| Module top_images | top_images | Lists Wiki-Syntax Images | Images by number of hits. | nonums | ||
| Module top_images_th | top_images_th | Shows thumbnails of most-viewed images. | ||||
| Module top_image_galleries | top_image_galleries | Lists Image Gallery pages by number of hits. | nonums | |||
| Module top_objects | top_objects | Lists most-viewed objects (pages, galleries, etc.). | nonums | |||
| Module top_pages | top_pages | Lists Wiki pages by number of hits. | nonums | |||
| Module top_quizzes | top_quizzes | Lists Quiz by number of hits. | nonums | |||
| Module top_visited_blogs | top_visited_blogs | Lists Blog by number of hits. | nonums | |||
| Module top_visited_faqs | top_visited_faqs | Lists FAQs by number of hits. | nonums |
Help and Support Modules
| Module Name1 | Module Title2 | Description | Parameters | Versions | |
|---|---|---|---|---|---|
| Module assistant | assistant | Tiki Assistant | Welcome message to admin of new Tiki installation. | ||
| Module live_support | live_support | Starts the live support feature |
Search Modules
| Module Name1 | Module Title2 | Description | Parameters | Versions | |
|---|---|---|---|---|---|
| Module Name | Title | Short Description | Specific Params | tw release | |
| Module google | Google Search | Web search | |||
| Module search_box | search_box | Search in entire site or by feature. | |||
| Module search_last_rebuild_stats | search_last_rebuild_stats | Search Rebuild Stats | search_last_rebuild_stats | ||
| Module search_new | search_new | Search in entire site or by feature. | |||
| Module search_wiki_page | search_wiki_page | Search for wiki page name. | |||
| Module websearch | websearch | Displays a simple form to perform a web search with choice on multiple search engines |
MyTiki Modules
| Module Name1 | Module Title2 | Description | Parameters | Versions | |
|---|---|---|---|---|---|
| Module user_blogs | user_blogs | Lists "my Blogs" from the MyTiki feature | nonums | ||
| Module user_bookmarks | user_bookmarks | Lists "my Bookmarks" from the MyTiki feature | |||
| Module user_image_galleries | user_image_galleries | Lists "my Pages" from the MyTiki feature | nonums | ||
| Module user_pages | user_pages | Lists "my Pages" from the MyTiki feature | nonums | ||
| Module user_tasks | user_tasks | Lists tasks from the MyTiki feature | |||
| Module messages_unread_messages | messages_unread_messages | Displays the number of new user messages |
Miscellaneous Modules
| Module Name1 | Module Title2 | Description | Parameters | Versions | ||
|---|---|---|---|---|---|---|
| Module adminbar | adminbar | adminbar | Consolidated admin bar with an easy access to quick admin links, recent changes, and important admin features | |||
| Module cookiesettings | cookiesettings | cookiesettings | Allows users to change their cookie consent preferences | |||
| Module events | events | Current events | Displays calendar (?) | |||
| Module git_detail | git_detail | GIT commit and last update information | ||||
| Module menupage | menupage | Displays a wiki page's content. | name | |||
| Module num_submissions | num_submissions | |||||
| Module old_articles | old_articles | |||||
| Module quick_edit | quick_edit | title, templateId, submit, size, mod_quickedit_heading, categId | ||||
| Module recordrtc | recordrtc | |||||
| Module short_url | short_url | Creates or shows a short url for the visiting page | ||||
| Module wikistructure | 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". | ||
| Module tail | tail | (used by devs) | file, title, max, reverse, filter | |||
| Module upcoming_events | upcoming_events | calendarId, maxDays, maxlen, nonums, date_format | ||||
| Module action_similarcontent | action_similarcontent | Similar Content | Display similar content to current object using FreeTags | contentType | 5.0 | |
| Module freetag | freetag | allows to add and remove tag from a current object | ||||
| Module freetags_current | freetags_current | displays the current tags of an object. Only for a wiki page. | ||||
| Module freetags_prefered | freetags_prefered | Shows the favorite tags of a user. The number of tags is the value of the parameter rows defined at the module assigment. | ||||
| Module freetags_most_popular | freetags_most_popular | Shows the most popular tags. The number of tags is the value of the parameter rows defined at the module assigment. | ||||
| Module freetags_morelikethis | freetags_morelikethis | Shows the objects that have the same tags than an object. Only for a wiki page. The number of objects is the value of the parameter rows defined at the module assignment. | ||||
| Module pagetop_hero | pagetop_hero | An easy page-top hero section located in Tiki's topbar module zone | nobox | |||
| Module poll | poll | Displays a poll in a wiki page | pollId | |||
| Module reading_time | reading_time | Displays the estimated reading time for the words on a Wiki page (inner modules are excluded). To avoid displaying empty module on non wiki page object, set the module Visibility,Section to wiki | ||||
| Module xmpp | xmpp | Hold a chat session using XMPP (uses the ConverseJS client) |
These pages also open here:
List of Modules
;){kind=link}