Packaged Plugins
Plugins allow the user to add content from internal or external page onto the current page.
These plugins may be anything from adding a table of contents to adding a video feed.
They enable the user to create feature and function rich wiki pages.
To insert a plugin click on the   button on the WYSIWYG editor toolbar
The different types of plugins supported by SamePage are:
  1. RSS Plugin
  2. Calendar Plugin
  3. TOC Plugin
  4. Children Tree Plugin
  5. Redirect Plugin
  6. Include Plugin
  7. Flash Plugin
  8. Google Maps Plugin
  9. Google Videos Plugin
  10. YouTube Plugin
  11. 30 Boxes Calendar
  12. Google Calendar
For a complete list of the latest plugins, please check the support site at http://support.etouch.net/cm/wiki/?id=7421

RSS Plugin

The Really Simple Syndication (RSS) plugin enables the user to add a feed from other web sites onto the current work page.

General Syntax:

$FEED{ref="url", title="title to display", width="width", height="height", show_desc="true|false", show_heading="true|false", show_heading image="true|false", show_date="true|false", table_style="class name", tr_style="class name" td_style="class name", cols="no of columns to create for rendering", count="no of items to render"}


Example:

A simple markup for adding feed from CNN news
$FEED{ref="http://rss.cnn.com/rss/cnn_topstories.rss"}



Parameter
Description
ref
URL of the feed
If the feed is password protected, the username and password can be specified as part of URL

http://myserver/myfeed?username=guest&password=something
title Title to be displayed for the feed - optional
width Width of feed snippet - optional
Value be specified in pixels (eg:400px) or percentage (eg:40%)
height Height of the feed snippet - optional
Value can be specified in pixels (eg: 400 pix) or percentage (eg:40%)
show_desc
Shows description of each item in the feed - optional
Can be set to "True"  or "False" . Default setting is "True"
show_heading Shows heading of the feed - optional
Can be set to "True"  or "False" . Default setting is "True"
show_heading image
Shows heading image of the feed - optional
ta
Can be set to "True"  or "False" . Default setting is "True"
show_date Shows date for each item in the feed - optional
Can be set to "True"  or "False" . Default setting is "True"
table_style Stylesheet class for the table generated for showing the RSS feed
tr_style Stylesheet class for the tr generated for showing the RSS feed
td_style Stylesheet class for the tc generated for showing the RSS feed
cols Number of columns used for showing the feed, items are rendered from left-right and top-bottom in the table
count Number of items to show



All list pages on eTouch SamePage are available as RSS Feeds.
Either URL or the following simple syntax can be used for these feeds.
 $FEED{ref="listtype=listing type:count=no of items:projectname=name pf the project:param=value:param=value", other feed parameters like width, height etc may be specified}


 

 Note: The count parameter will work even if given outside the ref parameter. The count number has to be enclosed in quotes.

Example:

$FEED{ref="listtype=a2z:letter=B:projectname=P1" count="30"}



List type
Description Syntax/Parameters





a2z
A - Z listings

$FEED{ref="listtype=a2z:count=30:letter=B:projectname=P1"}

letter - optional
Pages only starting with this specific alphabet will be displayed

count - optional
no of items to be displayed per page


projectname - optional
name of the project. Default setting is the current project name

bcklnk Back Links

