PluginVersions | Documentation for Tiki Wiki CMS Groupware

plugin wiki versions

Documentation TOC » Features » Wiki » Wiki Plugin » PluginVersions

Plugin Versions

If you are documenting software, you will run into the situation where most of a page is similar for more than one version, but there could be a small difference. Making several pages could lead to duplicating content and that it be out of sync.

Use this Wiki Plugin to divide a wiki page into separate "versions." Tiki will display a navigation box that allows users to display each version of the page.

For example, you can use this plugin to separate a single wiki page into Release 1, Release 2, and Release 3 information.

Usage

To display a module in a wiki page, use the syntax:

{VERSIONS(nav=>y,title=>y)}

This is the default text

---(version 3)-----------------------------

This is version 3 info

---(version 2)-----------------------------

This is version 2 info

---(version 1)-----------------------------

This is version 1 info

{VERSIONS}

Parameter	Accepted values	Effect	Since
nav	y, n	Displays a navigation box that allows users to select a specific version to display. If nav=y, only the default text will display and users will not be able to display other versions.
title	y, n	Display the current version name as the title. Note: Do not work when nav=>y
default		Specifies which version to show when displaying the page for the first time.

To separate different versions of text use: 3 dashes (hyphens), followed by the version label in parenthesis, followed by at least 3 other dashes or hypens. For example:

---(version 3)-----------------------------

Notes

If you use Wiki Config wiki page caching, this plugin may not render properly.
The "versions" used for this plugin are different than the "versions" stored in the wiki page history.

Example

This code,

{VERSIONS(nav=>y,title=>y)}

This is the default text

---(version 3)-----------------------------

This is version 3 info

---(version 2)-----------------------------

This is version 2 info

---(version 1)-----------------------------

This is version 1 info

{VERSIONS}

Would produce:

Default version 3 version 2 version 1

This is the default text