From b5c492e15f10d7b53269c03ed1cb73aba0636541 Mon Sep 17 00:00:00 2001
From: Nico Schottelius <nico@ikn.schottelius.org>
Date: Wed, 3 Mar 2010 08:26:01 +0100
Subject: [PATCH] add generated config filee plus underlaydirbase

Signed-off-by: Nico Schottelius <nico@ikn.schottelius.org>
---
 ikiwiki.setup | 468 +++++++++++++++++++++++++++++---------------------
 1 file changed, 270 insertions(+), 198 deletions(-)

diff --git a/ikiwiki.setup b/ikiwiki.setup
index b22426b1..a775a487 100644
--- a/ikiwiki.setup
+++ b/ikiwiki.setup
@@ -1,210 +1,282 @@
 #!/usr/bin/perl
-# Configuration file for ikiwiki.
-# Passing this to ikiwiki --setup will make ikiwiki generate wrappers and
-# build the wiki.
+# Setup file for ikiwiki.
+#
+# 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 => "Nico Schottelius",
-	#adminuser => ["yourname", ],
+	# name of the wiki
+	wikiname => 'Nico Schottelius',
+	# contact email for wiki
 	adminemail => 'nico-public@at@schottelius.org',
-
-	# Be sure to customise these..
-	srcdir => "./",
-	destdir => "../dst",
-
-	url => "http://www.nico.schottelius.org/",
-	###cgiurl => "http://example.org/wiki/ikiwiki.cgi",
-	#templatedir => "/usr/share/ikiwiki/templates",
-	#underlaydir => "/usr/share/ikiwiki/basewiki",
-	#underlaydir => "/home/users/nico/privat/computer/net/netzseiten/www.nico.schottelius.org/empty",
-	#underlaydir => "../underlaydir",
-
-	underlaydirbase => "/home/users/nico/b/ikiwiki/underlays",
-	underlaydir => "/home/users/nico/b/ikiwiki/underlays/basewiki",
-
-	# Subversion stuff.
-	#rcs => "svn",
-	#historyurl => "http://svn.example.org/trunk/[[file]]",
-	#diffurl => "http://svn.example.org/trunk/[[file]]?root=wiki&amp;r1=[[r1]]&amp;r2=[[r2]]",
-	#svnrepo => "/svn/wiki",
-	#svnpath => "trunk",
-
-	# Git stuff.
-	#rcs => "git",
-	#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]]",
-	#gitorigin_branch => "origin",
-	#gitmaster_branch => "master",
-
-	# Tla stuff.
-	#rcs => "tla"
-	#historyurl => ??,
-	#diffurl => ??,
-
-	# Mercurial stuff.
-	#rcs => "mercurial",
-	#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",
-	#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",
-
-	wrappers => [
-		#{
-		#	# The cgi wrapper.
-		#	cgi => 1,
-		#	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",
-		#	# Log to syslog since svn post-commit hooks
-		#	# hide output and errors.
-		#	syslog => 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/wiki.git/hooks/post-update",
-		#	wrappermode => "06755",
-		#},
-		#{
-		#	# The monotone netsync hook.
-		#	wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
-		#	wrappermode => "06755",
-		#},
-	],
-
-	# 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 feeds are updated
-	#pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
-	# Include discussion links on all pages?
-	discussion => 0,
-	##discussion => 1,
-	# To exclude files matching a regexp from processing. This adds to
-	# the default exclude list.
-	#exclude => qr/\.wav$/,
-	# To change the extension used for generated html files.
-	#htmlext => 'htm',
-	# 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 => 1,
-	syslog => 0,
-	# To link to user pages in a subdirectory of the wiki.
-	#userdir => "users",
-	# To create output files named page.html rather than page/index.html.
-	#usedirs => 0,
-	# Simple spam prevention: require an account-creation password.
-	#account_creation_password => "example",
-	# Cost of generating a password using Authen::Passphrase::BlowfishCrypt
-	#password_cost => 8,
-	# 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 => 1,
-	# 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.
+	# users who are wiki admins
+	adminuser => [],
+	# users who are banned from the wiki
+	banned_users => [],
+	# where the source of the wiki is located
+	srcdir => './',
+	# where to build the wiki
+	destdir => '../dst',
+	# base url to the wiki
+	url => 'http://www.nico.schottelius.org/',
+	# url to the ikiwiki.cgi
+	cgiurl => '',
+	# filename of cgi wrapper to generate
+	cgi_wrapper => '',
+	# mode for cgi_wrapper (can safely be made suid)
+	cgi_wrappermode => '06755',
+	# rcs backend to use
+	rcs => '',
+	# plugins to add to the default configuration
 	add_plugins => [qw{goodstuff meta sidebar tag rawhtml}],
-	#add_plugins => [qw{goodstuff search wikitext camelcase
-	#                   htmltidy fortune sidebar map rst anonok}],
-	# If you want to disable any of the default plugins, list them here.
-	#disable_plugins => [qw{inline htmlscrubber passwordauth openid}],
+	# plugins to disable
 	disable_plugins => [qw{smiley openid}],
