support [[linktext|pagename]] links

[ikiwiki.git] / doc / wikilink.mdwn

diff --git a/doc/wikilink.mdwn b/doc/wikilink.mdwn
index 1da5fb64d842fc46e25432a252fcdbefa4655c6e..25c7586130784126ac95b841220d64b7fcd47f8e 100644 (file)
--- a/doc/wikilink.mdwn
+++ b/doc/wikilink.mdwn
@@ -14,12 +14,16 @@ always lowercased.
 While a WikiLink is limited to alphanumerics and only a few special
 charaters, it is possible to create page names containing other characters:
 
-* To display a page name with a space in it, use "_" in the WikiLink, for
-  example, [[Multi_Word_Page_Name]]. 
-* For any other special character, you can use "__nnnn__" where `nnnn` is the
-  unicode character number. For example,
-  [[This_page_name_is__44___uselessly__44___a_complete_sentence__46__]]
+* To display a page name with a space in it, use "\_" in the WikiLink, for
+  example, "\[[Multi\_Word\_Page\_Name]]". 
+* For any other special character, you can use "\_\__nnnn_\_\_" where
+ _nnnn_ is the unicode character number. For example,
+  "\[[This\_page\_name\_is\_\_44\_\_\_uselessly\_\_44\_\_\_a\_complete\_sentence\_\_46\_\_]]"
   Limiting use of this to when you really need it is a good idea.
 
 Note that if the file linked to by a WikiLink looks like an image, it will
 be displayed inline on the page.
+
+It's also possible to write a WikiLink that uses something other than the
+page name as the link text. For example "\[[foo|SandBox]]" links to the
+SandBox page, but the link will appear like this: [[foo|SandBox]]