Children Plugin

Name
Children Plugin
Author
eTouch Systems
Author URL
http://www.etouch.net
Recent Version 1.0
Plugin UI Available
Yes
Enabled for Wiki
Yes
Enabled for Blog
No
Enabled for Hosted Instance
Yes
MacroId
$children
Download Jar
Not needed. Comes bundled with Samepage


Description

The Children Plugin inserts a hierarchical list of all the child pages of the specified page in a specified project.
 Key features of this plugin are:
  • Shows Child Pages in hierarchical fashion
  • Shows Attachment icon if page consists of attachments

Installation

This plugin comes bundled with Samepage.

Usage

To Insert this plugin click on the  button in WYSIWYG editor. From the list of plugins being shown in the screen, click on "Children Plugin".
To Edit a plugin, Right Click on the Plugin Syntax in the WYSIWYG Editor. Select "Edit this Plugin" from the Context Menu.
Below is the Screen shot of the screen that comes while inserting/editing a plugin.

Screenshot


Parameter Name
Description
Required
Example Value
Default Value
Project Name
User can type in the Project Name.
For User convinience, Auto complete has been implemented for this parameter.
As soon as the user types in first 2 characters, Samepage gives list of projects.
No
Sample Project
Current Project
Page Title  User can type in the Page Title.
For User convinience, Auto complete has been implemented for this parameter.
As soon as the user types in first 2 characters, Samepage gives list of pages for the project already selected.
No
Test Page
Current Page
Hierarchy Level
Based on this numerical value, the children tree will be by default opened to that level
No
1
1
Show Attachments
If this parameter is set to Yes, the user will see attachment icon in the Children Tree, if page has one or more attachments.
Option:
  • Yes - Show attachment icon
  • No - Do not show attachment icon
Yes
Yes
No


Sample Generated Syntax:
$children{projectname="Sample" title="Test Page" show="all"}

Output

Sample output is shown in the below screenshot

 Screenshot
  

Widgets

Widget is another view of a plugin which is used for customizable Dashboard. Each plugin can have one or many widgets associated with it.
Below is the list of Widgets available for Children Plugin.

Children Pages
This widget inserts a hierarchical list of all the child pages of the specified page in a specified project.
Below is the list of parameters available to customize this widget.

Parameter Name
Description
Required
Example Value
Default Value
Project Name
User can type in the Project Name.
For User convinience, Auto complete has been implemented for this parameter.
As soon as the user types in first 2 characters, Samepage gives list of projects.
No
Sample Project
Current Project
Page Title  User can type in the Page Title.
For User convinience, Auto complete has been implemented for this parameter.
As soon as the user types in first 2 characters, Samepage gives list of pages for the project already selected.
No
Test Page
Current Page
Hierarchy Level
Based on this numerical value, the children tree will be by default opened to that level
No
1
1
Show Attachments
If this parameter is set to Yes, the user will see attachment icon in the Children Tree, if page has one or more attachments.
Option:
  • Yes - Show attachment icon
  • No - Do not show attachment icon
Yes
Yes
No