$FEED{ref="listtype=bcklnk:projectname=P1:title=Broadcast 

chief quits after 'conservative' probe"}

projectname - optional
name of the project. Default setting is the current project name

title - optional
title of the page for which back links have to be shown
Default setting is the current page.

 

child Child Pages
$FEED{ref="listtype=child:projectname=P1:title=home:count=30"}

projectname - optional
name of the project. Default setting is the current project name
title - optional
title of the page for which back links have to be shown
Default setting is the current page.
count - optional
no of items to be displayed per page

favorites Pages added to Favorites list
$FEED{ref="listtype=favorites:show_heading=false"}


ip In progress pages of that current user
$FEED{ref="listtype=ip:projectname=P1:count=30"}

projectname - optional
name of the project. Default setting is the current project name
count - optional
no of items to be displayed per page

mm Modified pages of that current user
$FEED{ref="listtype=mm:projectname=P1:count=30"}

projectname - optional
name of the project. Default setting is the current project name
count - optional
no of items to be displayed per page

rm Recently modified pages in a project
$FEED{ref="listtype=rm:projectname=P1:count=30"}

projectname - optional
name of the project. Default setting is the current project name
count - optional
no of items to be displayed per page

orphan Orphan pages in project
$FEED{ref="listtype=orphan:projectname=P1:count=30"}

projectname - optional
name of the project. Default setting is the current project name
count - optional
no of items to be displayed per page

tags
Topics in a project
$FEED{ref="listtype=topics:projectname=P1:count=30"}

projectname - optional
name of the project. Default setting is the current project name
count - optional
no of items to be displayed per page

tag Pages belonging to a topic in a project
$FEED{ref="listtype=topic:projectname=P1:topic=Politics: count=30"}

projectname - optional
name of the project. Default setting is the current project name
count - optional
no of items to be displayed per page


search
Search results
$FEED{ref="listtype=search:projectname=P1:searchtext=hello: count=30"}

projectname - optional
name of the project. Default setting is the current project name
searchtext - necessary
count - optional
no of items to be displayed per page


rnews
Recent news in a project
$FEED{ref="listtype=rnews:projectname=P1:count=30"}

projectname - optional
name of the project. Default setting is the current project name
count - optional
no of items to be displayed per page


rrange Monthly news in a project
$FEED{ref="listtype=rrange:projectname=P1:month=01-FEB-2006: count=30"}

projectname - optional
name of the project. Default setting is the current project name
count - optional
no of items to be displayed per page


projects All projects in a domain/account
$FEED{ref="listtype=projects"}

To get projects in which user is member/administrator (my projects)

$FEED{ref="listtype=projects:filter=my"}
rblogs
Recently updated blogs
$FEED{ref="listtype=rblogs"}

 This will display a list of recent blogs based on permissions.
rposts Recent Posts
$FEED{ref="listtype=rbposts:blogalias=blogaliasname"}


 This will display a list of recent posts

blogalias Blog Alias
$FEED{"bloglias=blogaliasname"}
This when combined with listtype=rbposts, will display the recent posts in the specified blog alias .
If not specified the recent posts for all blogs will be displayed.


Note:Tags were referred to as Topics in all SamePage versions before 3.3



Return to Top

Calendar Plugin


Features
  • User can enter events in different formats which will be available as a browseable calendar on the published page.
  • Repetitive events in the supported formats can be specified
  • Time of the event can be specified
  • Entry of events will be in the text form (using a particular syntax).
  • Repetitive formats include,
    • Day Of Week(e.g. 1st and 3rd Monday),
    • Last day of Month
    • First working day of month
    • Last working day of month.

  • Any number of calendar plugins can be embedded onto a single page.
  • Maximized view of calendar is available(click on  the maximize button in calendar).
  • Maximized view can also be embedded in the Wiki Page.

General Syntax
$CAL{month="mm" year="yyyy" view="full" events="mm-dd-yyyy(time;event1|time2;event2|event3)~mm-dd-yyyy(event4|event5|event6)" }



Parameter
Description
month
Starting month of the calendar display - optional
Example: 01 for JAN or 11 for NOV
If not specified, the current month is taken as the start month.

year Starting year of the calendar display - optional
Example: 2005
If not specified, the current year is taken as the start year

view
To display maximized view of the calendar, set view="full"
optional

events
List of events on the calendar
Events are to be specified by entering the date of the event(in mm-dd-yyyy or mm-DOW[N]-yyyy format) followed by the description of the event.
If multiple events are to be listed on the same date the events are separated by a pipe/vertical bar(|) symbol.

Date formats:
mm-dd-yyyy format
for 7th May 2007 , enter 05-07-2007

mm-DOW[N]-yyyy format

Day OF Week (DOW) can be MON, TUE, WED, THU, FRI, SAT or SUN
N can be anything between 1 - 5 (1st to 5th occurrence of the day) depending on the month
Example: for 3rd  Sunday of May,2007, enter 05-SUN[3]-2007

Event entry examples:
events="05-07-2007(1.00pm;Project Party|7.00pm;Project Release)~05-09-2007(10.00am;Client Meeting)"
This means that two events are scheduled for 7thMay 2007, the Project party at 1.00pm and the Project release at 7.00pm and a Client meeting is also scheduled for 9th May, 2007 at 10.00am.

events="*-MON[1]-*(9.30am;Monthly Status Review meeting)"
The * symbol in the month and year fields indicate that this is a recurring event, every month all year on the first Monday of every month at 9.30am.

Special entries supported by calendar:

ldom : Can be used in the date field to indicate the Last Day Of Month
lwdom : Can be used in the date field to indicate the Last Working Day Of Month
fwdom : Can be used in the date field to indicate the First Working Day Of Month
 


SamePage also supports Google Calendar and 30 Boxes calendar Plugins.


Return to Top

TOC Plugin

The TOC plugin creates a Table Of Contents based on either the format headings( H1 through H6) or the anchors in a page.
To add a TOC plugin use the following syntax in the plugin area.

General Syntax: 
$TOC{ show_div="" div_border_width="" div_border_style="" div_border_color="" div_bgcolor="" show_number="" show_header="" show_anchor=""}

Parameter
Description
show_div
To display the table of contents in a box
Optional, the values can be set to "yes" or "no"
Default setting is "no"
div_border_width Width of the border
Can be set to 1, 2...
Default setting is 1

div_border_style For the border style
Can be set to solid,dotted or none.
Default setting is solid

div_border_color For border color
Default is set to #cccccc

div_bgcolor For background color
Default is set to #F9F9F9

show_number To number the entries in the table of contents
Can be set to "yes" or "no"
Default setting is "no"

show_header To display a header with the caption "Contents"
Can be set to "yes" or "no"
Default setting is "no"

show_anchor To create the table of contents using on the anchors in the page instead of the headings H1 through H6
Can be set to "yes" or "no"
Default setting is "no"



Return to Top

Children Tree Plugin


  The Children Tree Plugin is used inserts an hierarchical list of all the child pages of the specified page in a specified project.

General Syntax:
$CHILDREN{title="pagetitle" projectname="project"}

Both the page title and project name are optional parameters. The default setting is the current page and the current project.

 

Iconic attachments indication in Child Plugin

 

The child plugin added to any page can have an optional attribute called 'showattachments'. By default this value will be null/false. You may optionally add this parameter as showattachments="true" in the child plugin to display the iconic attachments indication.

 

Note that if net.wiki.page.hierarchy.showattach global property is set to false, showattachments="true" on the child plugin will not show the attachments icon.

Return to Top



Redirect Plugin


The Redirect plugin as its name suggests is used to redirect to an internal page or an external url.

Redirection to an internal page:
General Syntax:
$redirect{title="pagename" projectname="projectname"}
The project name is an optional parameter.
By default it is taken as the current project

Redirection to an external URL:
General Syntax:
$redirect{src=http://www.yahoo.com/}



Return to Top

Include Plugin


The Include plugin allows the user to insert content from another wiki page onto the current page. The page from which the content is inserted can be from the same project or from a different project. The plugin can also be used to include content form external websites.

To include contents from another internal page:
General Syntax:
$INCLUDE{title="home" projectname="Support Home" style="width:800px;height:500px;border:none;overflow:hidden"}
This will include the contents of the home page of the project Support Home

To include contents from an external webpage:
General Syntax:
$INCLUDE{URL="http://www.yahoo.com/" style="width:800px;height:500px;border:none;overflow:hidden"}


Return to Top

Flash Plugin

This plugin allows the user to insert a Macromedia Flash object into the page.

General Syntax:
$flash{src="1019436" height="200" width="500"}

Parameter
Description
src Source of flash. It can either be a url or id of flash in SamePage.
height
Height of the Flash ih Pixels.It is necessary to provide this parameter.
width Width of the Flash is pixels.It is necessary to provide this parameter.
name Name of the Flash. Optional.
bgcolor Bacground Color. Optional to provide.
The default color setting is white.



Back to Top

Google Maps Plugin

This plugin is used to insert a google map of a particular location into a page.

General Syntax:
$gmap{address="Your full street address with state and zip code" width="640" height="480" controls="true" maptype="Map" zoom="13" marker="true"}

Parameter
Description
address
Address of the location complete with zip code.
This parameter has to be provided.
width Width of the map in pixels - Optional
The default value is set to 700px
height Height of the map in pixels - Optional
The default value is set to 500px
controls To show the map controls and enable dragging -Optional
The default value is set to True
maptype Type of the map - Optional
The 3 options to choose from are Maps, Satellite and Hybrid
By default it is set to Map
zoom Level of zoom - Optional
Default value is set to 13
marker Show the marker - Optional
The default value is set to True

Note: The Google Maps plugin is available only for On-Premises customers. To register and obtain the key click here.


Back to Top

Google Videos Plugin

This plugin is used to insert a google video into a page

General Syntax:
$gvideo{id="-152721602376073588" height="350" width="425"}

Parameter
Description
id Doc id of google video.This parameter needs to be provided.
height Height of embedded video in pixels - Optional
The default value is set to 350px
width Width of the embedded video in pixels - Optional
The default value is set to 425px



Back to Top

YouTube Plugin

This plugin is used to insert an YouTube video into a page

General Syntax:
$youtube{src="http://www.youtube.com/watch?v=NQmOmdYPKJQ" height="350" width="425"}

Parameter
Description
src
Source of the YouTube Video
This parameter needs to be provided
height Height of embedded video in pixels - Optional
The default value is set to 350px
width Width of the embedded video in pixels - Optional
The default value is set to 425px


Back to Top

30 Boxes Calendar

This plugin is used to insert a calendar from 30boxes.com

General Syntax
$30boxes{src="http://30boxes.com/widget/49292/SmallBusinessRadio/fd684d567ae1154282f8cc3af065b6cb/1/ALL" width="800" height="590"}
Parameter
Description
src
Source from 30boxes.com
This parameter needs to be provided
height Height of the display in pixels - Optional
The default value is set to 500px
width Width of the display in pixels - Optional
The default value is set to 700px


Back to Top

Google Calendar

This plugin is used to insert the google calendar

General Syntax
$gcalendar{src="http://www.google.com/calendar/feeds/k8nh6c42v8nrjp1te4nb4qutt4%40group.calendar.google.com/public/basic" width="100%" height="480" mode="month" title="Public Calendar"}

Parameter
Description
src
Address of the location
This parameter needs to be provided.
width
Width of display in pixels - Optional
The default value is set to 700px
height
Height of the display in pixels - Optional
The default value is set to 500px
mode
Type of Google Map are month,mini,agenda - Optional
The default value is month
title
Title for the calendar
controls
Show the calendar controls. Values can be navigation,all,none - Optional
The default value is set to navigation
eventsperday
Maximum number of events that should be shown - Optional
bgcolor
Background color - Optional

Back to Top