Parameter | Description | Default |
---|---|---|
"$script" |
Name of script | |
web |
Web name to add to URL | |
topic |
Topic (or Web.Topic) to add to URL | |
Any other parameters to the macro will be added as parameters to the URL |
%SCRIPTURLPATH{"view" topic="Cartoons.EvilMonkey"}%
expands to /Cartoons/EvilMonkey
%SCRIPTURLPATH{"view" web="Cartoons"}%
expands to /Cartoons?web=Cartoons
%SCRIPTURLPATH{"view" topic="Cartoons.EvilMonkey" rev="1"}%
will expand to /Cartoons/EvilMonkey?rev=1
%SCRIPTURLPATH{"edit" web="Cartoons" topic="EvilMonkey" t="%GMTIME{"$epoch"}%"}%
expands to /bin/edit/Cartoons/EvilMonkey?t=1731119039
%SCRIPTURLPATH%
expands to /bin
%SCRIPTURLPATH{script}%
expands to /bin/script
edit
script should always be used in conjunction with a t="%GMTIME{"$epoch"}%"
parameter to ensure pages about to be edited are not cached in the browser
See SCRIPTURL
if you expect to need the protocol and host e.g. if you are saving the HTML of the page and using it on a different host.
The 'old' way of building URLs using SCRIPTURLPATH
involved concatenating the web and topic names to the SCRIPTURLPATH
e.g. %SCRIPTURLPATH{"script"}%/Cartoons/EvilMonkey
. This practice is strongly discouraged, as it does not correctly handle encoding of the parts of the URL. At the first opportunity you should replace such URLs with the equivalent %SCRIPTURLPATH%{"script" topic="Cartoons.EvilMonkey"}%, which will handle URL encoding for you.
The SCRIPTURL macro does NOT support building jsonrpc
or rest
requests with parameters. They should still use the "contatenation" method. This is expected to be fixed in Foswiki 2.2.