* Work on firming up the plugin interface:

[git.ikiwiki.info.git] / doc / ikiwiki.setup

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 5353c37b89a3d439da2c5869b1a1edeb0a861583..ab5c9eb35fb581971591d07cade902defe3badca 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -1,13 +1,14 @@
 #!/usr/bin/perl
 # Configuration file for ikiwiki.
 #!/usr/bin/perl
 # Configuration file for ikiwiki.

-# Passing this to ikiwiki --setup will make ikiwiki generate two
-# wrapper programs, one for cgi and one for a subversion post-commit hook.
+# Passing this to ikiwiki --setup will make ikiwiki generate wrappers and 
+# build the wiki.

 #
 # Remember to re-run ikiwiki --setup any time you edit this file.
 
 use IkiWiki::Setup::Standard {
        wikiname => "MyWiki",
        #adminuser => ["yourname", ],
 #
 # Remember to re-run ikiwiki --setup any time you edit this file.
 
 use IkiWiki::Setup::Standard {
        wikiname => "MyWiki",
        #adminuser => ["yourname", ],

+       adminemail => 'me@myhost',

        
        # Be sure to customise these..
        srcdir => "/path/to/source",
        
        # Be sure to customise these..
        srcdir => "/path/to/source",


@@ -15,30 +16,56 @@ use IkiWiki::Setup::Standard {
        
        url => "http://myhost/wiki",
        cgiurl => "http://myhost/ikiwiki.cgi",
        
        url => "http://myhost/wiki",
        cgiurl => "http://myhost/ikiwiki.cgi",

-       #historyurl => "http://svn.myhost/trunk/[[file]]",
-       #diffurl => "http://svn.someurl/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",

        #templatedir => "/usr/share/ikiwiki/templates",
        
        #templatedir => "/usr/share/ikiwiki/templates",
        

-       # Whether to integrate with svn.
-       svn => 1,
+       # 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",
        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]]",
+
+       # Tla stuff.
+       #rcs => "tla"
+       #historyurl => ??,
+       #diffurl => ??,
+
+       # Mercurial stuff.
+       #rcs => "mercurial",
+       #historyurl => "http://localhost:8000/", # hg serve'd local repository
+       #diffurl => "http://localhost:8000/?fd=[[changeset]];file=[[file]]",

 
        wrappers => [
 
        wrappers => [

+               #{
+               #       # The cgi wrapper.
+               #       cgi => 1,
+               #       wrapper => "/var/www/wiki/ikiwiki.cgi",
+               #       wrappermode => "06755",
+               #},

                {
                {

-                       # The svn wrapper.
-                       # Note that this will overwrite any exsting
+                       # The svn post-commit wrapper.
+                       # Note that this will overwrite any existing

                        # post-commit hook script, which may not be
                        # what you want.
                        # post-commit hook script, which may not be
                        # what you want.

-                       wrapper => "/svn/wiki/hooks/post-commit",
+                       wrapper => "/svn/wikirepo/hooks/post-commit",

                        wrappermode => "04755",
                        wrappermode => "04755",

+                       # Enable mail notifications of commits.
+                       notify => 1,

                },
                #{
                },
                #{

-               #       # The cgi wrapper.
-               #       cgiwrapper => {
-               #               cgi => 1,
-               #               wrapper => "/var/www/wiki/ikiwiki.cgi",
-               #               wrappermode => "06755",
-               #       },
+               #       # 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",
+               #       wrappermode => "04755",
+               #       # Enable mail notifications of commits.
+               #       notify => 1,

                #},
        ],
        
                #},
        ],
        


@@ -46,6 +73,27 @@ use IkiWiki::Setup::Standard {
        #anonok => 1,
        # Generate rss feeds for pages?
        rss => 1,
        #anonok => 1,
        # Generate rss feeds for pages?
        rss => 1,

-       # Use the Hyper Estraier search engine?
-       #hyperestraier => 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/,
+       # 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,
+       # Logging settings:
+       verbose => 0,
+       syslog => 0,
+       
+       # 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}],
+       # If you want to disable any of the default plugins, list them here.
+       #disable_plugins => [qw{inline htmlscrubber}],

 }
 }