web commit by http://www.larted.org.uk/~dom/: patch

[git.ikiwiki.info.git] / doc / wikilink.mdwn

diff --git a/doc/wikilink.mdwn b/doc/wikilink.mdwn
index 03cb2b3c39f63acd89d5fd2bf814371e11f28c5d..38df00f86ea42b3c57da07c414e02f8387e330b9 100644 (file)
--- a/doc/wikilink.mdwn
+++ b/doc/wikilink.mdwn
@@ -1,11 +1,27 @@
 WikiLinks provide easy linking between pages of the wiki. To create a
 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]]`.

 
 

-Note that there are some special [[SubPage/LinkingRules]] that come into
-play when linking between [[SubPage]]s.
+If you ever need to write something like `\[[WikiLink]]` without creating a
+wikilink, just prefix it with a `\`, like `\\[[WikiLink]]`.

 
 

-WikiLinks can be entered in any case you like, the page they link to is
-always lowercased.
+There are some special [[SubPage/LinkingRules]] that come into play when
+linking between [[SubPages|SubPage]].

 
 

-Note that if the file linked to by a WikiLink looks like an image, it will be displayed inline on the page.
\ No newline at end of file
+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-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]].
+
+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. The presence of spaces is used to distinguish between a
+[[PreprocessorDirective]] and a WikiLink.