LinkOptionsPlugin < TWiki

Tags: , view all tags
---+!! <nop>%TOPIC%
<!--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/LinkOptionsPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/LinkOptionsPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

---++ Introduction

This plugin adds one third block to _"Forced Specific Links"_ in the format: %BR%
==[<nop>[URL or <nop>TopicName][Link Text][Option:value]]==

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

---++ Syntax Rules

|  *Options*  |  *Values*  |  *Coment*  |
|  ==NewWin==  |  %GREEN%X%ENDCOLOR%x%GREEN%Y%ENDCOLOR%  | %GREEN%X%ENDCOLOR% and %GREEN%Y%ENDCOLOR% 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==  |  %GREEN%Name%ENDCOLOR%  | %GREEN%Name%ENDCOLOR% can be a target name (using fames) or the name of a new window |
|  ==Title==  |  %GREEN%Text%ENDCOLOR%  | A text to be a hint for the link |
|  ==Class==  |  %GREEN%Name%ENDCOLOR%  | The name of a class (to define CSS style) |
|  ==ID==  |  %GREEN%Name%ENDCOLOR%  | This %GREEN%Name%ENDCOLOR% must be unique on the web page |
|  ==Skin==  |  %GREEN%<nop>SkinName%ENDCOLOR%  | %GREEN%SkinName%ENDCOLOR% must be a valid TWiki skin |
|  ==CSS==  |  %GREEN%CSS Code%ENDCOLOR%  | %GREEN%CSS Code%ENDCOLOR% is any valid CSS property and value that would apply to hyper links. You can insert as many properties as you like. For Example, ==color== is a CSS property, and you can put values like =%GREEN%#00A0F0%ENDCOLOR%= or =%GREEN%red%ENDCOLOR%=. See more colors in %TWIKIWEB%.StandardColors. See more in the [[http://www.w3.org/TR/REC-CSS2/cover.html#minitoc][CSS2 Specification in the W3C Web Site]] for CSS Link appropriate properties. |

The option names are case <strong><em>in</em></strong>sensitive for LinkOptionsPlugin or !CSS, but the !W3C defines that !CSS properties should be in lower case and it is important to code validation. The LinkOptionsPlugin options will work any way you prefer.

---++ Examples

The text in Red:

   * *Code:* =[<nop>[WebHome][Start Page][Color:red|Title:Go to the Start!]]=
   * *Expand to:* <a href="WebHome" title="Go to the Start!" style="color:red;">Start Page</a>
      * *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:* =[<nop>[http://www.gnu.org][the GNU web site][Name:_blank|Class:myclass|ID:myid]]=
   * *Expand to:* <a href="http://www.gnu.org" class="myclass" id="myid" target="_blank">the GNU web site</a>
      * *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:* =[<nop>[%SYSTEMWEB%.TWikiVariables][See the TWiki Variables][NewWin:600x500|Name:winTWikiVariables|Skin:plain]]=
   * *Expand to:* <a href="%SCRIPTURL{view}%/%SYSTEMWEB%/TWikiVariables?skin=plain" target="winTWikiVariables"\
 onclick="open('%SCRIPTURL{view}%/%SYSTEMWEB%/TWikiVariables?skin=plain',\
 'winTWikiVariables', 'titlebar=0,width=600,height=500,resizable,scrollbars'); return false;">See the TWiki Variables</a>
      * *If installed:* [[%SYSTEMWEB%.TWikiVariables][See the TWiki Variables][NewWin:600x500|Name:winTWikiVariables|Skin:plain]]

Crazy CSS use:

   * *Code:* =[<nop>[<nop>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:* <a  style="color:green; background-color:#FFF0A0; border:3px dotted #FFC030; text-decoration:none; letter-spacing:10px; padding:4px; font-size:15px; font-weight:900; " class="twikiLink" href="/twiki/bin/view/TWiki/WebHome">Crazy Link!</a>
      * *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 ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%==

   * One line description, shown in the %SYSTEMWEB%.TextFormattingRules topic:
      * Set SHORTDESCRIPTION = Extends the _"Forced Specific Links"_ syntax ==[<nop>[URL or <nop>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 repository on twiki.org (see below)
   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
     | *File:* | *Description:* |
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
     | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository |
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
   * 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 [[#Examples][example session]].

---++ Plugin Info

|  Plugin Author: | TWiki:Main.AurelioAHeckert |
|  Copyright: | &copy; 2005-2006, TWiki:Main.AurelioAHeckert <br /> &copy; 2006-2010 TWiki:TWiki.TWikiContributor |
|  Plugin Version: | 2010-12-11 (v1.1) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2010-12-11: | TWikibug:Item6530: Doc improvements, changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.ScottGutman |
|  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 ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  TWiki:Plugins/Benchmark: | %SYSTEMWEB%.GoodStyle 100%, %SYSTEMWEB%.FormattedSearch 100%, %TOPIC% 100% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ %SYSTEMWEB%.TWikiPreferences, %SYSTEMWEB%.TWikiPlugins
Topic revision: r2 - 2014-04-30 - TWikiAdminUser
Account
- Log In
Edit
Attach
Copyright © 1999-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.LinkOptionsPlugin.