public Function tag - url

Contents [ show ]
The function tags are developed by the WordFrame team. They can be used everywhere in the public site in HTML, javascripts, etc. and will be substituted with the real values when the HTML is rendered. Function tags can be inserted as:
{{ function_tag: parameter }}   or   {{ function_tag: parameter $|$ option_1 $|$ option_2 }}

Usage details for functional tag url

tag parameter (description) options (description) example
url site-domain
will be substituted with the default site domain plus protocal and port. This is very usefull to achieve absolute URL, as all other url tags are relative (ex. http://wordframe.com:8080)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: site-domain }}
{{ url: site-domain $|$ encode}}
url site-root
will be substituted with the relative path to the site's root URL. (ex. /app-path/)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: site-root }}
{{ url: site-root $|$ encode}}
url app-root
will be substituted with the relative path to the root URL node of the application that manages the webframe in which the tag is rendered. (ex. /app-path/application-root/)
option_1 ( encode )
or option_1 ( application name ) (not required) if "encode" command is set, the URL will be presented in encoded format. Instead of "encode", you can write an application name. In this case the URL will be always to the set application, and will not vary according the URL node's application.
{{ url: app-root }}
{{ url: app-root $|$ encode}}
{{ url: app-root $|$ blog}}
url current
will be substituted with the relative path to current page URL. (ex. /some-url/)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: current }}
{{ url: current $|$ encode}}
url referrer
will be substituted with the absolute path to the referrer URL. (ex. http://domain.com/some-url/)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: referrer }}
{{ url: referrer $|$ encode}}
url login
will be substituted with the relative path to the site's login URL. (ex. /app-path/login/)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: login }}
{{ url: login $|$ encode}}
url logout
will be substituted with the relative path to the site's logout URL. (ex. /app-path/logout/)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: logout }}
{{ url: logout $|$ encode}}
url register
will be substituted with the relative path to the site's registration URL. (ex. /app-path/registration/)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: register }}
{{ url: register $|$ encode}}
url forgot-password
will be substituted with the relative path to the site's forgot-password URL. (ex. /app-path/forgot-password/)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: forgot-password }}
{{ url: forgot-password $|$ encode}}
url user-profile
will be substituted with the relative path to the site's user profile URL. (ex. /app-path/user/)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: user-profile }}
{{ url: user-profile $|$ encode}}
url email-verification
will be substituted with the relative path to the site's email verification URL. (ex. /app-path/email-verification/)
option_1 ( encode )
(not required) if "encode" command is set, the URL will be presented in encoded format.
{{ url: email-verification }}
{{ url: email-verification $|$ encode}}
url node-guid
will be substituted with the relative path to the URL of the node with the submited as option_1 GUID. (ex. /app-path/site/)
option_1 ( GUID )
(required) the guid of the target node.
option_2 ( URL)
(not required) this URL will be returned if the set GUID does not correspond to an existing url node. If the default URL is not submitted, the sites-root will be returned by the system.
{{ url: node-guid $|$ 9c993f05-cd26-4da3-b22f-9ed871e43da5 }}
{{ url: node-guid $|$ 9c993f05-cd26-4da3-b22f-9ed871e43da5 $|$ http://wordframe.com}}
{{ url: node-guid $|$ 9c993f05-cd26-4da3-b22f-9ed871e43da5 $|$ /site/images/}}
Last edited by nadia on 26 Oct 2010 | Rev. 2 | This page is public | Views: 1
Comments: 0 | Filed under: root | Tags: