xowiki::Package instproc pretty_link (public)
<instance of xowiki::Package> pretty_link [ -anchor anchor ] \ [ -query query ] [ -absolute on|off ] [ -siteurl siteurl ] \ [ -lang lang ] [ -parent_id parent_id ] [ -download on|off ] \ [ -context_url context_url ] [ -folder_ids folder_ids ] \ [ -path_encode on|off ] [ -page page ] name
Defined in packages/xowiki/tcl/package-procs.tcl
Generate a (minimal) link to a wiki page with the specified name. Practically all links in the xowiki systems are generated through this method. The method returns the URL path urlencoded, unless "-path_encode" is set to false.
- 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)
- -parent_id
(optional)- parent_id
- -download
(boolean) (defaults to"false"
) (optional)- create download link (without m=download)
- -context_url
(optional)- -folder_ids
(optional)- -path_encode
(boolean) (defaults to"true"
) (optional)- control URL encoding of the path segmemts
- -page
(optional)- Parameters:
- name - name of the wiki page
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- link_tests