summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-09-24 17:46:49 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-09-24 17:46:49 +0000
commit072d39f4b6fdbf99eea6c7aad593a27e10661fae (patch)
tree902457bf3e0fed17a3644a1fd9d86ac64fdea942
parentb86f9b8409bb55162dfc7d4d13ea3ee577cce525 (diff)
web commit by http://madduck.myopenid.com/: add comment about why link texts need underscores in place of spaces
-rw-r--r--doc/wikilink.mdwn8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/wikilink.mdwn b/doc/wikilink.mdwn
index 301f71a7f..894cfdbfe 100644
--- a/doc/wikilink.mdwn
+++ b/doc/wikilink.mdwn
@@ -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.
-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]]`