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 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

(boolean) (defaults to "false") (optional)

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

(defaults to "false") (optional)

create download link (without m=download)

-path_encode

(boolean) (defaults to "true") (optional)

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

Partial Call Graph (max 5 caller/called nodes):

Testcases:

xowiki_test_cases, nested_self_references