Loading...
 

Plugin Alias is a new feature since Tiki3 to make "new plugins" (aliases) based on previously existing plugins in your Tiki site.

Were you looking for Wiki page alias links instead?

Key features

  • Permits the creation of the "new plugins" directly from the control panel, without FTP access
  • These new plugin aliases use an existing plugin as a base
  • These new plugin aliases can have any name
  • They have some internal documentation (which appears in Plugin Help)
  • Can be distributed via Profiles (see https://profiles.tiki.org)

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
  • If a plugin alias 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 management can be found on the admin control panel, "Editing and Plugins" under the "Plugin Aliases" tab (-+tiki-admin.php?page=textarea&cookietab=3+-).

Limitations

Plugin name can't contain special characters like a hyphen (-).

Examples

Simple example

Plugin aliases permit you to go from this:

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


To this:

Copy to clipboard
{pavillon filtervalue=Quebec}


Here is how to configure the alias:

Image

Variable body

Problem : The syntax of a plugin alias is different from a standard wiki-plugin.
For instance, here is the syntax for a PluginBox, with a width of 100% and "hello" in the body :

Copy to clipboard
{BOX(width=100%)}hello{BOX}

You can create a plugin alias based on a box with a predefined width of 100% and a pre-defined content that will in the wiki look like :

Copy to clipboard
{my_plugin}

There is no way here to let an user change the body.

To do that, here is a configuration example. In this example the body will be pre-filled with the word "hello" and an user will be able to complete it with anything :

  • plugin name : "my_plugin"
  • base plugin : "box"
  • simple plugin arguments
    • width, default : "100%"
    • my_var, default : (empty)
  • plugin parameter documentation
    • my_var, name : "my_var"
  • plugin body
    • default content : "hello %my_var%"
    • parameters : "my_var", default : "world"

Now, the following code :

Copy to clipboard
{my_plugin}

will look like

hello world

And the following code :

Copy to clipboard
{my_plugin my_var="john"}

will look like

hello john


Usage

When using plugin alias to show 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 using "Change Preferences" button in order to have it deleted.

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

Composed Arguments Example

This plugin makes a COL plugin alias (based on PluginDiv) to create a Bootstrap grid column:


Plaugin Alias 1 Plugin Alias 2 Plugin Alias 3


Alias

doc.tiki.org

Get Started

Admin Guide User Guide

Keywords

Keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

Accessibility (WAI and 508)
Accounting
Articles and Submissions
Backlinks
Banners
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Link Cache
Calendar
Category
Chat
Clean URLs
Comments
Communication Center
Compression (gzip)
Contacts (Address Book)
Contact us
Content Templates
Contribution
Cookie
Copyright
Credit
Custom Home and Group Home Page
Date and Time
Debugger Console
Directory of hyperlinks
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
Draw
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Groups
Hotword
HTML Page
i18n (Multilingual, l10n)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
Kaltura video management
Karma
Live Support
Login
Logs (system & action)
Look and Feel
Mail-in
Map with Mapserver
Menu
Meta Elements
Mobile Tiki and Voice Tiki
Module
MultiTiki
MyTiki
Newsletter
Notepad
Payment
Performance Speed / Load
Permissions
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Polls
Profiles
Profile Manager
Report
Toolbar
Quiz
Rating
Feeds
Score
Search engine optimization
Search
Search and Replace
Security
Semantic links
Shadowbox
Shadow Layers
Share
Shopping cart
Shoutbox
Slideshow
Smiley
Social Networks
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Stats
Surveys
Tags
Task
Tell a Friend, alert + Social Bookmarking
TikiTests
Theme CSS & Smarty
Tiki Manager
Trackers
Transitions
User Administration including registration and banning
User Files
User Menu
Watch
WebDAV
Webmail
Web Services
Wiki History, page rename, etc
Wiki Syntax
Wiki structure (book and table of content)
Workspace
WSOD
WYSIWYCA
WYSIWYG
XMLRPC

Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki