[Show/Hide Right Column]

Print
Tags: theme adsense check youtube
TOC Previous page Parent page Next page

Module Parameters

Parameters for modules are set when the modules are assigned or edited as described on Modules Admin. This page describes module parameters that apply to all or many modules. For parameters specific to a module, see the documentation for that module.

noteNote
''Not all parameters listed below are applicable to every module.

Syntax

Parameters must be entered without spaces. To set multiple parameters, the syntax is similar to parameters you can sometimes notice in the address bar of your browser, e.g.: max=20&lang=fr

Parameter List

Below are the parameters common to all or many modules and their function:

Parameter Description Since
lang To display a module based on the language of the site. Enter lang=fr for example, which means the module will be displayed only if the current language is French. You may also enter lang[]=en&lang[]=fr what will display the module only if the current language is French or English. See a list of possible language strings in http://tikiwiki.org/TikiWikiInternationalizationAndLanguages
flip To make a module shadeable - to toggle the module contents, so that only the titlebar is displayed - by entering flip=y in the parameter field. This causes the module to display a button on the title bar that will toggle module contents on and off. The module defaluts to unshaded (contents shown) and the state is stored in the users' session cookie. Entering flip=yc defaults the module to shaded. See also the Users Shade Modules feature.
title To override the title of a menu, enter title=Menu. To have no title, use the param notitle=y
decorations Suppress module decorations by entering decorations=n. This is unlikely to be useful for most admins (it is provided to enable module content to be embedded in other CMS sections). This param does not affect the title (see notitle param for that)
section To cause a module to only appear in one section. Some sections: wiki (for wiki pages), mytiki, calendar, cms (articles), blogs, forums, file_galleries.
overflow If you are using PHPLayersMenu vertical, the menus need to overflow out of the module and into the middle section. Use overflow=y. 1.9.8
page=HomePage The module will only be displayed in the page named HomePage. At present, do not use quotation marks around the page name. 2.0
nobox Values are 'y' or 'n', default is 'n'. It's advised to use nobox=y as parameter for modules including phplayers menu. When nobox=y is used with the MODULE wikiplugin (as an argument), only the module data is displayed. The surrounding div.box-shadow, div.box, div.box-title and div.box-footer tags are not used. This parameter has no effect for modules assigned on the admin modules page for the left and right columns. The decorations=n parameter should be used for a "nobox" effect in these locations. 2.0
bgcolor To override the background color of the title box. The value can be a color name (ex: bgcolor=blue) or an hexadecimal value(ex: bgcolor=#FFEBCD) 2.0
color To override the text color in the tile. (ex: color=white) 2.0
creator Value is 'y' or 'n': If you are in a wiki section and if you are on a page, it will display the module only if you are the page creator if creator=y, only if you are not the page creator if creator=n. 2.0
contributor Value is 'y' or 'n': If you are in a wiki section and if you are on a page, it will display the module only if you are one of the contributors if contributor=y , only if not if contributor=n - contributors are the users that the page history knows who edited the page (Notice: if the history is cleared or if the history is not activated, the contributors list is empty). 2.0
theme The module will only be displayed if the theme is 'theme'. Example: theme=strasa.css 2.0
notitle To not show the title for the module. Values are y or n - default n 2.0
pagemenu Name of the wiki page to act as a menu, within the Module menupage 2.0
nopage Module will not show when on this page. To specify more than one page use nopage[]=daisy&nopage[]=ripe+tomato . The module will appear only when not on one of these pages 3.0
page[] To specify multiple page use page[]=hello&page[]=What+to+do , the module will appear on any of these pages. 3.0

Contributors to this page: lindon2331 points  , xavi36278 points  , sylvie4333 points  , Scot Wilcoxon680 points  , robferguson10 points  , Rick7121 points  and mlpvolt1895 points  .
Page last modified on Saturday 14 August, 2010 04:53:27 UTC by lindon2331 points .

SourceHistorySlides

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):