X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d430b23ba39338a15784ef98f1666369c66842cd..bd7c6d62fc7907e98214952437f18f3e42a99a6b:/doc/wikilink.mdwn?ds=sidebyside diff --git a/doc/wikilink.mdwn b/doc/wikilink.mdwn index 03cb2b3c3..a085ab7a7 100644 --- a/doc/wikilink.mdwn +++ b/doc/wikilink.mdwn @@ -1,11 +1,26 @@ 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 -examples "[[ WikiLink ]]" (without the added whitespace). +[[WikiLink]], just put the name of the page to link to in double brackets. +For example "\[[WikiLink]]". -Note that there are some special [[SubPage/LinkingRules]] that come into -play when linking between [[SubPage]]s. +If you ever need to write something like "\[[WikiLink]]" without creating a +wikilink, just prefix it with a "\", like "\\\\[[WikiLink]]". -WikiLinks can be entered in any case you like, the page they link to is -always lowercased. +There are some special [[SubPage/LinkingRules]] that come into play when +linking between [[SubPages|SubPage]]. -Note that if the file linked to by a WikiLink looks like an image, it will be displayed inline on the page. \ No newline at end of file +Also, if the file linked to by a WikiLink looks like an image, it will +be displayed inline on the page. + +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]] + +To link to an anchor inside a page, you can use something like +"\[[WikiLink#foo]]" + +**Note that you cannot use spaces in WikiLinks**. Replace spaces with +underscores.