]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/wikilink.mdwn
comment
[ikiwiki.git] / doc / wikilink.mdwn
index 9586bfa44da2fe33a03889aa26e86695211a23b1..301f71a7f0d407b3aabd6ce4c67d72c5c0719415 100644 (file)
@@ -1,24 +1,26 @@
 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]]`.
 
-The file name associated with a wiki link is create as follows: capital
-letters converted to lower case and spaces to underscores.  Finally,
-the file extention is added.
-
-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 [[SubPage]]s.
+linking between [[SubPages|SubPage]].
 
 Also, if the file linked to by a WikiLink looks like an image, it will
 be displayed inline on the page.
 
-WikiLinks are matched with page names in a case-insensative manner, so you
+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
+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]]
+
+To link to an anchor inside a page, you can use something like
+`\[[WikiLink#foo]]`
+
+**Note that you cannot use spaces in WikiLinks**. Replace spaces with
+underscores.