diff --git a/data/System/VarWEBLINK.txt b/data/System/VarWEBLINK.txt new file mode 100644 index 0000000..818e3de --- /dev/null +++ b/data/System/VarWEBLINK.txt @@ -0,0 +1,22 @@ +%META:TOPICINFO{author="micha" comment="" date="1291041934" format="1.1" version="2"}% +#VarWEBLINK +---+++ WEBLINK + * create a link to a web + * Syntax: =%WEBLINK{web="..." name="..."}%= + * Supported parameters: + | *Parameter:* | *Description:* | *Default:* | + | ="web"= | name of the web to link to | BASEWEB | + | =name="..."= | name to display instead of the web name | BASEWEB (its tail in case it is a subweb) | + | =format="..."= | format string for the web link | <a class="webLink $marker" href="$url" title="%ENCODE{"$tooltip" type="html"}%">$title</a> | + | =marker="..."= | string to be inserted into the format string if the web link points to the current web | current | + | =class="..."= | css class used within the web link | webLink | + +The following variables can be used in the format string: + * $web: full qualified name of the web to link to + * $topic: name of the topic to link to, defaults to %HOMETOPIC% + * $title: title of the WebHome topic; this is either the topic name or its title as returned when Foswiki:Extensions/DBCachePlugin is installed + * $name: name of the web, that is the tail of the web specification with all parent webs stripped off + * $url: url for the link + * $marker: the marker set to the "marker" string if the link points to the current web + * $tooltip: tooltip for the link, mostly used in a =title= argument of an anchor + diff --git a/data/System/WebLinkPlugin.txt b/data/System/WebLinkPlugin.txt index a13a8b5..b2c3224 100644 --- a/data/System/WebLinkPlugin.txt +++ b/data/System/WebLinkPlugin.txt @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="micha" comment="" date="1291041934" format="1.1" version="2"}% +%META:TOPICINFO{author="ProjectContributor" comment="" date="1291041934" format="1.1" version="2"}% ---+!! %TOPIC% %SHORTDESCRIPTION% diff --git a/lib/Foswiki/Plugins/WebLinkPlugin/MANIFEST b/lib/Foswiki/Plugins/WebLinkPlugin/MANIFEST index 2313bd2..6786db2 100644 --- a/lib/Foswiki/Plugins/WebLinkPlugin/MANIFEST +++ b/lib/Foswiki/Plugins/WebLinkPlugin/MANIFEST @@ -1,3 +1,4 @@ data/System/WebLinkPlugin.txt 0644 +data/System/VarWEBLINK.txt 0644 lib/Foswiki/Plugins/WebLinkPlugin/Core.pm 0644 lib/Foswiki/Plugins/WebLinkPlugin.pm 0644