SCRIPTURLPATH -- URL path of script(s)

Expands to the base URL of scripts, without protocol or host

Parameters

ParameterDescriptionDefault
"$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

Examples

  • %SCRIPTURLPATH{"view" topic="Cartoons.EvilMonkey"}% expands to /bin/view/Cartoons/EvilMonkey
  • %SCRIPTURLPATH{"view" web="Cartoons"}% expands to /bin/view/Cartoons?web=Cartoons
  • %SCRIPTURLPATH{"view" topic="Cartoons.EvilMonkey" rev="1"}% will expand to /bin/view/Cartoons/EvilMonkey?rev=1
  • %SCRIPTURLPATH{"edit" web="Cartoons" topic="EvilMonkey" t="%GMTIME{"$epoch"}%"}% expands to /bin/edit/Cartoons/EvilMonkey?t=1734977287
  • %SCRIPTURLPATH% expands to /bin
  • %SCRIPTURLPATH{script}% expands to /bin/script
HELP

The 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

HELP

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.

ALERT!

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.

ALERT!

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.

PUBURLPATH, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL

Topic revision: r1 - 2024-12-23, UnknownUser

This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback