]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/wikilink.mdwn
support arbitrary characters in page titles, via some ugly use of unicode
[git.ikiwiki.info.git] / doc / wikilink.mdwn
index 7891add7c5c0cb4326e203168854254ad8933135..1da5fb64d842fc46e25432a252fcdbefa4655c6e 100644 (file)
@@ -1,9 +1,25 @@
 WikiLinks provide easy linking between pages of the wiki. To create a
-WikiLink, just put the name of the page to link to in double brackets. For
-examples "[[ WikiLink ]]" (without the added whitespace). 
+[[WikiLink]], just put the name of the page to link to in double brackets.
+For example "\[[WikiLink]]".
+
+If you ever need to write something like "\[[WikiLink]] without creating a
+wikilink, just prefix it with a "\", like "\\\\[[WikiLink]]".
 
 Note that there are some special [[SubPage/LinkingRules]] that come into
 play when linking between [[SubPage]]s.
 
 WikiLinks can be entered in any case you like, the page they link to is
 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__]]
+  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.