]> sipb.mit.edu Git - ikiwiki.git/blob - doc/wikilink.mdwn
894cfdbfe529b2e0596d97d52180352b873e0e49
[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 page
19 name as the link text. For example `\[[foo_bar|SandBox]]` links to the SandBox
20 page, but the link will appear like this: [[foo_bar|SandBox]]. The reason you
21 have to (well, *should*) use underscores in place of spaces is so that
22 `ikiwiki` can distinguish your WikiLink from a PreprocessorDirective.
23
24 To link to an anchor inside a page, you can use something like
25 `\[[WikiLink#foo]]`
26
27 **Note that you cannot use spaces in WikiLinks**. Replace spaces with
28 underscores.