X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/0a95ac2144de8552eeebabd6467bf25969352240..1debcdaeaaaa34d4a3e1d221eba33349ecfd4186:/doc/wikilink.mdwn diff --git a/doc/wikilink.mdwn b/doc/wikilink.mdwn index 6051fe120..7e4ff0c20 100644 --- a/doc/wikilink.mdwn +++ b/doc/wikilink.mdwn @@ -1,19 +1,29 @@ WikiLinks provide easy linking between pages of the wiki. To create a [[WikiLink]], just put the name of the page to link to in double brackets. -For example "\[[WikiLink]]". +For example `\[[WikiLink]]`. -If you ever need to write something like "\[[WikiLink]] without creating a -wikilink, just prefix it with a "\", like "\\\\[[WikiLink]]". +If you ever need to write something like `\[[WikiLink]]` without creating a +wikilink, just prefix it with a `\`, like `\\[[WikiLink]]`. -Note that there are some special [[SubPage/LinkingRules]] that come into -play when linking between [[SubPage]]s. +There are some special [[SubPage/LinkingRules]] that come into play when +linking between [[SubPages|SubPage]]. -WikiLinks can be entered in any case you like, the page they link to is -always lowercased. - -Note that if the file linked to by a WikiLink looks like an image, it will +Also, if the file linked to by a WikiLink looks like an image, it will be displayed inline on the page. -It's also possible to write a WikiLink that uses something other than the -page name as the link text. For example "\[[foo|SandBox]]" links to the -SandBox page, but the link will appear like this: [[foo|SandBox]] +WikiLinks are matched with page names in a case-insensitive manner, so you +don't need to worry about getting the case the same, and can capitalise +links at the start of a sentence, and so on. + +It's also possible to write a WikiLink that uses something other than the page +name as the link text. For example `\[[foo_bar|SandBox]]` links to the SandBox +page, but the link will appear like this: [[foo_bar|SandBox]]. The reason you +**have to use underscores in place of spaces in WikiLinks** is so that +`ikiwiki` can distinguish your WikiLink from a PreProcessorDirective. + +(Note: previously, you could actually use spaces if you specify the target +link following the pipe symbol (`|`), as in the above, but this has been +disabled shortly after version 2.8). + +To link to an anchor inside a page, you can use something like +`\[[WikiLink#foo]]`