Fullscreen
[Show/Hide Right Column]

Include the content of another page with certain changes
Print
English
Documentation TOC  »  Features  »  Wiki  »  Wiki Plugin  »  PluginTransclude

Plugin Transclude

Introduced with Tiki6

This plugin includes the content of a wiki page and replaces values in the body of the included page. It is similar to the mediawiki feature transclusion.

What it does:Put some boilerplate stuff (page B ) inside page A, and inside that boilerplate, add some stuff specific to this page only, using these parameters/tags.

It is based on the PluginINCLUDE, which includes a page or part of a page inline.

When the TRANSCLUDE plugin fetches the wiki page, the tag '%%%text%%%' on Page B is replaced by whatever is inside the TRANSCLUDE tag on Page A.
Furthermore, any other parameters (if they exist in Page B-) will be replaced by their values given in the Transclude plugin on Page A..

And - as a result - we can mimick the way MediaWiki templates work.
TRANSCLUDE Syntax
{TRANSCLUDE(page="pageName", key=value, key=value, ...")}text{TRANSCLUDE}

page page to transclude
parameters any additional parameters will be replaced, if they exist

For instance, say we have a todo box template like this:
Todo Box Template
{BOX(class="todo_box", float="right", title="__Todo__ on this page:")}
%%%text%%%{BOX}

It will render like this:
Todo on this page:

text



Now, let's use that template page to 'transclude' some todo items on a page:
{TRANSCLUDE(page="todoBox")}* Bring out the garbage
* Feed the goldfish
{TRANSCLUDE}


All additional parameters will be replaced. For example %%%title%%% will be replaced with the parameter title in the plugin.

Parameters

Required parameters are in bold
Preferences required: wikiplugin_transclude, feature_wiki
Parameters Accepted Values Description Default Since
page Name of the wiki page to use as a template for the values.



Contributors to this page: mlpvolt4388 points  , lindon137 points  , xavi67984 points  and Marc Laporte9146 points  .
Page last modified on Thursday 22 September, 2011 14:29:23 UTC by mlpvolt4388 points .
The content on this page is licensed under the terms of the Creative Commons Attribution-ShareAlike License.

SourceHistorySlideshowComments

Site Language

Reference Guide

Keywords

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



Tiki Newsletter

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