]> git.cworth.org Git - ikiwiki-bootstrap/blobdiff - ikiwiki.setup
Remove stray period
[ikiwiki-bootstrap] / ikiwiki.setup
index f90a8379c178d7f66f394ed6110c34e5a1d91f33..606eb4c15c579ef0326fa8809bd66321d72c53b0 100644 (file)
@@ -12,7 +12,7 @@
 # but this clone is owned by ikiwiki so its working-copy content
 # should never be edited manually, nor should anybody clone from or
 # push to this repository. To make this quite clear, I suggest hiding
-# the checkout inside the repository as show below.
+# the checkout inside the repository as shown below.
 #
 # To set this up, just do:
 #
 #      git clone $gitrepo ikiwiki-checkout
 #
 # And then push into $gitrepo this ikiwiki.setup file, a templates/
-# directory, and a src/ directory with your wiki content.
+# directory, and a src/ directory with your wiki content. See README
+# for more details.
 #
 # Also, see the destdir and url parameters below which must also be
 # configured before things will work at all.
 
-my gitrepo = '/path/to/bare/git/repo';
-my checkout = "$gitrepo/ikiwiki-checkout";
+our ($gitrepo, $checkout);
+
+BEGIN {
+       $gitrepo = "/path/to/bare/git/repo";
+       $checkout = "$gitrepo/ikiwiki-checkout";
+}
 
 use IkiWiki::Setup::Standard {
 
@@ -44,9 +49,19 @@ use IkiWiki::Setup::Standard {
        adminemail => 'me@example.org',
 
        # Everything else can be customised on an as-needed basis
-       srcdir => "$checkout/src";
+       srcdir => "$checkout/src",
        templatedir => "$checkout/templates",
-       underlaydir => "$checkout/underlay";
+
+       # There's not really much point to having an underlay come
+       # from the same place as the rest of the source like this:
+       #
+       #       underlaydir => "$checkout/underlay",
+       #
+       # since you might as well put such content in src/ instead of
+       # in underlay. I suppose if you have some files common to
+       # several separate wiki instances then the underlay might
+       # still be useful. But for now, we'll just leave it off.
+       underlaydir => "/dev/null",
 
        # Git stuff.
        rcs => "git",
@@ -91,7 +106,12 @@ use IkiWiki::Setup::Standard {
        # Only send cookies over SSL connections.
        #sslcookie => 1,
        # Logging settings:
-       verbose => 0,
+
+       # It's stupid to set verbose to 0 here since it's the default
+       # anyway, and it has the side effect of making --verbose on
+       # the command-line not work.
+       # verbose => 0,
+
        syslog => 0,
        # To link to user pages in a subdirectory of the wiki.
        #userdir => "users",