xowiki::Page instproc pretty_link (public)

 <instance of xowiki::Page> pretty_link [ -anchor anchor ] \
    [ -query query ] [ -absolute on|off ] [ -siteurl siteurl ] \
    [ -lang lang ] [ -download download ] [ -path_encode on|off ]

Defined in /var/www/openacs.org/packages/xowiki/tcl/xowiki-procs.tcl

This method is a convenience stub for Package->pretty_link and can be overloaded for different pages types. Note that it is necessary to initialize the package before this method can be used.

Switches:

-anchor (optional)

anchor to be added to the link

-query (optional)

query parameters to be added literally to the resulting URL

-absolute (optional, boolean, defaults to "false")

make an absolute link (including protocol and host)

-siteurl (optional)

-lang (optional)

use the specified 2 character language code (rather than computing the value)

-download (optional, defaults to "false")

create download link (without m=download)

-path_encode (optional, boolean, defaults to "true")

control encoding of the url path. Returns the URL path urlencoded, unless path_encode is set to false.

Returns:

the pretty_link for the current page

See Also:

• xowiki::Package instproc pretty_link

Testcases:

xowiki_test_cases, nested_self_references

Source code:

if {${:parent_id} eq "0"} {
  set msg "you must not call pretty_link on a page with parent_id 0"
  ad_log error $msg
  error $msg
}
${:package_id} pretty_link -parent_id ${:parent_id}  -anchor $anchor -query $query -absolute $absolute -siteurl $siteurl  -lang $lang -download $download -page [self]  -path_encode $path_encode  ${:name}

XQL Not present:

Generic, PostgreSQL, Oracle