summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/install/discussion.mdwn12
-rw-r--r--doc/news/version_2.49.mdwn26
-rw-r--r--doc/news/version_2.54.mdwn46
-rw-r--r--doc/todo/online_configuration.mdwn66
4 files changed, 124 insertions, 26 deletions
diff --git a/doc/install/discussion.mdwn b/doc/install/discussion.mdwn
index 9b64330e4..ebdb7e090 100644
--- a/doc/install/discussion.mdwn
+++ b/doc/install/discussion.mdwn
@@ -1,5 +1,17 @@
No matter what I do, ikiwiki gives me a `Can't locate loadable object for module Locale::gettext in @INC` although I've installed (and reinstalled) the Locale module, and no luck. If I look at the directories in the INC path, I can see the file. The wiki won't compile in spite of this, and I've tried everything I can think of.. -- [[tychoish]]
+> Sounds like the `Locale::gettext` perl module is there, but your perl
+> installation is broken so that the accompnying so file is not there, or
+> doesn't work. On my system I have
+> `/usr/lib/perl5/Locale/gettext.pm` and
+> `/usr/lib/perl5/auto/Locale/gettext.so` -- suspect your problem is with
+> the second one.
+>
+> If you can't fix it, this problem could probably be worked around by
+> unsetting all environment variables when running ikiwiki (`LANG`,
+> `LC_ALL`, `LC_MESSAGES`). Then it won't try to load `Locale::gettext` at
+> all. --[[Joey]]
+
---
I am trying to install Ikiwiki version 2.1 from the source tarball.
diff --git a/doc/news/version_2.49.mdwn b/doc/news/version_2.49.mdwn
deleted file mode 100644
index 37cf6b7ba..000000000
--- a/doc/news/version_2.49.mdwn
+++ /dev/null
@@ -1,26 +0,0 @@
-News for ikiwiki 2.49:
-
- The search plugin no longer uses hyperestraier. Instead, to use it you
- will now need to install xapian-omega, and the [[!cpan Search::Xapian]],
- [[!cpan HTML::Scrubber]], and [[!cpan Digest::SHA1]] perl modules. Ie,
- `apt-get install xapian-omega libsearch-xapian-perl libhtml-scrubber-perl libdigest-sha1-perl`
-
- Also, wikis that use the search plugin will need to be rebuilt,
- since the search form has changed. This will not be done automatically,
- but can be done by running `ikiwiki-mass-upgrade` as root, or
- running `ikiwiki -setup` on individual setup files.
-
-ikiwiki 2.49 released with [[!toggle text="these changes"]]
-[[!toggleable text="""
- * haiku: Generate valid xhtml.
- * ikiwiki-mass-rebuild: Don't trust $! when setting $)
- * inline: The optimisation in 2.41 broke nested inlines. Detect those
- and avoid overoptimising.
- * search: Converted to use xapian-omega.
- * Filter hooks are no longer called during the scan phase. This will
- prevent wikilinks added by filters from being scanned properly. But
- no known filter hook does that, so let's not waste time on it.
- * Pass a destpage parameter to the sanitize hook.
- * The search interface now allows searching for a page by title
- ("title:foo"), as well as for pages that contain a given link
- ("link:bar")."""]]
diff --git a/doc/news/version_2.54.mdwn b/doc/news/version_2.54.mdwn
new file mode 100644
index 000000000..075bc65f8
--- /dev/null
+++ b/doc/news/version_2.54.mdwn
@@ -0,0 +1,46 @@
+ikiwiki 2.54 released with [[!toggle text="these changes"]]
+[[!toggleable text="""
+ * [ Joey Hess ]
+ * Make it possible to load setup files w/o running them. Code
+ needing to do so can call IkiWiki::Setup::load, which will return
+ a hash of values.
+ * [ Josh Triplett ]
+ * ikiwiki-transition: Fix command-line processing so the prefix\_directives
+ transition works again.
+ * [ Joey Hess ]
+ * template: Add support for a BASENAME variable.
+ * Fixes creation of pages when clicking on WikiLinks starting with "/".
+ * Change deb dependencies to list Text::Markdown before markdown, since
+ the former, while slower, has a much better html parser that avoids
+ numerous bugs.
+ * Move yesno function out of inline and into IkiWiki core, not exported.
+ * Error handling improvement for preprocess hooks. It's now safe to call
+ error() from such hooks; it will cause a nicely formatted error message
+ to be inserted into the page.
+ * Cut the size of the binary package in half by excluding pages for bugs
+ and todo items from the html shipped in it.
+ * parentlinks: New plugin, split out of ikiwiki core and enabled by default,
+ and several new fields added to allow for advanced styling. (intrigeri)
+ * smileys: Some fixes for escaped smileys.
+ * smileys: Note that smileys need to be double-escaped for the escaping to
+ work. Markdown removes one level of escaping.
+ * Add a postscan hook.
+ * search: Use postscan hook, avoid updating index when previewing.
+ * git: Put web committer name/openid/address in the git author field.
+ The committer's email address is not used (because leaking email addresses
+ is not liked by many users). Closes: #[451023](http://bugs.debian.org/451023)
+ * git: Fix parsing of git logs with no commit messages at all.
+ * search: Fixes for title stemming, and use better term for tags.
+ (Gabriel McManus)
+ (Rebuilding the wiki on upgrade to this version is recommended if you
+ use the search plugin.)
+ * [ Simon McVittie ]
+ * meta, inline: Support guid options, to allow forcing a particular url or
+ uuid in feeds.
+ * meta: fix title() PageSpec
+ * Some footer style changes.
+ * aggregate: Add an `aggregateinternal` option, which allows storing
+ aggregated data to internal-use files, rather than wiki pages. This
+ can save disk space, and be faster.
+ * ikiwiki-transition: Add a `aggregateinternal` transition to rename
+ the aggregated files."""]]
diff --git a/doc/todo/online_configuration.mdwn b/doc/todo/online_configuration.mdwn
new file mode 100644
index 000000000..db3b41a71
--- /dev/null
+++ b/doc/todo/online_configuration.mdwn
@@ -0,0 +1,66 @@
+It should be possible to configure ikiwiki online, in the wiki admin's
+preferences form. Rather than the current situation where most settings are
+in ikiwiki.setup, and one or two (like locked pages and upload limits) in
+the admin preferences.
+
+In theory, every setting could be configured there. In practice, some
+settings, like `srcdir` and `destdir` are ones you want to keep far away
+from editing via the web.
+
+Currently admin prefs are per-admin, and are stored in the userdb.
+That seems like a bad choice in the context of this idea. Instead, admin
+setup should be configured on a separate page than the regular user prefs
+page, and should be shared amoung all admins, and the ideal storage would be
+another ikiwiki setup file, which could be loaded in, and written back out.
+
+If `ikiwiki-makerepo` were extended a little bit to generate the stub setup
+file that's enough to get `ikiwiki.cgi` working, and that sets values for
+all the dangerous options, leaving only safe ones 'undef', then users could
+set up ikiwiki using it, and configure the rest with the web interface,
+without ever needing to edit a setup file.
+
+The setup page could `require` every available plugin, and then call a
+`getsetup` function, which would look something like:
+
+ sub getsetup () {
+ eval q{use Some::Thing};
+ die $@ if $@;
+
+ return option_foo => {
+ safe => 1,
+ rebuild => 1,
+ type => "boolean",
+ default => 0,
+ description => gettext("Enable foo."),
+ },
+ option_bar => {
+ safe => 0,
+ rebuild => 0,
+ type => "password",
+ default => "",
+ description => gettext("Password for bar."),
+ };
+ }
+
+The types would be: boolean, string, password, filename, other.
+This would be the type of the leaf fields; if a value in `%config` is an
+array or hash, the type specifies the type of values that go into it.
+
+From this info, a form can be built, that has core setup values at the
+top, followed by each plugin whose `getsetup` succeeded, with a check box
+to enable/disable that plugin, and all of its setup options listed after
+it.
+
+The main setup file could control what options are read from the
+online setup file:
+
+ online_setup_include => 'safe', # all things with safe = 1
+ online_setup_exclude => [qw{option_baz}],
+
+Note that posting the setup form would sometimes need to cause a rebuild
+of the whole wiki. This could be done with output streamed to the admin in
+the web browser. The `rebuild` fields would be set to 1 for values that
+require a wiki rebuild when changed, and to 0 for values that only need the
+wrappers to be refreshed.
+
+[[tag wishlist]]