web commit by http://madduck.myopenid.com/: clarify the legitimate use of spaces...

[ikiwiki.git] / doc / wikilink.mdwn

diff --git a/doc/wikilink.mdwn b/doc/wikilink.mdwn
index 1da5fb64d842fc46e25432a252fcdbefa4655c6e..9f4cb3876bf1b0774c6af2e622ce17950fff3c80 100644 (file)
--- a/doc/wikilink.mdwn
+++ b/doc/wikilink.mdwn
@@ -1,25 +1,27 @@
 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 example "\[[WikiLink]]".
+For example `\[[WikiLink]]`.
 
-If you ever need to write something like "\[[WikiLink]] without creating a
-wikilink, just prefix it with a "\", like "\\\\[[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.
+There are some special [[SubPage/LinkingRules]] that come into play when
+linking between [[SubPages|SubPage]].
 
-WikiLinks can be entered in any case you like, the page they link to is
-always lowercased.
+Also, if the file linked to by a WikiLink looks like an image, it will
+be displayed inline on the page.
 
-While a WikiLink is limited to alphanumerics and only a few special
-charaters, it is possible to create page names containing other characters:
+WikiLinks are matched with page names in a case-insensitive manner, so you
+don't need to worry about getting the case the same, and can capitalise
+links at the start of a sentence, and so on.
 
-* 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.
+It's also possible to write a WikiLink that uses something other than the page
+name as the link text. For example `\[[foo_bar|SandBox]]` links to the SandBox
+page, but the link will appear like this: [[foo_bar|SandBox]]. The reason you
+**have to use underscores in place of spaces in WikiLinks** is so that `ikiwiki`
+can distinguish your WikiLink from a PreprocessorDirective.
+(Note: you *can* actually use spaces if you specify the target link following the
+pipe symbil (`|`), as in the above.
 
-Note that if the file linked to by a WikiLink looks like an image, it will
-be displayed inline on the page.
+To link to an anchor inside a page, you can use something like
+`\[[WikiLink#foo]]`
\ No newline at end of file