Plugin Alias | Documentation for Tiki Wiki CMS Groupware

plugin alias

Documentation TOC » Features » Wiki » Plugin Alias

Plugin Alias is a new feature for Tiki3 to make new plugins based on previously existing plugins in your tiki site.

Were you looking for Wiki page alias links instead?

Key features
Benefits
How to use
Example
Usage
Related links

Key features

Permits the creation of new plugins directly from the admin panel, without FTP access
These new plugins use an existing plugin as a base
These new plugins can have any name
Have some internal documentation (which appears in Plugin Help)
Can be distributed via profiles

Benefits

Permits to create very specialized plugins without duplicating code
It permits to specify from a single location, arguments that are passed to these plugins.
- for confidentiality
- for simplicity
- central management/reduce potential errors
- So if a plugin is used in hundreds of wiki pages, and you want to change a setting, you change it in one place.

How to use

The Plugin Alias Manager can be found at tiki-admin.php?page=plugins, also accessible via the "Text Area" admin panel.

Example

Plugin aliases permit you to go from this:

{TRACKERLIST(trackerId=>11,fields=>194:220:196,max=>-1,filterfield=>220,filtervalue=>Quebec,showlinks=>y)}{TRACKERLIST}

To this:

{pavillon filtervalue=Quebec}

Here is how to configure the alias:

Usage

When using plugin alias to shows just some items from PluginTrackerList, the parameter to filter results at the "Plugin Parameter documentation" need to be also added as arguments of your plugin alias, at the section "Simple plugin arguments" with no value (in this example: "filtervalue").

If you need to delete one argument or one parameter after you already created it, remove its name and value and save changes in order to have it deleted.

The current admin panel at tiki-admin.php?page=plugins is, as of 2009-02-03, still rough. If something feels strange or you are running out fields, click "save" to have a refresh.

To see real life examples of how it is used, you can install one of profiles where it is being used:
http://profiles.tiki.org/tiki-searchresults.php?highlight=plugin_alias