]> sipb.mit.edu Git - ikiwiki.git/blob - doc/wikilink.mdwn
web commit by joey
[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 Note that there are some special [[SubPage/LinkingRules]] that come into
9 play when linking between [[SubPage]]s.
10
11 WikiLinks can be entered in any case you like, the page they link to is
12 always lowercased.
13
14 While a WikiLink is limited to alphanumerics and only a few special
15 charaters, it is possible to create page names containing other characters:
16
17 * To display a page name with a space in it, use "\_" in the WikiLink, for
18   example, "\[[Multi\_Word\_Page\_Name]]". 
19 * For any other special character, you can use "\_\__nnnn_\_\_" where
20  _nnnn_ is the unicode character number. For example,
21   "\[[This\_page\_name\_is\_\_44\_\_\_uselessly\_\_44\_\_\_a\_complete\_sentence\_\_46\_\_]]"
22   Limiting use of this to when you really need it is a good idea.
23
24 Note that if the file linked to by a WikiLink looks like an image, it will
25 be displayed inline on the page.
26
27 It's also possible to write a WikiLink that uses something other than the
28 page name as the link text. For example "\[[foo|SandBox]]" links to the
29 SandBox page, but the link will appear like this: [[foo|SandBox]]