JSPopupPlugin TWiki Plugin

JSPopupPlugin allows you to show dynamic content in a virtual popup. Good for status messages, or to show detailed information without causing the web browser's context to switch from the page that they requested.

There is a running demo of JSPopupPlugin running at the WikiRing demo site

NEW: Uses TWiki:Plugins.YahooUserInterfaceContrib

It uses javascript to create a popup window containing either a hidden pre-rendered part of a topic, or a TWiki request that is dynamically requested and served. Popups are activated either on a mouse click, when the mouse passes over the anchor, or when the page is loaded.

This will allow you to create a popup Comment Edit box:

%POPUP{anchor="<button class='twikiButton'>add comment</button>" popuptext="%COMMENT%" popuptexttype="tml"}%

or a popup menu of webs

%POPUP{
anchor=" *listofwebs* " 
anchortype="onmouseover" 
popuptext="%WEBLIST{"| [[$name.WebHome][$name]] |"}%" 
popuptexttype="tml" 
popuplocation="below"
border="off"
}%

or a popup that quickly shows the topic source

%POPUP{
anchor="<button class='twikiButton'>view topic Source</button>"
popuptitle="%TOPIC%"
popuptext="%SCRIPTURL{view}%/%WEB%/%TOPIC%?raw=on;skin=print"
popuptexttype="rest"
}%

there is only one popup window at a time, so if the clicks on an anchor while another popup is up, it will be replaced by the new one.

Syntax Rules

%POPUP{}%

parameters are

• anchor="" - the text that is the click target that causes the POPUP to come up
  • (if this is not set, or an empty string, then the popup is shown on page load REMEMBER, only one popup open at a time)
• anchortype="" - action done to trigger the popup - onclick,onmouseover ('onclick' is default)
• popuptitle="" - what will be displayed in the popup title (not shown if border="off")
• popuptext="" - what will be displayed in the popup
• popuptexttype ="" - tml, rest
• popuplocation="" - general location relative to the anchor (center, below) - center is default
• border="" - show the border & close button (defaults to 'on') - if you select not to show the border and close button then there is an onmouseleave that closes the window
• delay=200 - used as the delay in mS if the anchortype='mouseover'

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %JSPOPUPPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Creates a dynamic popup window

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip JSPopupPlugin.zip in your twiki installation directory. Content: File:Description:data/TWiki/JSPopupPlugin.txt Plugin topic data/TWiki/JSPopupPlugin.txt,v Plugin topic repository lib/TWiki/Plugins/JSPopupPlugin.pm Plugin Perl module
• use the configure script to enable
• Test if the installation was successful:

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- SvenDowideit@wikiring.com - WikiRing.com