web commit by http://madduck.myopenid.com/: add comment about why link texts need...
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Mon, 24 Sep 2007 17:46:49 +0000 (17:46 +0000)
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>
Mon, 24 Sep 2007 17:46:49 +0000 (17:46 +0000)
doc/wikilink.mdwn

index 301f71a7f0d407b3aabd6ce4c67d72c5c0719415..894cfdbfe529b2e0596d97d52180352b873e0e49 100644 (file)
@@ -15,9 +15,11 @@ 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.
 
 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]]`
 
 To link to an anchor inside a page, you can use something like
 `\[[WikiLink#foo]]`