web commit by JoshTriplett: Avoid suggesting that only advanced users can use [[PrePr...

[ikiwiki.git] / doc / ikiwiki.setup

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 18c413e6fd8bc74c203f1f455328923ece2d51fb..af60e076b698be832afff9dfd51193fe7c6addc9 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -8,27 +8,27 @@
 use IkiWiki::Setup::Standard {
        wikiname => "MyWiki",
        #adminuser => ["yourname", ],
-       adminemail => 'me@myhost',
+       adminemail => 'me@example.org',
        
        # Be sure to customise these..
        srcdir => "/path/to/source",
        destdir => "/var/www/wiki",
        
-       url => "http://myhost/wiki",
-       cgiurl => "http://myhost/ikiwiki.cgi",
+       url => "http://example.org/wiki",
+       cgiurl => "http://example.org/ikiwiki.cgi",
        #templatedir => "/usr/share/ikiwiki/templates",
        
        # Subversion stuff.
-       rcs => "svn",
-       #historyurl => "http://svn.myhost/trunk/[[file]]",
-       #diffurl => "http://svn.someurl/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
-       svnrepo => "/svn/wiki",
-       svnpath => "trunk",
+       #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.
        #rcs => "git",
-       #historyurl => "http://git.host/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
-       #diffurl => "http://git.host/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
+       #historyurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
+       #diffurl => "http://git.example.org/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
 
        # Tla stuff.
        #rcs => "tla"
@@ -47,22 +47,22 @@ use IkiWiki::Setup::Standard {
                #       wrapper => "/var/www/wiki/ikiwiki.cgi",
                #       wrappermode => "06755",
                #},
-               {
-                       # The svn post-commit wrapper.
-                       # Note that this will overwrite any existing
-                       # post-commit hook script, which may not be
-                       # what you want.
-                       wrapper => "/svn/wikirepo/hooks/post-commit",
-                       wrappermode => "04755",
-                       # Enable mail notifications of commits.
-                       notify => 1,
-               },
+               #{
+               #       # The svn post-commit wrapper.
+               #       # Note that this will overwrite any existing
+               #       # post-commit hook script, which may not be
+               #       # what you want.
+               #       wrapper => "/svn/wikirepo/hooks/post-commit",
+               #       wrappermode => "04755",
+               #       # Enable mail notifications of commits.
+               #       notify => 1,
+               #},
                #{
                #       # The git post-update wrapper.
                #       # Note that this will overwrite any existing
                #       # post-update hook script, which may not be
                #       # what you want.
-               #       wrapper => "/git/wikirepo/.git/hooks/post-update",
+               #       wrapper => "/git/wiki.git/hooks/post-update",
                #       wrappermode => "04755",
                #       # Enable mail notifications of commits.
                #       notify => 1,
@@ -71,39 +71,50 @@ use IkiWiki::Setup::Standard {
        
        # Can anonymous web users edit pages?
        #anonok => 1,
-       # Generate rss feeds for pages?
+       # Generate rss feeds for blogs?
        rss => 1,
+       # Generate atom feeds for blogs?
+       atom => 1,
        # Urls to ping with XML-RPC when rss 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/,
        # Time format (for strftime)
        #timeformat => '%c',
        # Locale to use. Must be a UTF-8 locale.
        #locale => 'en_US.UTF-8',
        # Only send cookies over SSL connections.
        #sslcookie => 1,
-       # Use HTTP Authentication instead of Ikiwiki's.
-       #httpauth => 1,
        # Logging settings:
        verbose => 0,
        syslog => 0,
+       # To link to user pages in a subdirectory of the wiki.
+       #userdir => "users",
        
        # To add plugins, list them here.
-       #add_plugins => [qw{meta tag pagecount brokenlinks search smiley
-       #                   wikitext camelcase pagestats htmltidy fortune
-       #                   sidebar map rst toc linkmap}],
+       #add_plugins => [qw{goodstuff openid search wikitext camelcase
+       #                   htmltidy fortune sidebar map rst}],
        # If you want to disable any of the default plugins, list them here.
-       #disable_plugins => [qw{inline htmlscrubber}],
+       #disable_plugins => [qw{inline htmlscrubber passwordauth}],
 
        # For use with the tag plugin, make all tags be located under a
        # base page.
-       #tagbase => "tag".
+       #tagbase => "tag",
        
        # For use with the search plugin if your estseek.cgi is located 
        # somewhere else.
        #estseek => "/usr/lib/estraier/estseek.cgi",
+       
+       # For use with the openid plugin, to give an url to a page users
+       # can use to signup for an OpenID.
+       #openidsignup => "http://myopenid.com/",
+       
+       # For use with the mirrorlist plugin, a list of mirrors.
+       #mirrorlist => {
+       #       mirror1 => "http://hostname1",
+       #       mirror2 => "http://hostname2/mirror",
+       #},
 }