LinkOptionsPlugin

It adds one third block to "Forced Specific Links" in the format:
[[URL or TopicName][Link Text][Option:value]]

Some new options and CSS sets can be used simultaneously, separated by a pipe (|):
[[URL or TopicName][Link Text][Option1:value1|Option2:value2|...|OptionN:valueN]]

---

Syntax Rules

Options	Values	Coment
NewWin	XxY	X and Y must be integer values. This option will open a new window with no menu, butons, or url bar, but it well have status bar
Name	Name	Name can be a target name (using fames) or the name of a new window
Title	Text	A text to be a hint for the link
Class	Name	The name of a class (to define CSS style)
ID	Name	This Name must be unique on the web page
Skin	SkinName	SkinName must be a valid TWiki skin
CSS	CSS Code	CSS Code is any CSS formatatin code. You can repeat this option color is a CSS properti, and you can put values like #00A0F0 or red. See more colors in StandardColors. You can use any CSS properti (valid for links) hire. See more in the CSS2 Specification in the W3C Web Site.

The option names are case insensitive for LinkOptionsPlugin or CSS, but the W3C defines the CSS properties in lower case and it is important to validade. Write the LinkOptionsPlugin optins as you prefer.

Examples

The text in Red:

• Code: [[WebHome][Start Page][Color:red|Title:Go to the Start!]]
• Expand to: Start Page
  • If installed: [[WebHome][Start Page][Color:red|Title:Go to the Start!]]

(Stop the mouse over the link to see the title)

Opening in other target:

• Code: [[http://www.gnu.org][the GNU web site][Name:_blank|Class:myclass|ID:myid]]
• Expand to: the GNU web site
  • If installed: [[http://www.gnu.org][the GNU web site][Name:_blank|Class:myclass|ID:myid]]

(_blank is no target. It will Open in a new window)

Opening in a new window (with options):

• Code: [[TWiki.TWikiVariables][See the TWiki Variables][NewWin:600x500|Name:winTWikiVariables|Skin:plain]]
• Expand to: See the TWiki Variables
  • If installed: [[TWiki.TWikiVariables][See the TWiki Variables][NewWin:600x500|Name:winTWikiVariables|Skin:plain]]

Crazy CSS use:

• Code: [[WebHome][Crazy Link!][color:green|background-color:#FFF0A0|border:3px dotted #FFC030|text-decoration:none|letter-spacing:10px|padding:4px|font-size:15px|font-weight:900]]
• Expand to: Crazy Link!
  • If installed: [[WebHome][Crazy Link!][color:green|background-color:#FFF0A0|border:3px dotted #FFC030|text-decoration:none|letter-spacing:10px|padding:4px|font-size:15px|font-weight:900]]

Plugin Settings

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

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Extends the "Forced Specific Links" syntax [[URL or TopicName][Link Text][Options]]

• Set DEBUG to 1 to get debug messages in data/debug.txt. Default: 0
  • 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 LinkOptionsPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/LinkOptionsPlugin.txt	Plugin topic
  data/TWiki/LinkOptionsPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/LinkOptionsPlugin.pm	Plugin Perl module

• Dakar: Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Test if the installation was successful. you should see rendered dates on the example session.

Plugin Info

Plugin Author:	TWiki:Main.AurelioAHeckert
Plugin Version:	27 Jul 2006 (v1.001)
Change History:
27 Jul 2006	(v1.001) - TWiki:Main.AntonioTerceiro: Dakar compatibility
29 Mar 2005	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.024
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
License:	GPL (GNU General Public License)
TWiki:Plugins/Benchmark:	GoodStyle 100%, FormattedSearch 100%, LinkOptionsPlugin 100%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/LinkOptionsPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/LinkOptionsPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/LinkOptionsPluginAppraisal

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.AurelioAHeckert - 29 Mar 2005