From 4f06e7402ab09ebc1baa2ff0b3af50ccfc37a67e Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sat, 26 Jul 2008 22:55:39 -0400 Subject: [PATCH] remove ikiwiki.setup To generate your own, use ikiwiki -dumpsetup ikiwiki.setup Update docs. --- debian/examples | 1 - ...d_override_settings_in_the_setup_file.mdwn | 2 +- doc/ikiwiki.setup | 206 ------------------ doc/plugins.mdwn | 2 +- doc/plugins/mirrorlist.mdwn | 3 +- doc/plugins/write.mdwn | 12 +- doc/rcs/details.mdwn | 3 +- doc/security.mdwn | 3 +- doc/tips/nearlyfreespeech.mdwn | 9 +- .../Make_example_setup_file_consistent.mdwn | 8 +- doc/todo/cas_authentication.mdwn | 2 +- doc/todo/color_plugin.mdwn | 3 - doc/todo/conditional_underlay_files.mdwn | 2 +- doc/usage.mdwn | 2 - doc/w3mmode/ikiwiki.setup | 20 +- 15 files changed, 30 insertions(+), 248 deletions(-) delete mode 100644 debian/examples delete mode 100644 doc/ikiwiki.setup diff --git a/debian/examples b/debian/examples deleted file mode 100644 index d94312ed0..000000000 --- a/debian/examples +++ /dev/null @@ -1 +0,0 @@ -doc/ikiwiki.setup diff --git a/doc/bugs/Command-line_arguments_should_override_settings_in_the_setup_file.mdwn b/doc/bugs/Command-line_arguments_should_override_settings_in_the_setup_file.mdwn index f1ccf5896..22b1c2cb5 100644 --- a/doc/bugs/Command-line_arguments_should_override_settings_in_the_setup_file.mdwn +++ b/doc/bugs/Command-line_arguments_should_override_settings_in_the_setup_file.mdwn @@ -1,5 +1,5 @@ In setting up my wiki I followed the [[setup]] instruction which point -to an [[ikiwiki.setup]] file that contains "verbose => 0". +to an ikiwiki.setup file that contains "verbose => 0". I hadn't noticed that setting in there, but later when I changed my standard command of: diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup deleted file mode 100644 index 31a60b9ca..000000000 --- a/doc/ikiwiki.setup +++ /dev/null @@ -1,206 +0,0 @@ -#!/usr/bin/perl -# Configuration 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 => "MyWiki", - #adminuser => ["yourname", ], - adminemail => 'me@example.org', - - # Be sure to customise these.. - srcdir => "/path/to/source", - destdir => "/var/www/wiki", - - url => "http://example.org/wiki", - cgiurl => "http://example.org/wiki/ikiwiki.cgi", - #templatedir => "/usr/share/ikiwiki/templates", - #underlaydir => "/usr/share/ikiwiki/basewiki", - - # Subversion stuff. - #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.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 => 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. - #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}], - # 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", - #}, - - # For use with the tag plugin, make all tags be located under a - # base page. - #tagbase => "tag", - - # For use with the search plugin if the omega cgi is located - # somewhere else. - #omega_cgi => "/usr/lib/cgi-bin/omega/omega", - - # 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", - #}, - - # For use with the anonok plugin, a PageSpec specifying what - # pages anonymous users can edit - #anonok_pagespec => "*", - - # For use with the aggregate plugin. - # Enable aggregation to internal pages. New wikis should set this to 1, - # but if you use aggregate already, read the aggregate plugin docs - # before enabling it. - #aggregateinternal => 1, - # 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 -", -} diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index 5ee2bae89..83735c5fd 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -7,7 +7,7 @@ There's documentation if you want to [[write]] your own plugins, or you can [[install]] plugins [[contributed|contrib]] by others. To enable a plugin, use the `--plugin` switch described in -[[usage]], or the equivalent `add_plugins` line in [[ikiwiki.setup]]. +[[usage]], or the equivalent `add_plugins` line in ikiwiki.setup. Enable the [[goodstuff]] plugin to get a nice selection of plugins that will fit most uses of ikiwiki. diff --git a/doc/plugins/mirrorlist.mdwn b/doc/plugins/mirrorlist.mdwn index 89022e5ab..b371e8eb7 100644 --- a/doc/plugins/mirrorlist.mdwn +++ b/doc/plugins/mirrorlist.mdwn @@ -4,5 +4,4 @@ This plugin allows adding links a list of mirrors to each page in the wiki. For each mirror, a name and an url should be specified. Pages are assumed to exist in the same location under the specified url on each -mirror. The [[ikiwiki.setup]] file has an example of configuring a list of -mirrors. +mirror. diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 3d26842c2..6d5056162 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -417,7 +417,7 @@ it's not exported, the wise choice is to not use it. A plugin can access the wiki's configuration via the `%config` hash. The best way to understand the contents of the hash is to look at -[[ikiwiki.setup]], which sets the hash content to configure the wiki. +your ikiwiki setup file, which sets the hash content to configure the wiki. ### %pagestate @@ -769,15 +769,15 @@ IkiWiki::FailReason object if the match fails. ### Setup plugins -The ikiwiki setup file is loaded using a pluggable mechanism. If you -look at the top of [[ikiwiki.setup]], it starts with -'use IkiWiki::Setup::Standard', and the rest of the file is passed to -that module's import method. +The ikiwiki setup file is loaded using a pluggable mechanism. If you look +at the top of a setup file, it starts with 'use IkiWiki::Setup::Standard', +and the rest of the file is passed to that module's import method. It's possible to write other modules in the `IkiWiki::Setup::` namespace that can be used to configure ikiwiki in different ways. These modules should, when imported, populate `$IkiWiki::Setup::raw_setup` with a reference -to a hash containing all the config items. +to a hash containing all the config items. They should also implement a +`gendump` function. By the way, to parse a ikiwiki setup file, a program just needs to do something like: diff --git a/doc/rcs/details.mdwn b/doc/rcs/details.mdwn index 9bf65762f..e62f3ef49 100644 --- a/doc/rcs/details.mdwn +++ b/doc/rcs/details.mdwn @@ -266,8 +266,7 @@ on the same local machine, I suggest to create the latter with the "`git clone - command to save disk space. Note that, as a rule of thumb, you should always put the rcs wrapper (`post-update`) -into the master repository (`.git/hooks/`) as can be noticed in the Git wrappers of -the sample [[ikiwiki.setup]]. +into the master repository (`.git/hooks/`). Here is how a web edit works with ikiwiki and git: diff --git a/doc/security.mdwn b/doc/security.mdwn index 498d2b4e7..0841abf49 100644 --- a/doc/security.mdwn +++ b/doc/security.mdwn @@ -66,8 +66,7 @@ So it's best if only one person can ever directly write to those directories. ## setup files Setup files are not safe to keep in the same revision control repository -with the rest of the wiki. Just don't do it. [[ikiwiki.setup]] is *not* -used as the setup file for this wiki, BTW. +with the rest of the wiki. Just don't do it. ## page locking can be bypassed via direct commits diff --git a/doc/tips/nearlyfreespeech.mdwn b/doc/tips/nearlyfreespeech.mdwn index 435743bf9..6715f0c29 100644 --- a/doc/tips/nearlyfreespeech.mdwn +++ b/doc/tips/nearlyfreespeech.mdwn @@ -76,16 +76,15 @@ Here is an example of how I set up a wiki: mkdir ~/wiki cd ~/wiki - cp ~/ikiwiki/doc/ikiwiki.setup . cp -r ~/ikiwiki/doc/examples/blog/* . + ikiwiki -dumpsetup ikiwiki.setup nano ikiwiki.setup # Set destdir to /home/htdocs # Set srcdir to /home/private/wiki # Set url to http://yoursite.nfshost.com/ , set cgiurl likewise - # Uncomment the `rcs => "git"` line, and the cgi and git - # post-update wrapper blocks. - # Set the cgi wrapper path to /home/htdocs/ikiwiki.cgi - # Set the git wrapper path to /home/private/wiki.git/hooks/post-update + # Uncomment the `rcs => "git"` line. + # Set the cgi_wrapper path to /home/htdocs/ikiwiki.cgi + # Set the git_wrapper path to /home/private/wiki.git/hooks/post-update # Configure the rest to your liking and save the file. ikiwiki-makerepo git . ../wiki.git ikiwiki -setup ikiwiki.setup diff --git a/doc/todo/Make_example_setup_file_consistent.mdwn b/doc/todo/Make_example_setup_file_consistent.mdwn index 1fdff7b0f..54cc34af6 100644 --- a/doc/todo/Make_example_setup_file_consistent.mdwn +++ b/doc/todo/Make_example_setup_file_consistent.mdwn @@ -1,4 +1,4 @@ -The current example [[ikiwiki.setup]] file has a number of options included, but commented out. This is standard. Unfortunately there are two standards for the settings of those commented out options: +The current example ikiwiki.setup file has a number of options included, but commented out. This is standard. Unfortunately there are two standards for the settings of those commented out options: - Have the commented out options showing the default setting, or - Have the commented out options showing the most common alternate setting. @@ -26,4 +26,8 @@ What do others think? > I may not work on it myself, since I have some > [[interesting_ideas|online_configuration]] that would let ikiwiki > generate a setup file for you, rather than having to keep maintain the -> current example. --[[Joey]] +> current example. +> +> And.. [[done]].. setup files are now generated with `--dumpsetup`, based on +> the built-in defaults, and commented options show an example +> setting, not a default. --[[Joey]] diff --git a/doc/todo/cas_authentication.mdwn b/doc/todo/cas_authentication.mdwn index a6b428207..c8ffe7005 100644 --- a/doc/todo/cas_authentication.mdwn +++ b/doc/todo/cas_authentication.mdwn @@ -163,7 +163,7 @@ follows) ? +`/etc/ssl/certs/ca-certificates.crt` is sufficient). > It would be good to add commented-out examples of these to -> [[ikiwiki.setup]] as well. +> ikiwiki.setup as well. +This plugin is not enabled by default. It can not be used with other +authentication plugin, such as [[passwordauth]] or [[openid]]. diff --git a/doc/todo/color_plugin.mdwn b/doc/todo/color_plugin.mdwn index b82e0b704..ec246f9d6 100644 --- a/doc/todo/color_plugin.mdwn +++ b/doc/todo/color_plugin.mdwn @@ -198,6 +198,3 @@ comments are very welcome. --[[Paweł|ptecza]] + \[[!color ,#ff0000 "Default color text on red background"]] + +Foreground is missing, so the text has default color. - + - +This plugin is not enabled by default. You can do that in [[ikiwiki.setup]] - +file (hint: `add_plugins` variable). diff --git a/doc/todo/conditional_underlay_files.mdwn b/doc/todo/conditional_underlay_files.mdwn index 14ab4dac3..c578bceaf 100644 --- a/doc/todo/conditional_underlay_files.mdwn +++ b/doc/todo/conditional_underlay_files.mdwn @@ -12,7 +12,7 @@ I can see two good ways to implement this. Ideally, with [[conditional_text_based_on_ikiwiki_features]] available, ikiwiki could parse a page like conditionalpages.mdwn, which could contain a set of conditional-wrapped page names; that seems like the most elegant and -ikiwiki-like approach. Alternatively, [[/ikiwiki.setup]] could contain a +ikiwiki-like approach. Alternatively, ikiwiki.setup could contain a Perl-generated exclude option by default; that would work, but it seems hackish. diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 473d1c9b1..511bb687a 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -55,8 +55,6 @@ These options control the mode that ikiwiki operates in. In setup mode, ikiwiki reads the config file, which is really a perl program that can call ikiwiki internal functions. - [[ikiwiki.setup]] is an example of such a config file. - The default action when --setup is specified is to automatically generate wrappers for a wiki based on data in a config file, and rebuild the wiki. If you only want to build any changed pages, you can use --refresh with diff --git a/doc/w3mmode/ikiwiki.setup b/doc/w3mmode/ikiwiki.setup index e08856158..5f5cbbff9 100644 --- a/doc/w3mmode/ikiwiki.setup +++ b/doc/w3mmode/ikiwiki.setup @@ -17,19 +17,13 @@ use IkiWiki::Setup::Standard { cgiurl => 'ikiwiki.cgi', rcs => "", - wrappers => [ - { - # The cgi wrapper. - cgi => 1, - # The wrapper must be put in ~/.ikiwiki/wrappers/, since - # ikiwiki-w3m.cgi only looks in this one location. - # The wrapper can be given any name as long as it's - # in that directory. - wrapper => "$ENV{HOME}/.ikiwiki/wrappers/ikiwiki.cgi", - wrappermode => "0755", - }, - ], - + # The wrapper must be put in ~/.ikiwiki/wrappers/, since + # ikiwiki-w3m.cgi only looks in this one location. + # The wrapper can be given any name as long as it's + # in that directory. + cgi_wrapper => "$ENV{HOME}/.ikiwiki/wrappers/ikiwiki.cgi", + cgi_wrappermode => "0755", + add_plugins => [qw{anonok}], rss => 1, atom => 1, -- 2.32.0.93.g670b81a890