-	# To add a directory to the perl search path, use this.
-	#libdir => "/home/me/.ikiwiki/",
-	
-	# To override environment variable settings, you can list values here.
-	#ENV => {
-	#	TZ => "America/New_York",
-	#	PATH => "/home/me/bin:/usr/local/bin:/usr/bin:/bin",
-	#},
+	# location of template files
+	templatedir => '/home/users/nico/b/ikiwiki/templates',
+	# base wiki source location
+	underlaydirbase => '/home/users/nico/b/ikiwiki/underlays',
+	underlaydir => '/home/users/nico/b/ikiwiki/underlays/basewiki',
+	# display verbose messages?
+	#verbose => 1,
+	# log to syslog?
+	#syslog => 1,
+	# create output files named page/index.html?
+	usedirs => 1,
+	# use '!'-prefixed preprocessor directives?
+	prefix_directives => 1,
+	# use page/index.mdwn source files
+	indexpages => 0,
+	# enable Discussion pages?
+	discussion => 0,
+	# name of Discussion pages
+	discussionpage => 'Diskussion',
+	# only send cookies over SSL connections?
+	sslcookie => 0,
+	# extension to use for new pages
+	default_pageext => 'mdwn',
+	# extension to use for html files
+	htmlext => 'html',
+	# strftime format string to display date
+	timeformat => '%c',
+	# UTF-8 locale to use
+	#locale => 'en_US.UTF-8',
+	# put user pages below specified page
+	userdir => '',
+	# how many backlinks to show before hiding excess (0 to show all)
+	numbacklinks => 10,
+	# attempt to hardlink source files? (optimisation for large files)
+	hardlink => 0,
+	# force ikiwiki to use a particular umask
+	umask => 18,
+	# group for wrappers to run in
+	#wrappergroup => 'ikiwiki',
+	# extra library and plugin directory
+	libdir => '/home/users/nico/b/ikiwiki',
+	# environment variables
+	ENV => {},
+	# regexp of source files to ignore
+	#exclude => '\\.wav$',
+	# specifies the characters that are allowed in source filenames
+	wiki_file_chars => '-[:alnum:]+/.:_',
+	# allow symlinks in the path leading to the srcdir (potentially insecure)
+	allow_symlinks_before_srcdir => 0,
 
-	# For use with the tag plugin, make all tags be located under a
-	# base page.
-	tagbase => "tags",
+	######################################################################
+	# core plugins
+	#   (editpage, htmlscrubber, inline, link, meta)
+	######################################################################
 
-	# For use with the search plugin if the omega cgi is located
-	# somewhere else.
-	#omega_cgi => "/usr/lib/cgi-bin/omega/omega",
+	# htmlscrubber plugin
+	# PageSpec specifying pages not to scrub
+	#htmlscrubber_skip => '!*/Discussion',
 
-	# 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/",
+	# inline plugin
+	# enable rss feeds by default?
+	rss => 1,
+	# enable atom feeds by default?
+	atom => 1,
+	# allow rss feeds to be used?
+	#allowrss => 0,
+	# allow atom feeds to be used?
+	#allowatom => 0,
+	# urls to ping (using XML-RPC) on feed update
+	pingurl => [],
 
