]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/wikilink.mdwn
web commit by madmax
[ikiwiki.git] / doc / wikilink.mdwn
index a085ab7a72f374a64eded9c1a8f78063096c92fe..7e4ff0c2050699480f4b36e54853a11033723baa 100644 (file)
@@ -1,9 +1,9 @@
 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]]`.
 
 There are some special [[SubPage/LinkingRules]] that come into play when
 linking between [[SubPages|SubPage]].
@@ -15,12 +15,15 @@ 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.
 
-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]]
+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.
 
-To link to an anchor inside a page, you can use something like
-"\[[WikiLink#foo]]"
+(Note: previously, you could actually use spaces if you specify the target
+link following the pipe symbol (`|`), as in the above, but this has been
+disabled shortly after version 2.8).
 
-**Note that you cannot use spaces in WikiLinks**. Replace spaces with
-underscores.
+To link to an anchor inside a page, you can use something like
+`\[[WikiLink#foo]]`