]> sipb.mit.edu Git - ikiwiki.git/commitdiff
add note about the basewiki being self contained
authorJoey Hess <joey@gnu.kitenet.net>
Fri, 5 Jun 2009 20:33:07 +0000 (16:33 -0400)
committerJoey Hess <joey@gnu.kitenet.net>
Fri, 5 Jun 2009 20:33:07 +0000 (16:33 -0400)
doc/basewiki.mdwn

index c61ae3dba08a668ba1d9f566610f2e311a14de71..8392884ebc6c62d9d58a5819f35c1efaadeb9be8 100644 (file)
@@ -18,3 +18,9 @@ It currently includes these pages:
 
 As well as a few other files, like [[favicon.ico]], [[local.css]],
 [[style.css]], and some icons.
+
+Note that an important property of the basewiki is that it should be
+self-contained. That means that the pages listed above cannot link
+to pages outside the basewiki. Ikiwiki's test suite checks that the
+basewiki is self-contained, and from time to time links have to be
+removed (or replaced with `iki` [[shortcuts]]) to keep this invariant.