diff options
| author | Joey Hess <joey@kodama.kitenet.net> | 2008-07-26 22:55:39 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kodama.kitenet.net> | 2008-07-26 22:55:39 -0400 |
| commit | 4f06e7402ab09ebc1baa2ff0b3af50ccfc37a67e (patch) | |
| tree | 44e33abdc34771462c15445a5b3679cb465930ae /doc/plugins | |
| parent | 2c08693645c498f8ff8c8d2021b97504bf0d9383 (diff) | |
remove ikiwiki.setup
To generate your own, use ikiwiki -dumpsetup ikiwiki.setup
Update docs.
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/mirrorlist.mdwn | 3 | ||||
| -rw-r--r-- | doc/plugins/write.mdwn | 12 |
2 files changed, 7 insertions, 8 deletions
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: |