web commit by bartuer: add a question about restructuredtext

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

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index af27f1d7eb06631a06c4cb5c7583be23abc2b829..885f77813b8865ab8b32fed7c1cfe306639044a2 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -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]]",
        #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.
        #svnpath => "trunk",
 
        # Git stuff.


@@ -42,20 +43,21 @@ use IkiWiki::Setup::Standard {
        #historyurl => "http://localhost:8000/log/tip/[[file]]", # hg serve'd local repository
        #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
 
        #historyurl => "http://localhost:8000/log/tip/[[file]]", # hg serve'd local repository
        #diffurl => "http://localhost:8000/?fd=[[r2]];file=[[file]]",
 

+       # Bazaar stuff.
+       #rcs => "bzr",
+       #historyurl => "", 
+       #diffurl => "http://example.com/revision?start_revid=[[r2]]#[[file]]-s", # using loggerhead
+

        # Monotone stuff
        #rcs => "monotone",
        #mtnkey => "web\@machine.company.com",
        # Monotone stuff
        #rcs => "monotone",
        #mtnkey => "web\@machine.company.com",

+       #historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
+       #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",

        # Set if you want the wiki to sync on update and commit.
        #mtnsync => 0,
        # 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",
        # Set if you want the wiki to sync on update and commit.
        #mtnsync => 0,
        # 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 => [
                #{
 
        wrappers => [
                #{


@@ -83,19 +85,27 @@ use IkiWiki::Setup::Standard {
                #       wrapper => "/git/wiki.git/hooks/post-update",
                #       wrappermode => "06755",
                #},
                #       wrapper => "/git/wiki.git/hooks/post-update",
                #       wrappermode => "06755",
                #},

+               #{
+               #       # The monotone netsync hook.
+               #       wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
+               #       wrappermode => "06755",
+               #},

        ],
 
        ],
 

-       # Generate rss feeds for blogs?
-       rss => 1,
-       # Generate atom feeds for blogs?
-       atom => 1,
+       # Default to generating rss feeds for pages with feeds?
+       #rss => 1,
+       # 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
        #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.
        # 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$/,

        # To change the extension used for generated html files.
        #htmlext => 'htm',
        # Time format (for strftime)
        # To change the extension used for generated html files.
        #htmlext => 'htm',
        # Time format (for strftime)


@@ -115,6 +125,14 @@ use IkiWiki::Setup::Standard {
        #account_creation_password => "example",
        # Uncomment to force ikiwiki to run with a particular umask.
        #umask => 022,
        #account_creation_password => "example",
        # Uncomment to force ikiwiki to run with a particular umask.
        #umask => 022,

+       # Default settings for the recentchanges page.
+       #recentchangespage => "recentchanges",
+       #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,

 
        # To add plugins, list them here.
        #add_plugins => [qw{goodstuff search wikitext camelcase
 
        # To add plugins, list them here.
        #add_plugins => [qw{goodstuff search wikitext camelcase