X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/543479eb22c43d26f73f2b43dbea45eea6bd56c1..80972e5e2669ec6e3258be0d12dc5859478d4c7e:/doc/wikilink.mdwn?ds=sidebyside diff --git a/doc/wikilink.mdwn b/doc/wikilink.mdwn index 4b82e7380..38df00f86 100644 --- a/doc/wikilink.mdwn +++ b/doc/wikilink.mdwn @@ -1,24 +1,27 @@ 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]]`. -Wiki links may not contain spaces. The associated file must be the wiki -link with any capital letters converted to lower case plus the file -extention. - -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]]`. There are some special [[SubPage/LinkingRules]] that come into play when -linking between [[SubPage]]s. +linking between [[SubPages|SubPage]]. 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-insensative manner, so you +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]] +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. The presence of spaces is used to distinguish between a +[[PreprocessorDirective]] and a WikiLink.