Tell robots to noindex,follow basewiki pages
[ikiwiki.git] / 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 Also, if the file linked to by a WikiLink looks like an image, it will
13 be displayed inline on the page.
14
15 WikiLinks are matched with page names in a case-insensitive manner, so you
16 don't need to worry about getting the case the same, and can capitalise
17 links at the start of a sentence, and so on.
18
19 It's also possible to write a WikiLink that uses something other than the page
20 name as the link text. For example `\[[foo_bar|SandBox]]` links to the SandBox
21 page, but the link will appear like this: [[foo_bar|SandBox]].
22
23 To link to an anchor inside a page, you can use something like
24 `\[[WikiLink#foo]]`
25
26 ## Preprocessor directives and wikilinks
27
28 ikiwiki has two syntaxes for
29 [[preprocessor_directives|PreprocessorDirective]].  The older syntax
30 used spaces to distinguish between preprocessor directives and
31 wikilinks; as a result, with that syntax in use, you cannot use spaces
32 in WikiLinks, and must replace spaces with underscores.  The newer
33 syntax, enabled with the `prefix_directives` option in an ikiwiki
34 setup file, prefixes directives with `!`, and thus does not prevent
35 links with spaces.  Future versions of ikiwiki will turn this option
36 on by default.