web commit by JoshTriplett
[ikiwiki.git] / doc / wikilink.mdwn
1 WikiLinks provide easy linking between pages of the wiki. To create a
2 [[WikiLink]], just put the name of the page to link to in double brackets.
3 For example "\[[WikiLink]]".
4
5 If you ever need to write something like "\[[WikiLink]]" without creating a
6 wikilink, just prefix it with a "\", like "\\\\[[WikiLink]]".
7
8 There are some special [[SubPage/LinkingRules]] that come into play when
9 linking between [[SubPages|SubPage]].
10
11 Also, if the file linked to by a WikiLink looks like an image, it will
12 be displayed inline on the page.
13
14 WikiLinks are matched with page names in a case-insensitive manner, so you
15 don't need to worry about getting the case the same, and can capitalise
16 links at the start of a sentence, and so on.
17
18 It's also possible to write a WikiLink that uses something other than the
19 page name as the link text. For example "\[[foo_bar|SandBox]]" links to the
20 SandBox page, but the link will appear like this: [[foo_bar|SandBox]]
21
22 To link to an anchor inside a page, you can use something like
23 "\[[WikiLink#foo]]"
24
25 **Note that you cannot use spaces in WikiLinks**. Replace spaces with
26 underscores.