diff options
Diffstat (limited to 'ikiwiki.setup')
| -rw-r--r-- | ikiwiki.setup | 302 |
1 files changed, 163 insertions, 139 deletions
diff --git a/ikiwiki.setup b/ikiwiki.setup index eb31a420..89130e2b 100644 --- a/ikiwiki.setup +++ b/ikiwiki.setup @@ -1,9 +1,10 @@ #!/usr/bin/perl -# Setup file for ikiwiki. # +# 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. require IkiWiki::Setup::Standard; @@ -59,7 +60,7 @@ IkiWiki::Setup::Standard->import({ add_plugins => [qw{goodstuff cutpaste editdiff edittemplate favicon html sidebar table txt copyright license texinfo}], # plugins to disable disable_plugins => [], - # location of template files + # additional directory to search for template files templatedir => $srcdir.'/.templates', # base wiki source location #underlaydir => '/usr/share/ikiwiki/basewiki', @@ -77,6 +78,8 @@ IkiWiki::Setup::Standard->import({ discussion => 1, # name of Discussion pages discussionpage => 'Discussion', + # generate HTML5? (experimental) + html5 => 0, # only send cookies over SSL connections? sslcookie => 0, # extension to use for new pages @@ -101,13 +104,20 @@ IkiWiki::Setup::Standard->import({ libdir => $srcdir.'/.library', # environment variables ENV => {}, - # regexp of source files to ignore - #exclude => '\\.wav$', + # regexp of normally excluded files to include + #include => '^\\.htaccess$', + # regexp of files that should be skipped + #exclude => '^(*\\.private|Makefile)$', # 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, + ###################################################################### + # core plugins + # (editpage, git, htmlscrubber, inline, link, meta) + ###################################################################### + # git plugin # git hook to generate git_wrapper => $git_wrapper, @@ -126,22 +136,32 @@ IkiWiki::Setup::Standard->import({ # branch that the wiki is stored in gitmaster_branch => 'master', - # aggregate plugin - # enable aggregation to internal pages? - #aggregateinternal => 1, - # allow aggregation to be triggered via the web? - #aggregate_webtrigger => 0, + # htmlscrubber plugin + # PageSpec specifying pages not to scrub + #htmlscrubber_skip => '!*/Discussion', + + # 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 => [], + + ###################################################################### + # auth plugins + # (anonok, blogspam, httpauth, lockedit, moderatedcomments, + # opendiscussion, openid, passwordauth, signinedit) + ###################################################################### # anonok plugin # PageSpec to limit which pages anonymous users can edit #anonok_pagespec => '*/discussion', - # 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 -', - # blogspam plugin # PageSpec of pages to check for spam #blogspam_pagespec => 'postcomment(*)', @@ -150,23 +170,69 @@ IkiWiki::Setup::Standard->import({ # blogspam server XML-RPC url #blogspam_server => '', - # bzr plugin - # bzr post-commit hook to generate - #bzr_wrapper => '', - # mode for bzr_wrapper (can safely be made suid) - #bzr_wrappermode => '06755', - # url to show file history, using loggerhead ([[file]] substituted) - #historyurl => '', - # url to view a diff, using loggerhead ([[file]] and [[r2]] substituted) - #diffurl => 'http://example.com/revision?start_revid=[[r2]]#[[file]]-s', + # 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', - # calendar plugin - # base of the archives hierarchy - #archivebase => 'archives', + # lockedit plugin + # PageSpec controlling which pages are locked + #locked_pages => '!*/Discussion', - # camelcase plugin - # list of words to not turn into links - #camelcase_ignore => [], + # moderatedcomments plugin + # PageSpec matching users or comment locations to moderate + #moderate_pagespec => '*', + + # 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, po, 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, + + # po plugin + # master language (non-PO files) + #po_master_language => { + # code => 'en', + # name => 'English' + #}, + # slave languages (PO files) + #po_slave_languages => { + # de => 'Deutsch', + # es => 'Español', + # fr => 'Français' + #}, + # PageSpec controlling which pages are translatable + #po_translatable_pages => '* and !*/Discussion', + # internal linking behavior (default/current/negotiated) + #po_link_to => 'current', + + ###################################################################### + # 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 @@ -182,75 +248,81 @@ IkiWiki::Setup::Standard->import({ # commit comments to the VCS #comments_commit => 1, - # darcs plugin - # wrapper to generate (set as master repo apply hook) - #darcs_wrapper => '/darcs/repo/_darcs/ikiwiki-wrapper', - # mode for darcs_wrapper (can safely be made suid) - #darcs_wrappermode => '06755', - # darcsweb url to show file history ([[file]] substituted) - #historyurl => 'http://darcs.example.com/darcsweb.cgi?r=wiki;a=filehistory;f=[[file]]', - # darcsweb url to show a diff ([[hash]] and [[file]] substituted) - #diffurl => 'http://darcs.example.com/darcsweb.cgi?r=wiki;a=filediff;h=[[hash]];f=[[file]]', - # getsource plugin # Mime type for returned source. #getsource_mimetype => 'text/plain; charset=utf-8', - # highlight plugin - # types of source files to syntax highlight - #tohighlight => '.c .h .cpp .pl .py Makefile:make', + # mirrorlist plugin + # list of mirrors + #mirrorlist => {}, - # htmlscrubber plugin - # PageSpec specifying pages not to scrub - #htmlscrubber_skip => '!*/Discussion', + # repolist plugin + # URIs of repositories containing the wiki's source + #repositories => [qw{svn://svn.example.org/wiki/trunk}], - # 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 => [], + # 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 => [], + # list of additional setup field keys to treat as unsafe + #websetup_unsafe => [], + # 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', + # PageSpec of pages to include in the archives; used by ikiwiki-calendar command + #archive_pagespec => 'posts/* and !*/Discussion', # listdirectives plugin # directory in srcdir that contains directive descriptions #directive_description_dir => 'ikiwiki/directive', - # lockedit plugin - # PageSpec controlling which pages are locked - #locked_pages => '!*/Discussion', - - # mdwn plugin - # enable multimarkdown features? - #multimarkdown => 0, - - # mercurial plugin - # mercurial post-commit hook to generate - #mercurial_wrapper => '', - # mode for mercurial_wrapper (can safely be made suid) - #mercurial_wrappermode => '06755', - # url to hg serve'd repository, to show file history ([[file]] substituted) - #historyurl => 'http://example.com:8000/log/tip/[[file]]', - # url to hg serve'd repository, to show diff ([[file]] and [[r2]] substituted) - #diffurl => 'http://localhost:8000/?fd=[[r2]];file=[[file]]', + # 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}', - # mirrorlist plugin - # list of mirrors - #mirrorlist => {}, + ###################################################################### + # other plugins + # (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, + # favicon, goodstuff, htmlbalance, localstyle, pagetemplate, + # pingee, pinger, prettydate, recentchanges, recentchangesdiff, + # relativedate, rsync, sidebar, smiley, sortnaturally, tag, + # testpagespec, underlay) + ###################################################################### - # openid plugin - # an url where users can signup for an OpenID - #openidsignup => 'http://myopenid.com/', + # aggregate plugin + # enable aggregation to internal pages? + #aggregateinternal => 1, + # allow aggregation to be triggered via the web? + #aggregate_webtrigger => 0, - # 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, + # camelcase plugin + # list of words to not turn into links + #camelcase_ignore => [], # pinger plugin # how many seconds to try pinging before timing out @@ -266,69 +338,21 @@ IkiWiki::Setup::Standard->import({ # number of changes to track recentchangesnum => 100, - # repolist plugin - # URIs of repositories containing the wiki's source - #repositories => [qw{svn://svn.example.org/wiki/trunk}], - # rsync plugin # command to run to sync updated pages #rsync_command => 'rsync -qa --delete . user@host:/path/to/docroot/', - # search plugin - # path to the omega cgi program - #omega_cgi => '/usr/lib/cgi-bin/omega/omega', - - # svn plugin - # subversion repository location - #svnrepo => '/svn/wiki', - # path inside repository where the wiki is located - #svnpath => 'trunk', - # svn post-commit hook to generate - #svn_wrapper => '/svn/wikirepo/hooks/post-commit', - # mode for svn_wrapper (can safely be made suid) - #svn_wrappermode => '04755', - # viewvc url to show file history ([[file]] substituted) - #historyurl => 'http://svn.example.org/trunk/[[file]]', - # viewvc url to show a diff ([[file]], [[r1]], and [[r2]] substituted) - #diffurl => 'http://svn.example.org/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]', + # sidebar plugin + # show sidebar page on all pages? + #global_sidebars => 1, # tag plugin # parent page tags are located under tagbase => 'tag', - - # 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}', - - # tla plugin - # tla post-commit hook to generate - #tla_wrapper => '', - # mode for tla_wrapper (can safely be made suid) - #tla_wrappermode => '06755', - # url to show file history ([[file]] substituted) - #historyurl => '', - # url to show a diff ([[file]] and [[rev]] substituted) - #diffurl => '', + # autocreate new tag pages? + #tag_autocreate => 1, # underlay plugin # extra underlay directories to add #add_underlays => '', - # extra template directories to add - #add_templates => '', - - # 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, }) |