]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/ikiwiki.setup
add a link to ikiwiki-transition
[git.ikiwiki.info.git] / doc / ikiwiki.setup
index 1cef4bd87f2964a392e18d6b9dfda5edbec6de49..7813eb822e2ac8788c1bff27343cfca16deff05d 100644 (file)
@@ -23,6 +23,7 @@ use IkiWiki::Setup::Standard {
        #rcs => "svn",
        #historyurl => "http://svn.example.org/trunk/[[file]]",
        #diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
+       #svnrepo => "/svn/wiki",
        #svnpath => "trunk",
 
        # Git stuff.
@@ -57,12 +58,6 @@ use IkiWiki::Setup::Standard {
        # The path to your workspace (defaults to the srcdir itself)
        # e.g. use if your srcdir is a subdirectory of the workspace.
        #mtnrootdir => "path/to/root/of/workspace",
-       # This is a monotone lua hook file used by ikiwiki for
-       # inserting conflict markers. By default it will use
-       # mtnrootdir/_MTN/mergerc. This hook will be populated with
-       # default code the first time you use ikiwiki.  You can
-       # change it to alter how conflict markers are inserted.
-       #mtnmergerc => "path/to/mergerc",
 
        wrappers => [
                #{
@@ -97,20 +92,20 @@ use IkiWiki::Setup::Standard {
                #},
        ],
 
-       # Default to generating rss feeds for blogs?
+       # Default to generating rss feeds for pages with feeds?
        #rss => 1,
-       # Default to generating atom feeds for blogs?
+       # Default to generating atom feeds for pages with feeds?
        #atom => 1,
        # Allow generating feeds even if not generated by default?
        #allowrss => 1,
        #allowatom => 1,
-       # Urls to ping with XML-RPC when rss feeds are updated
+       # Urls to ping with XML-RPC when feeds are updated
        #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
        # Include discussion links on all pages?
        discussion => 1,
        # To exclude files matching a regexp from processing. This adds to
        # the default exclude list.
-       #exclude => qr/*\.wav/,
+       #exclude => qr/\.wav$/,
        # To change the extension used for generated html files.
        #htmlext => 'htm',
        # Time format (for strftime)
@@ -135,6 +130,11 @@ use IkiWiki::Setup::Standard {
        #recentchangesnum => 100,
        # Use new '!'-prefixed preprocessor directive syntax
        #prefix_directives => 0,
+       # Attempt to make hardlinks to source files instead of copying them.
+       # Useful if the wiki contains large media files.
+       #hardlink => 1,
+       # Enable use of multimarkdown features in .mdwn files.
+       #multimarkdown => 1,
 
        # To add plugins, list them here.
        #add_plugins => [qw{goodstuff search wikitext camelcase
@@ -161,4 +161,30 @@ use IkiWiki::Setup::Standard {
        #       mirror1 => "http://hostname1",
        #       mirror2 => "http://hostname2/mirror",
        #},
+       
+       # For use with the anonok plugin, a PageSpec specifying what
+       # pages anonymous users can edit
+       #anonok_pagespec => "*",
+       
+       # For use with the aggregate plugin, to allow aggregation to be
+       # triggered via the web.
+       #aggregate_webtrigger => 1,
+       
+       # For use with the pinger plugin, how many seconds to wait before
+       # timing out.
+       #pinger_timeout => 15.
+       
+       # For use with the amazon S3 plugin, your public access key id.
+       #amazon_s3_key_id => 'XXXXXXXXXXXXXXXXXXXX',
+       # And a file holding your secret key. This file *must* not be
+       # readable by others!
+       #amazon_s3_key_file => "/home/me/.hide/.s3_key
+       # The globally unique name of the bucket to use to store the wiki.
+       #amazon_s3_bucket => "mywiki",
+       # A prefix to prepend to each page name.
+       #amazon_s3_prefix => "wiki/",
+       # Uncomment to use the S3 European datacenter.
+       #amazon_s3_location => "EU",
+       # Uncomment if you need to store each index file twice.
+       #amazon_s3_dupindex => 1,
 }