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