-	# For use with the mirrorlist plugin, a list of mirrors.
-	#mirrorlist => {
-	#	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,
-	
-	# For use with the attachment plugin, a program that returns
-	# nonzero if its standard input contains an virus.
-	#virus_checker => "clamdscan -",
+	######################################################################
+	# auth plugins
+	#   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
+	#    opendiscussion, passwordauth, signinedit)
+	######################################################################
+
+	# anonok plugin
+	# PageSpec to limit which pages anonymous users can edit
+	#anonok_pagespec => '*/discussion',
+
+	# blogspam plugin
+	# PageSpec of pages to check for spam
+	#blogspam_pagespec => 'postcomment(*)',
+	# options to send to blogspam server
+	#blogspam_options => 'blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10',
+	# blogspam server XML-RPC url
+	#blogspam_server => '',
+
+	# httpauth plugin
+	# url to redirect to when authentication is needed
+	#cgiauthurl => 'http://example.com/wiki/auth/ikiwiki.cgi',
+	# PageSpec of pages where only httpauth will be used for authentication
+	#httpauth_pagespec => '!*/Discussion',
+
+	# lockedit plugin
+	# PageSpec controlling which pages are locked
+	#locked_pages => '!*/Discussion',
+
+	# moderatedcomments plugin
+	# Moderate comments of logged-in users?
+	#moderate_users => 1,
+
+	# passwordauth plugin
+	# a password that must be entered when signing up for an account
+	#account_creation_password => 's3cr1t',
+	# cost of generating a password using Authen::Passphrase::BlowfishCrypt
+	#password_cost => 8,
+
+	######################################################################
+	# format plugins
+	#   (creole, highlight, hnb, html, mdwn, otl, rawhtml, textile, txt)
+	######################################################################
+
+	# highlight plugin
+	# types of source files to syntax highlight
+	#tohighlight => '.c .h .cpp .pl .py Makefile:make',
+
+	# mdwn plugin
+	# enable multimarkdown features?
+	#multimarkdown => 0,
+
+	######################################################################
+	# web plugins
+	#   (attachment, comments, editdiff, edittemplate, getsource,
+	#    google, mirrorlist, remove, rename, repolist, search,
+	#    websetup, wmd)
+	######################################################################
+
+	# attachment plugin
+	# enhanced PageSpec specifying what attachments are allowed
+	#allowed_attachments => 'virusfree() and mimetype(image/*) and maxsize(50kb)',
+	# virus checker program (reads STDIN, returns nonzero if virus found)
+	#virus_checker => 'clamdscan -',
+
+	# comments plugin
+	# PageSpec of pages where comments are allowed
+	#comments_pagespec => 'blog/* and !*/Discussion',
+	# PageSpec of pages where posting new comments is not allowed
+	#comments_closed_pagespec => 'blog/controversial or blog/flamewar',
+	# Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
+	#comments_pagename => '',
+	# Interpret directives in comments?
+	#comments_allowdirectives => 0,
+	# Allow anonymous commenters to set an author name?
+	#comments_allowauthor => 0,
+	# commit comments to the VCS
+	#comments_commit => 1,
+
+	# getsource plugin
+	# Mime type for returned source.
+	#getsource_mimetype => 'text/plain; charset=utf-8',
+
+	# mirrorlist plugin
+	# list of mirrors
+	#mirrorlist => {},
+
+	# repolist plugin
+	# URIs of repositories containing the wiki's source
+	#repositories => [qw{svn://svn.example.org/wiki/trunk}],
+
+	# search plugin
+	# path to the omega cgi program
+	#omega_cgi => '/usr/lib/cgi-bin/omega/omega',
+
+	# websetup plugin
+	# list of plugins that cannot be enabled/disabled via the web interface
+	#websetup_force_plugins => [],
+	# show unsafe settings, read-only, in web interface?
+	#websetup_show_unsafe => 1,
+
+	######################################################################
+	# widget plugins
+	#   (calendar, color, conditional, cutpaste, date, format, fortune,
+	#    graphviz, haiku, img, linkmap, listdirectives, map, more,
+	#    orphans, pagecount, pagestats, poll, polygen, postsparkline,
+	#    progress, shortcut, sparkline, table, template, teximg, toc,
+	#    toggle, version)
+	######################################################################
+
+	# calendar plugin
+	# base of the archives hierarchy
+	#archivebase => 'archives',
+
+	# listdirectives plugin
+	# directory in srcdir that contains directive descriptions
+	#directive_description_dir => 'ikiwiki/directive',
+
+	# teximg plugin
+	# Should teximg use dvipng to render, or dvips and convert?
+	#teximg_dvipng => '',
+	# LaTeX prefix for teximg plugin
+	#teximg_prefix => '\\documentclass{article}
+	#\\usepackage{amsmath}
+	#\\usepackage{amsfonts}
+	#\\usepackage{amssymb}
+	#\\pagestyle{empty}
+	#\\begin{document}
+	#',
+	# LaTeX postfix for teximg plugin
+	#teximg_postfix => '\\end{document}',
+
+	######################################################################
+	# other plugins
+	#   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed,
+	#    favicon, goodstuff, htmlbalance, localstyle, pagetemplate,
+	#    pingee, pinger, prettydate, recentchanges, recentchangesdiff,
+	#    relativedate, rsync, sidebar, tag, testpagespec, underlay)
+	######################################################################
+
+	# aggregate plugin
+	# enable aggregation to internal pages?
+	#aggregateinternal => 1,
+	# allow aggregation to be triggered via the web?
+	#aggregate_webtrigger => 0,
+
+	# camelcase plugin
+	# list of words to not turn into links
+	#camelcase_ignore => [],
+
+	# pinger plugin
+	# how many seconds to try pinging before timing out
+	#pinger_timeout => 15,
+
+	# prettydate plugin
+	# format to use to display date
+	#prettydateformat => '%X, %B %o, %Y',
+
+	# recentchanges plugin
+	# name of the recentchanges page
+	recentchangespage => 'recentchanges',
+	# number of changes to track
+	recentchangesnum => 100,
+
+	# rsync plugin
+	# command to run to sync updated pages
+	#rsync_command => 'rsync -qa --delete . user@host:/path/to/docroot/',
+
+	# tag plugin
+	# parent page tags are located under
+	tagbase => 'tags',
+
+	# underlay plugin
+	# extra underlay directories to add
+	#add_underlays => [qw{/home/users/nico/wiki.underlay}],
+	# extra template directories to add
+	#add_templates => [qw{/home/users/nico/.ikiwiki/templates}],
 }