X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/6a5c7190d19ea002a5d4840aa7772147e1df06be..072d39f4b6fdbf99eea6c7aad593a27e10661fae:/doc/wikilink.mdwn diff --git a/doc/wikilink.mdwn b/doc/wikilink.mdwn index da5ed03f6..894cfdbfe 100644 --- a/doc/wikilink.mdwn +++ b/doc/wikilink.mdwn @@ -1,9 +1,9 @@ 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]]`. There are some special [[SubPage/LinkingRules]] that come into play when linking between [[SubPages|SubPage]]. @@ -15,6 +15,14 @@ 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]]. The reason you +have to (well, *should*) use underscores in place of spaces is so that +`ikiwiki` can distinguish your WikiLink from a PreprocessorDirective. + +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.