/
VarWEBLINK.txt
24 lines (22 loc) · 1.48 KB
/
VarWEBLINK.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
%META:TOPICINFO{author="ProjectContributor" comment="" date="1527934709" format="1.1" version="1"}%
%META:TOPICPARENT{name="WebLinkPlugin"}%
#VarWEBLINK
---+++ WEBLINK
* create a link to a web
* Syntax: =%<nop>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 | <code><a class="webLink $marker" href="$url" title="%<nop>ENCODE{"$tooltip" type="html"}%">$title</a></code> |
| =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 <nop>%HOMETOPIC%
* $title: title of the <nop>WebHome topic; this is either the topic name or its title
* $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
* $summary: web summary as defined in the WEBSUMMARY preference variable