]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/wikilink.mdwn
web commit by http://solair.livejournal.com/
[ikiwiki.git] / doc / wikilink.mdwn
index 25c7586130784126ac95b841220d64b7fcd47f8e..301f71a7f0d407b3aabd6ce4c67d72c5c0719415 100644 (file)
@@ -1,29 +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]]`.
 
-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]]
 
-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]]`
 
-It's also possible to write a WikiLink that uses something other than the
-page name as the link text. For example "\[[foo|SandBox]]" links to the
-SandBox page, but the link will appear like this: [[foo|SandBox]]
+**Note that you cannot use spaces in WikiLinks**. Replace spaces with
+underscores.