Home > Contents > Index >
Creates a URL for an asset, processing the arguments passed to it from the calling element into a URL-encoded string and returning it in a variable. A vanity URL will be used if available.
<RENDER.GETPAGEURL OUTSTR="theURLVariable" PAGENAME="SiteCatalogPageEntry" [CID="Asset ID]" [C="AssetType"] [P="Id of parent page asset"] [d="Device Group Suffix"] [resolvetemplatefordevice="A boolean value indicating whether parameter 'd' should be ignored or not."] [ADDSESSION="true|false"] [DYNAMIC="true|false"] [DEPTYPE="exists|none"] [WRAPPERPAGE="name of uncached wrapper page"] [PACKEDARGS="stringFromPACKARGStag"] [ASSEMBLER="uri assembler shortform"] [CONTAINER="servlet|portlet"] [FRAGMENT="fragment value"] [SATELLITE="true|false"] [SCHEME="scheme value"] [AUTHORITY="authority value"] [WEBROOTNAME="webroot%quot;] > [<RENDER.ARGUMENT NAME="xxx"
VALUE="y
"/>] </RENDER.GETPAGEURL>
outstr
(required)pagename
(required)cid
(optional)c
and cid
are required parameters by the SiteCatalog entry.c
(optional)c
(asset type) is not supplied, rendermode
is set to export
, and assets of this type have a Filename field, then the file name that the Export to Disk publishing method creates for the asset does not include the information from the Filename field of the asset. We strongly recommend that you supply a value for c
.p
(optional)d
(optional)resolvetemplatefordevice
(optional)addsession
(optional)true
means to encode session IDs in the URL. If this parameter is not specified, it is set to true
by default.dynamic
(optional)true
means to create a dynamic URL even if rendermode
is set to export
. false
means to create a static URL if rendermode
is set to export
. If this parameter is not specified, it is set to false
by default.deptype
(optional)exists
, or none
. exists
(default) specifies that any version of the asset satisfies the dependency condition; none
specifies no approval dependency on the asset.wrapperpage
(optional)packedargs
. Such arguments will need to be unpacked before accessing. Standard arguments such as c
, cid
, and p
will be preserved and not packed.packedargs
(optional)assembler
(optional)container
(optional)servlet
should be sufficient. Legal values are servlet
and portlet
. fragment
(optional)http://www.myhost.com/foo.html#thirdParagraph
. satellite
(optional) true
(Satellite Server URL) and false
(Sites URL). scheme
(optional, required if authority is set)http
or https
. If this is left blank (and authority
is left blank) then the URL will be relative to the current scheme and authority. authority
(optional, required if scheme is set) scheme
. URLs are of the form scheme://authority/path?query#fragment
. For most purposes, authority corresponds to host:port
for the given application. Specifying scheme
and authority
allows for fully-qualified URLs to be created, which is useful for sites with multiple domains and in other cases.webrootname
(optional)RENDER.ARGUMENT (optional)
This tag creates URLs for assets that are not blobs. NOTE: if you are creating links to assets that are being rendered through templates, you should use the RENDER.GETTEMPLATEURL
tag instead.
If rendermode
is set to export,
the tag creates a static URL (that is, a file name for an HTML file) and returns it as a variable. It creates the URL based on the standard Sites page criteria variables c
, cid
, and p
, a page name from a SiteCatalog entry, and other parameters that are described in the following section.
If rendermode
is set to live
, the tag creates a dynamic URL according to the rules goverend by the current URL assembler.
Based on this information, the tag creates a URL for the asset and returns it to the element that requested it in the variable specified by the outstr
parameter. The requesting element can then use the variable to create a hyperlink for the asset.
NOTE: rendermode
is set by the system. Users should not explicitly set it.
NoteYou use |
There are no possible errno
for this tag.
The following example is in JSP but the XML syntax is analogous. This code creates a URL for an article asset and stores it in a variable named "theURL":
<render:getpageurl pagename="BurlingtonFinancial/Article/Full" cid='<%=ics.GetVar("asset.id")%>' c="Article" outstr="theURL" /> <a href='<%=ics.GetVar("theURL")%>'> <ics:getvar name='asset:name'/> </a>
This code creates a link to a page displaying a CO_Content asset using a wrapper page:
<render:getpageurl pagename="CO/CO_Container" cid='<%=ics.GetVar("cid")%>' c="CO_Content" wrapperpage="CO_WrapperPage" outstr="theURL" /> <a href='<%=ics.GetVar("theURL")%>'> <ics:getvar name='asset:name'/> </a>