diff options
Diffstat (limited to 'doc')
69 files changed, 648 insertions, 760 deletions
diff --git a/doc/bugs/Monotone_rcs_support.mdwn b/doc/bugs/Monotone_rcs_support.mdwn index 8eaea11af..d5cc37c27 100644 --- a/doc/bugs/Monotone_rcs_support.mdwn +++ b/doc/bugs/Monotone_rcs_support.mdwn @@ -1,258 +1,56 @@ -#Ikiwiki plugin for the Monotone revision control system. - -I've just made a patch to the ikiwiki code that allows it to use the [[rcs/Monotone]] revision control system. It is available at: - -<http://www.cse.unsw.edu.au/~willu/monotone-ikiwiki.diff> - -At the moment it is basically complete. At present rcs_notify() is implemeted but untested, the rest is implemented and tested. - -The current version of the patch handles conflicts through the web interface. It is still not perfect as it will break if there is a rename that conflicts with a web change (but so will the other Rcs plugins I think). It also commits a revision with conflict markers if there is a conflict requiring such markers... ick. - -Note: This patch requires a rather recent Monotone perl module (18 August 2007 or later). It is available from the monotone repository here: <http://viewmtn.angrygoats.net/branch/changes/net.venge.monotone>. - -> The setup instructions to add 40 lines of code to monotonerc is pretty frightning stuff. -> Is there some way this can be automated? --[[Joey]] - ->> I've committed a bunch of this to monotone so that in future it could be removed. ->> I've also just fixed this so it is in a separate, automagically generated, rc file. - ->>> Fair enough. Didn't realize you were a monotone committer. :-) - ->>>> I am, but still a little newish. Feedback is good. In particular, this is my first major bit of PERL. - -> Having rcs_commit return a warning message when there's an unresolved conflict -> isn't right; that message will populate the page edit box. You might want -> to use the error() function here? - ->> It should never reach that case, so I have changed that to error. - -> There'an incomplete comment ending with "note, this relies on the fact that" - ->> erg... sorry, fixed. - -[[tag patch]] - ->> I've [[accepted|done]] this patch, thank you! - ->>> Thanks for committing it. I hate keeping my own diffs. :) - ->> I did make a few changes. Please review, and make sure it still works ->> (a test case like we have for some of the other RCSes would be nice..) - ->>> Tested. It still works at least as well as it did. I'll try to get to a test case soon. ->>> In checking the source I noticed a few bogus comments I left in when editing, ->>> and a bug in page adding. ->>> Here is a small patch for them: - ->>>> applied - -Here is another patch. It fixes a FIXME you added. I was using $file within backticks because -I was getting an error trying to do it right. I've figured out the error, and now do it right. This -should also speed things up (very slightly) - -> applied - ->> BTW, will all the monotone output parsing work if LANG != C? - ->>> It should (he says crossing fingers). ->>> In the places where I do any complex parsing I'm using a special ->>> version of the mtn commands designed for scripting. They have a ->>> stable, easy to parse, output that doesn't get translated (I think). - ->> Do monotone post-commit hooks actually use REV? - ->>> Monotone post-commit hooks are written in Lua and can do ->>> what they please. Setting the REV environment var before ->>> calling Ikiwiki seems reasonable, but I've not written the ->>> Lua hook. - ->>>> So the rcs_notify support is not just untested, but can't work ->>>> at all w/o further development. - -I've just done this further development... The following patch adds support for diffurls. -I've also partially tested the commit message support. I was unable to get Ikiwiki to send -change emails at all (cgi or otherwise), so I tested by adding warn() calls. There were a -few things that needed to be fixed. Support is much closer now (including a simple default -monotone lua hook). - -When I stick this diff inline into the page, I have to indent it by four spaces, and that's fine. -But markdown seems to still be interpreting parts of it (e.g. the diff url) in strange ways. I -think it is the square brackets. - - Index: IkiWiki/Rcs/monotone.pm - =================================================================== - --- IkiWiki/Rcs/monotone.pm (revision 4252) - +++ IkiWiki/Rcs/monotone.pm (working copy) - @@ -186,8 +186,9 @@ - check_config(); - - if (defined($config{mtnsync}) && $config{mtnsync}) { - + check_mergerc(); - if (system("mtn", "--root=$config{mtnrootdir}", "sync", - - "--quiet", "--ticker=none", - + "--quiet", "--ticker=none", "--rcfile", $config{mtnmergerc}, - "--key", $config{mtnkey}) != 0) { - debug("monotone sync failed before update"); - } - @@ -342,10 +343,10 @@ - return $conflict; - } - if (defined($config{mtnsync}) && $config{mtnsync}) { - - if (system("mtn", "--root=$config{mtnrootdir}", "sync", - + if (system("mtn", "--root=$config{mtnrootdir}", "push", - "--quiet", "--ticker=none", "--key", - $config{mtnkey}) != 0) { - - debug("monotone sync failed"); - + debug("monotone push failed"); - } - } - - @@ -431,10 +432,28 @@ - my @changed_files = get_changed_files($automator, $rev); - my $file; - - + my ($out, $err) = $automator->call("parents", $rev); - + my @parents = ($out =~ m/^($sha1_pattern)$/); - + my $parent = $parents[0]; - + - foreach $file (@changed_files) { - - push @pages, { - - page => pagename($file), - - } if length $file; - + if (length($file)) { - + if (defined $config{diffurl} and (@parents == 1)) { - + my $diffurl=$config{diffurl}; - + $diffurl=~s/\[\[r1\]\]/$parent/g; - + $diffurl=~s/\[\[r2\]\]/$rev/g; - + $diffurl=~s/\[\[file\]\]/$file/g; - + push @pages, { - + page => pagename($file), - + diffurl => $diffurl, - + }; - + } - + else { - + push @pages, { - + page => pagename($file), - + }; - + } - + } - } - - push @ret, { - @@ -487,6 +506,18 @@ - - my @changed_pages = get_changed_files($automator, $rev); - - + my ($out, $err) = $automator->call("parents", $rev); - + my @parents = ($out =~ m/^($sha1_pattern)$/); - + my $parent = $parents[0]; - + - + my $diff; - + - + if (@parents == 1) { - + $automator->setOpts("r", $parent, "r", $rev); - + ($out, $err) = $automator->call("content_diff"); - + $diff = $out; - + } - + - $automator->close(); - - require IkiWiki::UserInfo; - @@ -495,7 +526,7 @@ - return $message; - }, - sub { - - `mtn --root=$config{mtnrootdir} au content_diff -r $rev`; - + return $diff; - }, - $user, @changed_pages); - } #}}} - @@ -604,4 +635,9 @@ - return true - end - } - + function note_netsync_revision_received(new_id, revision, certs, session_id) - + if (program_exists_in_path("ikiwiki-netsync-hook")) then - + execute("ikiwiki-netsync-hook", new_id) - + end - + end - EOF - Index: IkiWiki/Wrapper.pm - =================================================================== - --- IkiWiki/Wrapper.pm (revision 4252) - +++ IkiWiki/Wrapper.pm (working copy) - @@ -46,6 +46,16 @@ - addenv("REV", s); - EOF - } - + if ($config{rcs} eq "monotone" && $config{notify}) { - + # Support running directly as hooks/post-commit by passing - + # $1 in REV in the environment. - + $envsave.=<<"EOF" - + if (argc == 2) - + addenv("REV", argv[1]); - + else if ((s=getenv("REV"))) - + addenv("REV", s); - +EOF - + } - if ($config{rcs} eq "tla" && $config{notify}) { - $envsave.=<<"EOF" - if ((s=getenv("ARCH_VERSION"))) - Index: doc/rcs/monotone.mdwn - =================================================================== - --- doc/rcs/monotone.mdwn (revision 4252) - +++ doc/rcs/monotone.mdwn (working copy) - @@ -1,16 +1,13 @@ - -[monotone](http://monotone.ca/) is a distributed revision control system. - -Ikiwiki supports storing a wiki in Monotone and editing it using the [[cgi]] interface. - +[Monotone](http://monotone.ca/) is a distributed revision control system. - +Ikiwiki supports storing a wiki in a Monotone repository and editing it using the [[cgi]] interface. - It will use the Monotone logs to generate the [[RecentChanges]] page. - - -The monotone support requires the Monotone perl module (from the contrib/ directory - -in the monotone source) to be installed. In particular, it needs version 0.03 or higher of that module. - +The monotone support in Ikiwiki requires the Monotone perl module to be installed - +(available from the contrib/ directory in the monotone source). - +In particular, it needs version 0.03 or higher of that module. - The module is available from the monotone source repository at: - <http://viewmtn.angrygoats.net/branch/changes/net.venge.monotone> - - -Monotone support works, but there are still a few minor missing bits (listed here so they are not forgotten): - +At present the [[post-commit]] hook support is implemented but only partially tested. - - -* At the moment there are no links to display diffs between revisions. It shouldn't be hard to add links to a [ViewMTN](http://grahame.angrygoats.net/moinmoin/ViewMTN) instance, but it hasn't been done yet. - -* The [[post-commit]] hook support, so that Ikiwiki sends change notifications when people commit using Monotone rather than the web interface, is partially implemented and untested. - -* Documentation (this page) could be improved. - - - There is also a mismatch between the way Ikiwiki handles conflicts and the way Monotone handles conflicts. At present, if there is a conflict, then Ikiwiki will commit a revision with conflict markers before presenting it to the user. This is ugly, but there is no clean way to fix it at present. - Index: doc/ikiwiki.setup - =================================================================== - --- doc/ikiwiki.setup (revision 4252) - +++ doc/ikiwiki.setup (working copy) - @@ -46,6 +46,8 @@ - # Monotone stuff - #rcs => "monotone", - #mtnkey => "web\@machine.company.com", - + #historyurl => "http://viewmtn.company.com/", - + #diffurl => "http://viewmtn.company.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) - @@ -88,6 +90,16 @@ - # # Enable mail notifications of commits. - # notify => 1, - #}, - + #{ - + # # The monotone netsync revision received wrapper. - + # # Note that you also need to install a lua - + # # hook into monotone to make this work - + # # see: http://ikiwiki.info/rcs/monotone/ - + # wrapper => "/usr/local/bin/ikiwiki-netsync-hook", - + # wrappermode => "04755", - + # # Enable mail notifications of commits. - + # notify => 1, - + #}, - ], - - # Generate rss feeds for blogs? - +The Monotone module still lacks support for setting up a post-commit hook, +so commits made via monotone will not automatically update the wiki. + +Here for future reference is the most recent version of support for +that I've been sent. It's not yet working; there are path issues. --[[Joey]] + +<pre> +diff --git a/IkiWiki/Rcs/monotone.pm b/IkiWiki/Rcs/monotone.pm +index cde6029..34f8f96 100644 +--- a/IkiWiki/Rcs/monotone.pm ++++ b/IkiWiki/Rcs/monotone.pm +@@ -186,8 +186,9 @@ sub rcs_update () { #{{{ + check_config(); + + if (defined($config{mtnsync}) && $config{mtnsync}) { ++ check_mergerc(); + if (system("mtn", "--root=$config{mtnrootdir}", "sync", +- "--quiet", "--ticker=none", ++ "--quiet", "--ticker=none", "--rcfile", $config{mtnmergerc}, + "--key", $config{mtnkey}) != 0) { + debug("monotone sync failed before update"); + } +@@ -604,4 +605,9 @@ __DATA__ + return true + end + } ++ function note_netsync_revision_received(new_id, revision, certs, session_id) ++ if (program_exists_in_path("ikiwiki-netsync-hook")) then ++ execute("ikiwiki-netsync-hook", new_id) ++ end ++ end + EOF +diff --git a/IkiWiki/Wrapper.pm b/IkiWiki/Wrapper.pm +index 2103ea5..cff718c 100644 +diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup +index 1377315..0cbe27e 100644 +--- a/doc/ikiwiki.setup ++++ b/doc/ikiwiki.setup +@@ -88,6 +88,16 @@ use IkiWiki::Setup::Standard { + # # Enable mail notifications of commits. + # notify => 1, + #}, ++ #{ ++ # # The monotone netsync revision received wrapper. ++ # # Note that you also need to install a lua ++ # # hook into monotone to make this work ++ # # see: http://ikiwiki.info/rcs/monotone/ ++ # wrapper => "/usr/local/bin/ikiwiki-netsync-hook", ++ # wrappermode => "04755", ++ # # Enable mail notifications of commits. ++ # notify => 1, ++ #}, + ], + + # Generate rss feeds for blogs? +</pre> diff --git a/doc/bugs/discussion_of_what__63__.mdwn b/doc/bugs/discussion_of_what__63__.mdwn new file mode 100644 index 000000000..2f469fed9 --- /dev/null +++ b/doc/bugs/discussion_of_what__63__.mdwn @@ -0,0 +1,3 @@ +When searching in ikiwiki, sometimes discussion pages turn up. However, they are only titled "discussion". +In order to know what topic they are discussing, you have to look at the URL. Shouldn't they be titled +"foo/discussion" or "discussion of foo" or something? Thanks, --[[perolofsson]] diff --git a/doc/bugs/git_mail_notification_race.mdwn b/doc/bugs/git_mail_notification_race.mdwn index ebe158fb9..58bd82325 100644 --- a/doc/bugs/git_mail_notification_race.mdwn +++ b/doc/bugs/git_mail_notification_race.mdwn @@ -1,10 +1,12 @@ +[[done]] (in this branch); fixed removing email notification support! + I was suprised to receive two mails from ikiwiki about one web edit: 1 F Oct 30 To joey+ikiwiki update of ikiwiki's plugins/contrib/gallery.mdwn by http://arpitjain11.myopenid.com/ 1 F Oct 30 To joey+ikiwiki update of ikiwiki's plugins/contrib/gallery.mdwn by http://arpitjain11.myopenid.com/ The first of these had the correct diff for the changes made by the web - edit (00259020061577316895370ee04cf00b634db98a). +edit (00259020061577316895370ee04cf00b634db98a). But the second had a diff for modifications I made to ikiwiki code around the same time (2a6e353c205a6c2c8b8e2eaf85fe9c585c1af0cd). @@ -38,3 +40,18 @@ diff for the first commit. Ikiwiki's own locking prevents this from happenning if both commits are web edits. At least one of the two commits has to be a non-web commit. + +---- + +A related problem is that if two commits are made separately but then +pushed in together, the commit code only looks at the HEAD commit, which +is the second one. No notification is sent for the first. + +---- + +Based on all of these problems with using the post-update hook, ikiwiki +should be changed to use the post-receive hook, which provides enough +information to avoid the assumuptions that led to these problems. +Transitioning existing wikis to using a new hook will be interesting. Also, +this hook is only present in git >= 1.5.0.7. +--[[Joey]] diff --git a/doc/bugs/taint_issue_with_regular_expressions.mdwn b/doc/bugs/taint_issue_with_regular_expressions.mdwn index 6544c8aae..8fe411e5f 100644 --- a/doc/bugs/taint_issue_with_regular_expressions.mdwn +++ b/doc/bugs/taint_issue_with_regular_expressions.mdwn @@ -12,7 +12,7 @@ which is exactly the same regular expression drawn out as a constant. It appear > hole. It seems more likely that perl containes to have taint flag bugs > even in 5.8. See also: [[prune_causing_taint_mode_failures]], > [[Insecure_dependency_in_mkdir]], -> [[Insecure_dependency_in_eval_while_running_with_-T_switch.mdwn]], +> [[Insecure_dependency_in_eval_while_running_with_-T_switch]], > and especially [[debbug 411786]] > > The last of those was the last straw for me, and I disabled taint diff --git a/doc/cgi.mdwn b/doc/cgi.mdwn index 22d8c4332..1448fa4d5 100644 --- a/doc/cgi.mdwn +++ b/doc/cgi.mdwn @@ -1,3 +1,5 @@ -While ikiwiki is primarily a wiki compiler, which generates static html pages, it does use CGI for two important wiki features, online page editing and the [[RecentChanges]] display. +While ikiwiki is primarily a wiki compiler, which generates static html +pages, it does use CGI for online page editing. -To enable CGI, you need to create and install an ikiwiki.cgi wrapper. [[Setup]] explains how to do this.
\ No newline at end of file +To enable CGI, you need to create and install an ikiwiki.cgi wrapper. +[[Setup]] explains how to do this. diff --git a/doc/download.mdwn b/doc/download.mdwn index 609d074b5..16728f019 100644 --- a/doc/download.mdwn +++ b/doc/download.mdwn @@ -32,20 +32,4 @@ Also. FreeBSD has ikiwiki in its ## revision control -### git - -Ikiwiki is developed in a git repository and can be checked out by -either of these commands: - - git clone git://git.ikiwiki.info/ - git clone http://git.ikiwiki.info/ikiwiki.git/ - -The gitweb is [here](http://git.ikiwiki.info/?p=ikiwiki). - -Commits to this git repository are fed into [CIA](http://cia.vc), and can -be browsed, subscribed to etc on its -[project page](http://cia.vc/stats/project/ikiwiki). - -### subversion - -Ikiwiki's subversion repository is no longer available, use git instead. +Ikiwiki is developed in a [[git_repository|git]]. diff --git a/doc/features.mdwn b/doc/features.mdwn index a7b5c19ab..1d762bed4 100644 --- a/doc/features.mdwn +++ b/doc/features.mdwn @@ -127,7 +127,7 @@ with that there's no new commit marker syntax to learn. Nearly the definition of a wiki, although perhaps ikiwiki challenges how much of that web gunk a wiki really needs. These features are optional -and can be enabled by enabling [[CGI]]. +and can be enabled by enabling [[CGI]] and a [[Revision_Control_System|rcs]]. ### User registration @@ -161,11 +161,6 @@ Well, sorta. Rather than implementing YA history browser, it can link to ikiwiki can use the [[HyperEstraier]] search engine to add powerful full text search capabilities to your wiki. -### Commit mails - -ikiwiki can be configured to send you commit mails with diffs of changes -to selected pages. - ### [[w3mmode]] Can be set up so that w3m can be used to browse a wiki and edit pages diff --git a/doc/git.mdwn b/doc/git.mdwn new file mode 100644 index 000000000..90f030ab4 --- /dev/null +++ b/doc/git.mdwn @@ -0,0 +1,33 @@ +Ikiwiki is developed in a git repository and can be checked out +like this: + + git clone git://git.ikiwiki.info/ + +Or like this if your firewall only passes http traffic (slow): + + git clone http://git.ikiwiki.info/ikiwiki.git/ + +The gitweb is [here](http://git.ikiwiki.info/?p=ikiwiki). + +Commits to this git repository are fed into [CIA](http://cia.vc), and can +be browsed, subscribed to etc on its +[project page](http://cia.vc/stats/project/ikiwiki). + +## branches + +You are of course free to set up your own ikiwiki git repository with your +own [[patches|patch]]. + +Some of the branches included in the main repository include: + +* `gallery` contains the [[todo/Gallery]] plugin. It's not yet merged + die to license issues. +* `html` is an unfinished attempt at making ikiwiki output HTML 4.01 + instead of xhtml. +* `prefix-directives` changes the preprocessor directive syntax. It + is approximately one failing test case away from merging. +* `wikiwyg` adds [[todo/wikiwyg]] support. It is unmerged pending some + changes. +* `pristine-tar` contains deltas that + [pristine-tar](http://kitenet.net/~joey/code/pristine-tar) + can use to recreate released tarballs of ikiwiki diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup index 44cb35425..c96a45f78 100644 --- a/doc/ikiwiki.setup +++ b/doc/ikiwiki.setup @@ -23,7 +23,6 @@ use IkiWiki::Setup::Standard { #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. @@ -43,9 +42,16 @@ use IkiWiki::Setup::Standard { #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/", + #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) @@ -72,8 +78,6 @@ use IkiWiki::Setup::Standard { # # what you want. # wrapper => "/svn/wikirepo/hooks/post-commit", # wrappermode => "04755", - # # Enable mail notifications of commits. - # notify => 1, # # Log to syslog since svn post-commit hooks # # hide output and errors. # syslog => 1, @@ -85,15 +89,16 @@ use IkiWiki::Setup::Standard { # # what you want. # wrapper => "/git/wiki.git/hooks/post-update", # wrappermode => "06755", - # # Enable mail notifications of commits. - # notify => 1, #}, ], - # Generate rss feeds for blogs? - rss => 1, - # Generate atom feeds for blogs? - atom => 1, + # Default to generating rss feeds for blogs? + #rss => 1, + # Default to generating atom feeds for blogs? + #atom => 1, + # Allow generating feeds even if not generated by default? + #allowrss => 1, + #allowatom => 1, # Urls to ping with XML-RPC when rss feeds are updated #pingurl => [qw{http://rpc.technorati.com/rpc/ping}], # Include discussion links on all pages? @@ -120,6 +125,9 @@ use IkiWiki::Setup::Standard { #account_creation_password => "example", # Uncomment to force ikiwiki to run with a particular umask. #umask => 022, + # Default settings for the recentchanges page. + #recentchangespage => "recentchanges", + #recentchangesnum => 100, # To add plugins, list them here. #add_plugins => [qw{goodstuff search wikitext camelcase diff --git a/doc/ikiwiki/blog.mdwn b/doc/ikiwiki/blog.mdwn index 8a9c50d0b..1a816dceb 100644 --- a/doc/ikiwiki/blog.mdwn +++ b/doc/ikiwiki/blog.mdwn @@ -52,10 +52,12 @@ directive: Set to 0 to show all matching pages. * `skip` - Specify a number of pages to skip displaying. Can be useful to produce a feed that only shows archived pages. -* `rss` - controls generation of an rss feed. On by default if the wiki is - configured to use rss feeds, set to "no" to disable. -* `atom` - controls generation of an atom feed. On by default if the wiki is - configured to use atom feeds, set to "no" to disable. +* `rss` - controls generation of an rss feed. If the wiki is configured to + generate tss feeds by default, set to "no" to disable. If the wiki is + configured to `allowrss`, set to "yes" to enable. +* `atom` - controls generation of an atom feed. If the wiki is configured to + generate atom feeds by default, set to "no" to disable. If the wiki is + configured to `allowatom`, set to "yes" to enable. * `feeds` - controls generation of all types of feeds. Set to "no" to disable generating any feeds. * `postform` - Set to "yes" to enables a form to post new pages to a [[blog]]. diff --git a/doc/ikiwiki/pagespec.mdwn b/doc/ikiwiki/pagespec.mdwn index 5c6433ed3..3cd6bb9f4 100644 --- a/doc/ikiwiki/pagespec.mdwn +++ b/doc/ikiwiki/pagespec.mdwn @@ -33,8 +33,13 @@ functions: was created * "`created_before(page)`" - match only pages created before the given page was created -* "`user(name)`" - only available in page subscription preferences, match - only changes made by this user +* "`glob(someglob)`" - match pages that match the given glob. Just writing + the glob by itself is actually a shorthand for this function. +* "`internal(glob)`" - like `glob()`, but matches even internal-use + pages that globs do not usually match. +* "`title(glob)`", "`author(glob)`", "`authorurl(glob)`", + "`license(glob)`", "`copyright(glob)`" - match pages that have the given + metadata, matching the specified glob. For example, to match all pages in a blog that link to the page about music and were written in 2005: diff --git a/doc/index.mdwn b/doc/index.mdwn index bfbe46724..1a416d798 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -14,7 +14,8 @@ with ikiwiki, and some [[tips]]. All wikis are supposed to have a [[SandBox]], so this one does too. -This site generally runs the latest release of ikiwiki; currently, it runs ikiwiki [[version ]]. +This site generally runs the latest release of ikiwiki; currently, it runs +ikiwiki [[version ]]. ## developer resources diff --git a/doc/index/discussion.mdwn b/doc/index/discussion.mdwn index d5a48f282..4cf38e9cb 100644 --- a/doc/index/discussion.mdwn +++ b/doc/index/discussion.mdwn @@ -405,6 +405,9 @@ I'm playing around with various ways that I can use subversion with ikiwiki. > away without running the post-commit wrapper on commit, and all you lose > is the ability to send commit notification emails. +> (And now that [[recentchanges]] includes rss, you can just subscribe to +> that, no need to worry about commit notification emails anymore.) + * Is it possible / sensible to have ikiwiki share a subversion repository with other data (either completely unrelated files or another ikiwiki instance)? This works in part but again the post-commit hook seems problematic. --[[AdamShand]] diff --git a/doc/news/version_2.14/discussion.mdwn b/doc/news/discussion.mdwn index c3674a92d..c3674a92d 100644 --- a/doc/news/version_2.14/discussion.mdwn +++ b/doc/news/discussion.mdwn diff --git a/doc/news/no_more_email_notifications.mdwn b/doc/news/no_more_email_notifications.mdwn new file mode 100644 index 000000000..685a0d340 --- /dev/null +++ b/doc/news/no_more_email_notifications.mdwn @@ -0,0 +1,14 @@ +ikiwiki.info has upgraded to the not yet released ikiwiki 2.30. This +version of ikiwiki drops support for subscribing to commit mail +notifications for pages. The idea is that you can subscribe to the new +[[RecentChanges]] feed instead. (Or create your own custom feed of only the +changes you're interested in, and subscribe to that.) + +So if you were subscribed to mail notifications on here, you'll need to +change how you keep track of changes. Please let me know if there are any +missing features in the [[RecentChanges]] feeds. + +Statically building the RecentChanges also has performance implications, +I'll keep an eye on [[server_speed]].. + +--[[Joey]] diff --git a/doc/news/server_speed.mdwn b/doc/news/server_speed.mdwn index 512685438..cbb9513a9 100644 --- a/doc/news/server_speed.mdwn +++ b/doc/news/server_speed.mdwn @@ -1,15 +1,15 @@ Quick poll: Do you feel that ikiwiki is fast enough on this server, or -should I move it to my much beefier auxillary server? +should I move it to my much beefier auxiliary server? -[[poll 38 "It's fast enough" 4 "It's too slow!" 4 "No opinion"]] +[[poll 40 "It's fast enough" 5 "It's too slow!" 4 "No opinion"]] If you have specifics on performance issues, you might mention them on the [[discussion]] page. The current server is a single processor 2.8 ghz Sepron machine shared -amoung 4 other xen instances, and often +among 4 other xen instances, and often [heavily loaded](http://bluebird.kitenet.net/munin/kitenet.net/wren.kitenet.net-load.html) -by extraneous stuff like spamassassin and compiles. The auxillary server is +by extraneous stuff like spamassassin and compiles. The auxiliary server is a dual processor, dual core 2 ghz Opteron shared with other xen instances (exact number not available from provider), but with [little other load](http://bluebird.kitenet.net/munin/kitenet.net/bluebird.kitenet.net-load.html). diff --git a/doc/news/version_2.10.mdwn b/doc/news/version_2.10.mdwn deleted file mode 100644 index f4e7e11e7..000000000 --- a/doc/news/version_2.10.mdwn +++ /dev/null @@ -1,26 +0,0 @@ -ikiwiki 2.10 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Tidy ctime debug output for git. - * French translation update. Closes: #[445923](http://bugs.debian.org/445923) - * Fix --get-ctime with git, needed to remove srcdir from filename. - * In the cgi edit path, reload the index file before rendering. A bug - showed up where a web edit that added a page caused a near-concurrent - web edit to fail in will\_render. While it would be hard to reproduce this, - my analysis is that the failing cgi started first, loaded the index file - (prior to locking) then the other cgi created the new page and rendered - it, and then the failing cgi choked on the new file when \_it\_ tried to - render it. Ensuring that the index file is loaded after taking the lock - will avoid this bug. - * Fix strange stderr-hiding code in the git module, allow error messages - to be passed on to stderr. Also fixes a potential bug, since git error - meesages were treated as if they came from git stdout. - * Add a "createlink" class attribute to the span for wikilinks pointing - to not-yet-existing pages. I don't have a useful style defined for that - though. - * Rewritten rst plugin by madduck is a python program that communicates with - ikiwiki via XML RPC. This should be much faster than the old plugin that - had to fork python for every rst page render. Note that if you use - the rst plugin, you now need to have the RPC::XML perl module installed. - * Danish translation from Jonas Smedegaard. Closes: #[446952](http://bugs.debian.org/446952) - * Support git authors of the form "joey <joey>", which is common when - importing from a svn repo."""]]
\ No newline at end of file diff --git a/doc/news/version_2.11.mdwn b/doc/news/version_2.11.mdwn deleted file mode 100644 index 0126f9ff7..000000000 --- a/doc/news/version_2.11.mdwn +++ /dev/null @@ -1,23 +0,0 @@ -ikiwiki 2.11 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Correct a pair of logic errors that triggered if svnpath was empty. - * If gitorigin\_branch is set to the empty string, don't push or pull. - Useful for laptop clones of remote wikis. - * Add a calendar plugin, contributed by Manoj Srivastava. - * Reformat calendar plugin to ikiwiki conventions. - * The calendar plugin made *every* page depend on every other page, - which seemed a wee tiny little bit overkill. Fixed the dependency - calculations (I hope.) - * Removed manual ctime statting code, and just have the calendar plugin use - %pagectime. - * Ikiwiki has moved into a git repository. - * postsparkline: Avoid a confusing error message if no pages match - and instead show an empty graph. - * Add handling of feeds for nested inlines, as well as support for a - single page containing two different feeds. - * Also fixed some places in inline that failed to use destpage correctly. - * ikiwiki-mass-rebuild: Patch from HenrikBrixAndersen to fix order - of permissions dropping code to work on FreeBSD. - * ikiwiki-mass-rebuild: Don't clear PATH from the environment. - * Run git-commit -q (though it doesn't do much good due to its stderr - abuse)."""]]
\ No newline at end of file diff --git a/doc/news/version_2.12.mdwn b/doc/news/version_2.12.mdwn deleted file mode 100644 index 9c15298f8..000000000 --- a/doc/news/version_2.12.mdwn +++ /dev/null @@ -1,31 +0,0 @@ -ikiwiki 2.12 released with [[toggle text="these changes"]] -[[toggleable text=""" - * [ Joey Hess ] - * Fix some issues with toggles in preview mode. - * Fix an aggregate plugin expiry bug. Over time, it's possible for the same - page name to be expired and reused for several distinct guids. When this - happened, the expiry code counted each past guid that had used that page - name as a currently existing page, and thus expired too many pages. - * Avoid a race in the git rcs\_commit function, by not assuming HEAD will - stay the same for the duration of the function. - * Avoid using commands like git-diff and instead use "git diff". - In some configurations, only the main git command is in the path. - * Improve the RecentChanges display for git merges, by passing -c instead - of -m to git-log, and by skipping display of commits that change no - pages. - * Don't truncate git commit messages to the first line in RecentChanges, - show the full message. - * map: Recent changes caused unnecessary ul's to be inserted for items - that were all at the same level, fix. Closes: #[449285](http://bugs.debian.org/449285) - * [ Josh Triplett ] - * Fix table plugin to not generate an unbalanced tbody tag with header=no - * Add xmlns attribute on html element in templates; pages can now - validate. - * [ Joey Hess ] - * In the example setup file, use mode 6755 for the git post-update hook. - It needs to be setgid if the master repo is a shared repository, so - that pushes into the working copy repository happen as the same group, - avoiding permissions problems. - * The first git commit legitimately has no parents. Avoid recentchanges - spewing uninitialised value warnings and debug messages about it. - Dummying up a parent of 0000000 allows gitweb to work too."""]]
\ No newline at end of file diff --git a/doc/news/version_2.13.mdwn b/doc/news/version_2.13.mdwn deleted file mode 100644 index 902f8a813..000000000 --- a/doc/news/version_2.13.mdwn +++ /dev/null @@ -1,26 +0,0 @@ -ikiwiki 2.13 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Add liblwpx-paranoidagent-perl to recommends of Debian package, - this is needed to do OpenID really securely. - * ikiwiki.setup is licensed same as the basewiki, not GPLed. - * inline: Add timeformat parameter to control how the ctime of - inlined pages is displayed. Closes: #[451019](http://bugs.debian.org/451019) - * Add wrappergroup config option, which can be used to cause wrappers - to be created owned by some group other than the default. Useful - then there's a shared repository with access controlled by a group, - to let ikiwiki run setgid to that group. - * ikiwiki-mass-rebuild: Run build with the user in all their groups. - * Correct markdown in example index page in setup. Closes: #[451469](http://bugs.debian.org/451469) - * Better error message when a setup file has a syntax error. - Closes: #[451666](http://bugs.debian.org/451666) - * Fix mercurial historyurl in example setup file. - * More compact output for the brokenlinks plugin. - * Allow trailing slashes after page names in wikilinks. - * Don't consider links to anchors on the same page to be self links. - Patch by Daniel Burrows. Closes: #[451729](http://bugs.debian.org/451729) - * When usedirs is disabled, link direct to index.html files, not to - directories, to improve browsing of file:// urls. - Patch by Daniel Burrows. Closes: #[451728](http://bugs.debian.org/451728) - * Allow html5 video and audio tags and their attributes in the htmlscrubber. - * toc: Handle html elements embedded inside a header, rather than - stopping collecting the header text at the first element."""]] diff --git a/doc/news/version_2.14.mdwn b/doc/news/version_2.14.mdwn deleted file mode 100644 index aa3218581..000000000 --- a/doc/news/version_2.14.mdwn +++ /dev/null @@ -1,20 +0,0 @@ -This is a security fix release, upgrade is recommended. - -News for ikiwiki 2.14: - - This version of ikiwiki is more picky about symlinks in the path leading - to the srcdir, and will refuse to use a srcdir specified by such a path. - This was necessary to avoid some potential exploits, but could potentially - break (semi-)working wikis. If your wiki has a srcdir path containing a - symlink, you should change it to use a path that does not. - -ikiwiki 2.14 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Let CC be used to control what compiler is used to build wrappers. - * Use 'cc' instead of gcc as the default compiler. - * Security fix: Ensure that there are no symlinks anywhere in the path - to the top of the srcdir. In certian unusual configurations, an attacker - who could commit to one of the parent directories of the srcdir could - use a symlink attack to cause ikiwiki to publish files elsewhere in the - filesystem. More details [[here|security#index29h2]] -"""]] diff --git a/doc/news/version_2.15.mdwn b/doc/news/version_2.15.mdwn deleted file mode 100644 index dd448e85e..000000000 --- a/doc/news/version_2.15.mdwn +++ /dev/null @@ -1,13 +0,0 @@ -ikiwiki 2.15 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Add a new ikiwiki-makerepo program, that automates setting up a repo - and importing existing content for svn, git, and mercurial. This makes - the setup process much simpler. - * Reorganised git documentation. - * Actually install the ikiwiki-update-wikilist program. - * Improve workaround for perl bug #376329. Rather than double-encoding, - which has been reported to cause encoding problems (though I haven't - reproduced them), just catch a failure of markdown, and retry. - (The crazy perl bug magically disappears on the retry.) - Closes: #[449379](http://bugs.debian.org/449379) - * Add umask configuration option. Closes: #[443329](http://bugs.debian.org/443329)"""]]
\ No newline at end of file diff --git a/doc/news/version_2.16.mdwn b/doc/news/version_2.16.mdwn deleted file mode 100644 index 135a1ab5b..000000000 --- a/doc/news/version_2.16.mdwn +++ /dev/null @@ -1,80 +0,0 @@ -News for ikiwiki 2.16: - - Many of the pages in ikiwiki's basewiki have been moved and renamed in this - release, to avoid the basewiki including pages with names like "blog". - Redirection pages have been left behind for these moved pages temporarily, - and will be removed later. - - The meta plugin no longer supports setting internal or external links - with "meta link". Instead, use "meta openid" for openid links, and use tags - for in-wiki invisible links between pages. - - If you use the calendar plugin, ikiwiki is now smarter and your nightly - cron job to update the wiki doesn't need to rebuild everything. Just pass - --refresh to ikiwiki in the cron job and it will update only pages that - contain out of date calendars. - -ikiwiki 2.16 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Major basewiki reorganisation. Most pages moved into ikiwiki/ subdirectory - to avoid polluting the main namespace, and some were further renamed. - * meta: Add redir support, based on a patch by Thomas Schwinge. - * Redirs added for moved basewiki pages. These will be removed in a future - release. - * Remove .otl file from sandbox to avoid build ugliness. Closes: #[454181](http://bugs.debian.org/454181) - * Finally implemented a simple per-page data storage mechanism for plugins, - via the %pagestate hash. - * Use pagestate in meta to detect potential redir loops. - * Added a version plugin that saves state about what's using it, to force - pages to rebuild when ikiwiki's version changes. - * The calendar plugin stores state about when it needs to be updated, - and forces rebuilds of the pages that contain calendars. So - running ikiwiki --refresh at midnight is now enough, no need for a full - wiki rebuild each midnight. - * calendar: Work around block html parsing bug in markdown 1.0.1 by - enclosing the calendar in an extra div. - * Fix file pruning code to work if ikiwiki is run with "." as the srcdir. - * Add an edittemplate plugin, allowing registering template pages, that - provide default content for new pages created using the web frontend. - * Change formbuilder hook to not be responsible for displaying a form, - so that more than one plugin can use this hook. - I believe this is a safe change, since only passwordauth uses this hook. - (If some other plugin already used it, it would have broken passwordauth!) - * Ensure that web edited pages always end in a newline. - * Avoid unnecessary stat calls to get mtime when rendering pages, use - cached value. - * Preserve input file modification times in output files. - * Allow dashes in preprocessor directive commands, and shortcuts. - * Htmlize parameters passed to the template preprocessor directive before - inserting them into the html template. This ensures that markdown - acts on them, even if the value is expanded inside a block-level html - element in the html template. Closes: #[454058](http://bugs.debian.org/454058) - * Use a div in the note template rather than a span. - * shortcut: Expand %S to the raw input text, not url-encoded. - * Don't increment feed numbers when an inline has no feeds. (Nis Martensen) - * Allow editing a page and deleting all content, while still disallowing - creating a new page that's entirely empty. - * meta: Drop support for "meta link", since supporting this for internal - links required meta to be run during scan, which complicated its data - storage, since it had to clear data stored during the scan pass to avoid - duplicating it during the normal preprocessing pass. - * If you used "meta link", you should switch to either "meta openid" (for - openid delegations), or tags (for internal, invisible links). I assume - that nobody really used "meta link" for external, non-openid links, since - the htmlscrubber ate those. (Tell me differently and I'll consider bringing - back that support.) - * meta: Improved data storage. - * meta: Drop the hackish filter hook that was used to clear - stored data before preprocessing, this hack was ugly, and broken (cf: - liw's disappearing openids). - * aggregate: Convert filter hook to a needsbuild hook. - * map: Don't inline images. - * brokenlinks: Don't list the same link multiple times. (%links might - contain multiple copies of the same link) - * git: Correct display of multiline commit messages in recentchanges. - * Re-organise dependencies and recommends now that recommends are installed - by default. - * Don't refuse to render files with ".." in their name. (Anchor the regexp.) - * Work around perl taint checking bug #411786, where perl sometimes randomly - sets the taint flag on untainted variables, by disabling taint checking - in the deb. This sucks."""]] diff --git a/doc/news/version_2.17.mdwn b/doc/news/version_2.17.mdwn deleted file mode 100644 index f3993c72e..000000000 --- a/doc/news/version_2.17.mdwn +++ /dev/null @@ -1,16 +0,0 @@ -ikiwiki 2.17 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Improved parentlinks special case for index pages. - * redir: Support for specifying anchors. - * img: Avoid nesting images when linking to another image. Closes: #[457780](http://bugs.debian.org/457780) - * img: Allow the link parameter to point to an exterior url. - * conditional: Improve regexp testing for simple uses of pagespecs - that match only the page using the directive, adding 'included()' - and supporting negated pagespecs and added whitespace. - * map: Fix handling of common prefix to handle the case where it's - in a subdirectory. Patch by Larry Clapp. - * aggregate: Fix stupid mistake introduced when converting it to use - the needsbuild hook. This resulted in feeds not being removed when pages - were updated, and feeds sometimes being forgotten about. - * aggregate: Avoid uninitialised value warning when removing a feed that - has an expired guid."""]]
\ No newline at end of file diff --git a/doc/news/version_2.18.mdwn b/doc/news/version_2.18.mdwn deleted file mode 100644 index 4eee0bfff..000000000 --- a/doc/news/version_2.18.mdwn +++ /dev/null @@ -1,17 +0,0 @@ -ikiwiki 2.18 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Split error messages for failures to drop real uid and gid. - * Retry dropping uid and gid, possibly this will help with the "Resource - temporarily unavailable" failures I've experienced under xen. - * Stop testing Encode::is\_utf8 in decode\_form\_utf8: That doesn't work. - * decode\_form\_utf8 only fixed the utf-8 encoding for fields that were - registered at the time it was called, which was before the - formbuilder\_setup hook. Fields added by the hook didn't get decoded. - But it can't be put after the hook either, since plugins using the hook - need to be able to use form values. To fix this dilemma, it's been changed - to a decode\_cgi\_utf8, which is called on the cgi query object, before the - form is set up, and decodes *all* cgi parameters. - * aggregate: Only save state if it was already loaded. This didn't used to - matter, but after recent changes, state is not always loaded, and saving - would kill it. - * table: Fix dependency tracking for external data files. Closes: #[458387](http://bugs.debian.org/458387)"""]]
\ No newline at end of file diff --git a/doc/news/version_2.19.mdwn b/doc/news/version_2.19.mdwn deleted file mode 100644 index 005f1a379..000000000 --- a/doc/news/version_2.19.mdwn +++ /dev/null @@ -1,17 +0,0 @@ -ikiwiki 2.19 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Only try postsignin if no other action matched. Fixes a bug where the - user goes back from the signin screen and does something else. - * Improve behavior when trying to sign in with no cookies. - * Improved the canedit hook interface, allowing a callback function to be - returned (and not run in some cases) rather than the plugins directly - forcing a user to log in. - * opendiscussion: allow editing of the toplevel discussion page, - and, indirectly, allow creating new discussion pages. - * Add a prereq on Data::Dumper 2.11 or better, needed to dump q// objects. - * htmlscrubber: Further work around #365971 by adding tags for 'br/', 'hr/' - and 'p/'. - * aggregate: Include copyright statements from rss feed as meta copyright - directives. - * aggregate: Yet another state saving fix (sigh). - * aggregate: Add hack to support feeds with invalidly escaped html entities."""]]
\ No newline at end of file diff --git a/doc/news/version_2.30.mdwn b/doc/news/version_2.30.mdwn new file mode 100644 index 000000000..315a214d6 --- /dev/null +++ b/doc/news/version_2.30.mdwn @@ -0,0 +1,60 @@ +News for ikiwiki 2.30: + + Ever feel that ikiwiki's handling of RecentChanges wasn't truely in the + spirit of a wiki compiler? Well, that's changed. The RecentChanges page is + now a static page, not a CGI. Users can subscribe to its rss/atom feeds. + Custom RecentChanges pages can be easily set up that display only changes + to a subset of pages, or only changes by a subset of users. + + All wikis need to be rebuilt on upgrade to this version. If you listed your + wiki in /etc/ikiwiki/wikilist this will be done automatically when the + Debian package is upgraded. Or use ikiwiki-mass-rebuild to force a rebuild. + + With this excellent new RecentChanges support, the mail notification system + is showing its age (and known to be variously buggy and underimplemented for + various VCSes), and so ikiwiki's support for sending commit mails is REMOVED + from this version. If you were subscribed to commit mails, you should be + able to accomplish the same thing by subscribing to a RecentChanges feed. + + The "svnrepo" and "notify" fields in setup files are no longer used, and + silently ignored. You may want to remove them from your setup file. + +ikiwiki 2.30 released with [[toggle text="these changes"]] +[[toggleable text=""" + * [ Joey Hess ] + * Old versions of git-init don't support --git-dir or GIT\_DIR with + --bare. Change ikiwiki-makerepo to use a method that should work with + those older versions too. + * aggregate: Don't let feeds set creation times for pages in the future. + * Add full parser for git diff-tree output (Brian Downing) + * aggregate: Fork a child process to handle the aggregation. This simplifies + the code, since that process can change internal state as needed, and + it will automatically be cleaned up for the parent process, which proceeds + to render the changes. + * [ Josh Triplett ] + * Add trailing comma to commented-out umask in sample ikiwiki.setup, so + that uncommenting it does not break the setup file. + * [ Joey Hess ] + * inline: The template can check for FIRST and LAST, which will be + set for the first and last inlined page. Useful for templates that build + tables and the like. + * prettydate,ddate: Don't ignore time formats passed to displaytime + function. + * Pages with extensions starting with "\_" are internal-use, and will + not be rendered or web-edited, or matched by normal pagespecs. + * Add "internal()" pagespec that matches internal-use pages. + * RecentChanges is now a static html page, that's updated whenever a commit + is made to the wiki. It's built as a blog using inline, so it can have + an rss feed that users can subscribe to. + * Removed support for sending commit notification mails. Along with it went + the svnrepo and notify settings, though both will be ignored if left in + setup files. Also gone with it is the "user()" pagespec. + * Add refresh hook. + * meta: Add pagespec functions to match against title, author, authorurl, + license, and copyright. This can be used to create custom RecentChanges. + * meta: To support the pagespec functions, metadata about pages has to be + retained as pagestate. + * Fix encoding bug when pagestate values contained spaces. + * Add support for bzr, written by Jelmer Vernooij. Thanks also to bma for + his independent work on bzr support. + * Copyright file updates."""]] diff --git a/doc/news/version_2.8.mdwn b/doc/news/version_2.8.mdwn deleted file mode 100644 index 783ddf3f4..000000000 --- a/doc/news/version_2.8.mdwn +++ /dev/null @@ -1,14 +0,0 @@ -ikiwiki 2.8 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Redid the debian/copyright file, using the proposed new copyright file - format. Included many details not previously listed in the old file. - * inline: add feedonly option, set feedonly=yes to get only the feed button - but not inline the pages. - * meta: Support license and copyright information. The information will - be shown in the page footer. HTML will also be inserted that should - support the rel=license microformat as well as the HTML spec's - rel=copyright. - * table plugin: Actually specify the delimiter when parsing CSV. - * table plugin: The previous version broke WikiLinks inside quoted values. - Fix this by linkifying CSV data after parsing it, while DSV data is still - linkified before parsing."""]]
\ No newline at end of file diff --git a/doc/news/version_2.9.mdwn b/doc/news/version_2.9.mdwn deleted file mode 100644 index 225128a5b..000000000 --- a/doc/news/version_2.9.mdwn +++ /dev/null @@ -1,37 +0,0 @@ -News for ikiwiki 2.9: - - Since ikiwiki 2.0 was released, some limitiations have been added to what - ikiwiki considers a WikiLink. In short, if there are any spaces in between - the brackets, ikiwiki no longer considers it to be a WikiLink. If your wiki - contains things meant to be WikiLinks that contain spaces, you will need to - fix them, by replacing the spaces with underscores. - WikiLink have always been documented to not contain spaces, but bugs in - ikiwiki made it treat some text with spaces as WikiLinks. Most of these - bugs were fixed in version 2.2, and a final bug was fixed in this 2.9 - release. These fixes are necessary to avoid ambiguity between - WikiLinks and PreProcessorDirectives. Apologies for any inconvenience - these bugs (and their fixes) may have caused. - -ikiwiki 2.9 released with [[toggle text="these changes"]] -[[toggleable text=""" - * Fix copyright and licence styling. - * tag: Add taglink preprocessor directive, supporting visible tag links. - Closes: #[443344](http://bugs.debian.org/443344) - * map: Fully specify paths to links to avoid issues when the bestlink - didn't point to the correct page. - * map: Render pages on the way to subpages whose parent pages - are not included in the map. Include special styling for such pages. - * map: Remove common prefixes and don't over-indent. - * Add class option to htmllink(). - * img: Allow link=somepage to cause the image to link to a given page. - Slight overriding of link, as link=no is still used to disable the linking - entirely. Unless you have a page named "no".. - * Save index after previewing page edit, since even previewing can create - files in some situations, and this is appropriate in some cases, such as - the teximg plugin's error log file. - Such files will be automatically cleaned up at an appopriate later time. - * Don't allow whitespace in link text in a wikilink. This was still - allowed by the regexp in one case though not documented to work, and - was ambiguous with preprocessor directives. - * camelcase: Tighten regexp to avoid false positives. WikiWords are only - linkified now if they are preceeded by whitespace."""]]
\ No newline at end of file diff --git a/doc/patch.mdwn b/doc/patch.mdwn index 05476a408..ca1620225 100644 --- a/doc/patch.mdwn +++ b/doc/patch.mdwn @@ -4,5 +4,8 @@ to duplicate work without coordination, here's a queue of suggested patches. If you post a patch to the [[todo]] or [[bugs]] list, or elsewhere, once it's ready to be applied, add a 'patch' tag so it will show up here. +If your patch is non-trivial and might need several iterations to get +right, please consider publishing a [[git]] branch. + [[inline pages="(todo/* or bugs/*) and link(patch) and !link(bugs/done) and !link(todo/done) and !*/Discussion" rootpage="todo" archive="yes"]] diff --git a/doc/plugins/brokenlinks.mdwn b/doc/plugins/brokenlinks.mdwn index 23fa04d7c..208d7120b 100644 --- a/doc/plugins/brokenlinks.mdwn +++ b/doc/plugins/brokenlinks.mdwn @@ -10,4 +10,4 @@ pages to search for broken links, default is search them all. If this plugin is turned on, here's a list of broken links on this wiki: -[[brokenlinks ]] +[[brokenlinks pages="* and !recentchanges"]] diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn index 798a5c8c2..74f4bae08 100644 --- a/doc/plugins/orphans.mdwn +++ b/doc/plugins/orphans.mdwn @@ -15,5 +15,6 @@ orphans. Here's a list of orphaned pages on this wiki: [[orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and -!examples/* and !tips/* and !sandbox/* and !wikiicons/* and !plugins/*"]] +!recentchanges and !examples/* and !tips/* and !sandbox/* and +!wikiicons/* and !plugins/*"]] """]] diff --git a/doc/plugins/pagecount.mdwn b/doc/plugins/pagecount.mdwn index 9a9768277..8f7029df8 100644 --- a/doc/plugins/pagecount.mdwn +++ b/doc/plugins/pagecount.mdwn @@ -10,5 +10,5 @@ pages to count, default is to count them all. This plugin is included in ikiwiki, but is not enabled by default. If it is turned on it can tell us that this wiki includes -[[pagecount ]] pages, of which [[pagecount pages="*/Discussion"]] are -discussion pages. +[[pagecount pages="* and !recentchanges"]] +pages, of which [[pagecount pages="*/Discussion"]] are discussion pages. diff --git a/doc/plugins/recentchanges.mdwn b/doc/plugins/recentchanges.mdwn new file mode 100644 index 000000000..b48dcbacf --- /dev/null +++ b/doc/plugins/recentchanges.mdwn @@ -0,0 +1,26 @@ +[[template id=plugin name=recentchanges core=1 author="[[Joey]]"]] + +This plugin examines the [[revision_control_system|rcs]] history and +generates a page describing each recent change made to the wiki. These +pages can be joined together with [[inline]] to generate the +[[RecentChanges]] page. + +Typically only the RecentChanges page will use the pages generated by this +plugin, but you can use it elsewhere too if you like. It's used like this: + + \[[inline pages="internal(recentchanges/change_*)" + template=recentchanges show=0]] + +Here's an example of how to show only changes to "bugs/*". +This matches against the title of the change, which includes a list of +modified pages. + + \[[inline pages="internal(recentchanges/change_*) and title(*bugs/*)" + template=recentchanges show=0]] + +Here's an example of how to show only changes that Joey didn't make. +(Joey commits sometimes as user `joey`, and sometimes via openid.) + + \[[inline pages="internal(recentchanges/change_*) and + !author(joey) and !author(http://joey.kitenet.net*)" + template=recentchanges show=0]] diff --git a/doc/plugins/recentchanges/discussion.mdwn b/doc/plugins/recentchanges/discussion.mdwn new file mode 100644 index 000000000..a16cb5217 --- /dev/null +++ b/doc/plugins/recentchanges/discussion.mdwn @@ -0,0 +1,17 @@ +Thanks for that one, again, it's great! + +One minor thing I noticed, seen on <http://www.bddebian.com/~wiki/recent_changes/>: +The links to user pages of e.g. *MichaelBanck* or *GianlucaGuida* don't work, as they're +being linked to <http://www.bddebian.com/~wiki/user/MichaelBanck>, whereas it should be +<http://www.bddebian.com/~wiki/user/michaelbanck>. + +> I've fixed this.. --[[Joey]] + +Another one. If you change the *recentchangespage* configuration option, (it seems to me) +that the pages from the old hierarchy will not be removed from the disk. But then, changing +this should be a rather uncommon thing. + +--[[tschwinge]] + +> And fixed this, by making it look at all *._change pages, not just +> those in a specific directory, when deciding which to expire. --[[Joey]] diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 0da425402..e1e057c00 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -82,11 +82,19 @@ configuration. It's called early in the startup process. The function is passed no values. It's ok for the function to call `error()` if something isn't configured right. +### refresh + + hook(type => "refresh", id => "foo", call => \&refresh); + +This hook is called just before ikiwiki scans the wiki for changed files. +It's useful for plugins that need to create or modify a source page. The +function is passed no values. + ### needsbuild hook(type => "needsbuild", id => "foo", call => \&needsbuild); -This allows a plugin the manipulate the list of files that need to be +This allows a plugin to manipulate the list of files that need to be built when the wiki is refreshed. The function is passed a reference to an array of pages that will be rebuilt, and can modify the array, either adding or removing files from it. @@ -214,8 +222,11 @@ source files that were rendered. Use this to hook into ikiwiki's cgi script. Each registered cgi hook is called in turn, and passed a CGI object. The hook should examine the -parameters, and if it will handle this CGI request, output a page (including the http headers) and -terminate the program. +parameters, and if it will handle this CGI request, output a page +(including the http headers) and terminate the program. + +Note that cgi hooks are called as early as possible, before any ikiwiki +state is loaded, and with no session information. ### auth @@ -470,8 +481,13 @@ If the destination directory doesn't exist, it will first be created. Given a page name and a destination file name (not including the base destination directory), register that the page will result in that file -being rendered. It's important to call this before writing to any file in -the destination directory. +being rendered. + +It's important to call this before writing to any file in the destination +directory, and it's important to call it consistently every time, even if +the file isn't really written this time -- unless you delete any old +version of the file. In particular, in preview mode, this should still be +called even if the file isn't going to be written to during the preview. Ikiwiki uses this information to automatically clean up rendered files when the page that rendered them goes away or is changes to no longer render @@ -523,6 +539,19 @@ destination file, as registered by `will_render`. Passed a page and an extension, returns the filename that page will be rendered to. +## Internal use pages + +Sometimes it's useful to put pages in the wiki without the overhead of +having them be rendered to individual html files. Such internal use pages +are collected together to form the RecentChanges page, for example. + +To make an internal use page, register a filename extension that starts +with "_". Internal use pages cannot be edited with the web interface, +generally shouldn't contain wikilinks or preprocessor directives (use +either on them with extreme caution), and are not matched by regular +PageSpecs glob patterns, but instead only by a special `internal()` +[[ikiwiki/PageSpec]]. + ## RCS plugins ikiwiki's support for [[revision_control_systems|rcs]] also uses pluggable diff --git a/doc/post-commit.mdwn b/doc/post-commit.mdwn index 18eae1735..1c5176d42 100644 --- a/doc/post-commit.mdwn +++ b/doc/post-commit.mdwn @@ -1,7 +1,8 @@ If your wiki is kept in [[revision_control|rcs]], a post-commit hook is run every time you commit a change to your repository. -ikiwiki generates the "post-commit hook" once you've uncommented the relevant section (under wrappers) in the ikiwiki.setup. +ikiwiki generates the "post-commit hook" once you've uncommented the relevant +section (under wrappers) in the ikiwiki.setup. The generated wrapper is a C program that is designed to safely be made suid if necessary. It's hardcoded to run ikiwiki with the settings @@ -14,4 +15,5 @@ your wiki checkout and html directory. If so, you can safely make the wrapper suid to a user who can write there (*not* to root!). You might want to read [[Security]] first. -[[Setup]] explains setting this up from the start and see [[rcs/details]] to know more. +[[Setup]] explains setting this up from the start and see [[rcs/details]] to +know more. diff --git a/doc/rcs/bzr.mdwn b/doc/rcs/bzr.mdwn new file mode 100644 index 000000000..19a7ae395 --- /dev/null +++ b/doc/rcs/bzr.mdwn @@ -0,0 +1,8 @@ +[Bazaar](http://bazaar-vcs.org/) is a distributed revison control +system developed by Canonical Ltd. Ikiwiki supports storing a wiki in a +bzr repository. + +Ikiwiki can run as a post-update hook to update a wiki whenever commits +come in. When running as a [[cgi]] with bzr, ikiwiki automatically +commits edited pages, and uses the bzr history to generate the +[[RecentChanges]] page. diff --git a/doc/rcs/details.mdwn b/doc/rcs/details.mdwn index 6b9ffb91f..449e129bd 100644 --- a/doc/rcs/details.mdwn +++ b/doc/rcs/details.mdwn @@ -352,3 +352,5 @@ merge again with a merger that inserts conflict markers. It commits this new revision with conflict markers to the repository. It then returns the text to the user for cleanup. This is less neat than it could be, in that a conflict marked revision gets committed to the repository. + +## [[bzr]] diff --git a/doc/rcs/git.mdwn b/doc/rcs/git.mdwn index 0353d1535..f97131742 100644 --- a/doc/rcs/git.mdwn +++ b/doc/rcs/git.mdwn @@ -22,7 +22,7 @@ but it works the best for typical ikiwiki use. and git. It is **paramount** that you **never** push to the non-bare repository -([this FAQ entry explains why](http://git.or.cz/gitwiki/GitFaq#head-b6a3d85f677763313159eb39f7dbf4579d4ee28b)). +([this FAQ entry explains why](http://git.or.cz/gitwiki/GitFaq#head-b96f48bc9c925074be9f95c0fce69bcece5f6e73)). Instead, if you want to work on the wiki from a remote machine, clone the bare repository, using either the `git` transport (if available), or `ssh`. @@ -39,7 +39,7 @@ should go to the bare repository, which has a `post-update` hook that uses ikiwiki to pull the changes to the srcdir. One setup that will work is to put all committers in a group (say, -ikiwiki), and use permissions to allow that group to commit to the bare git +"ikiwiki"), and use permissions to allow that group to commit to the bare git repository. Make both the post-update hook and ikiwiki.cgi be setgid to the group, as well as suid to the user who admins the wiki. The `wrappergroup` [[setup_file_option|usage]] can be used to make the wrappers diff --git a/doc/rcs/monotone.mdwn b/doc/rcs/monotone.mdwn index d79381571..f9f474291 100644 --- a/doc/rcs/monotone.mdwn +++ b/doc/rcs/monotone.mdwn @@ -1,16 +1,20 @@ -[monotone](http://monotone.ca/) is a distributed revision control system. -Ikiwiki supports storing a wiki in Monotone and editing it using the [[cgi]] interface. -It will use the Monotone logs to generate the [[RecentChanges]] page. +[Monotone](http://monotone.ca/) is a distributed revision control system. +Ikiwiki supports storing a wiki in a Monotone repository and editing it +using the [[cgi]] interface. It will use the Monotone logs to generate the +[[RecentChanges]] page. -The monotone support requires the Monotone perl module (from the contrib/ directory -in the monotone source) to be installed. In particular, it needs version 0.03 or higher of that module. +The monotone support in ikiwiki requires the Monotone perl module to be +installed. (It's available from the contrib/ directory in the monotone +source.) In particular, it needs version 0.03 or higher of that module. The module is available from the monotone source repository at: <http://viewmtn.angrygoats.net/branch/changes/net.venge.monotone> Monotone support works, but there are still a few minor missing bits (listed here so they are not forgotten): -* At the moment there are no links to display diffs between revisions. It shouldn't be hard to add links to a [ViewMTN](http://grahame.angrygoats.net/moinmoin/ViewMTN) instance, but it hasn't been done yet. -* The [[post-commit]] hook support, so that Ikiwiki sends change notifications when people commit using Monotone rather than the web interface, is partially implemented and untested. +* The [[post-commit]] hook support is not yet completly implemented. * Documentation (this page) could be improved. -There is also a mismatch between the way Ikiwiki handles conflicts and the way Monotone handles conflicts. At present, if there is a conflict, then Ikiwiki will commit a revision with conflict markers before presenting it to the user. This is ugly, but there is no clean way to fix it at present. +There is also a mismatch between the way Ikiwiki handles conflicts and the +way Monotone handles conflicts. At present, if there is a conflict, then +Ikiwiki will commit a revision with conflict markers before presenting it +to the user. This is ugly, but there is no clean way to fix it at present. diff --git a/doc/recentchanges.mdwn b/doc/recentchanges.mdwn index 2e67f02e7..f83298187 100644 --- a/doc/recentchanges.mdwn +++ b/doc/recentchanges.mdwn @@ -1,3 +1,5 @@ -ikiwiki generates the list of recent changes by examining the history of -the [[revision_control_system|rcs]] that the wiki is configured to use. You -have to have [[CGI]] set up for this feature to be enabled. +[[meta title="RecentChanges"]] +Recent changes to this wiki: + +[[inline pages="internal(recentchanges/change_*) and !*/Discussion" +template=recentchanges show=0]] diff --git a/doc/sandbox.mdwn b/doc/sandbox.mdwn index 84175d68c..69d7a217b 100644 --- a/doc/sandbox.mdwn +++ b/doc/sandbox.mdwn @@ -1,51 +1,19 @@ This is the SandBox, a page anyone can edit to try out this fab ikiwiki. -# Table of Contents -testhead -sandbox - - -<h2>testhead</h2> ----- -Do re me fa so la te... git? - -i see. i see. lalala hmmmmmmmm. - -## sandbox -[[sandbox]] does that work? yep. yay! - -# テスト。 - -Test. Korean. 나는 한국인, 백두산,동해 - -Test. Chinese. 我是中国人，泰山、黄河。 - -testing openid ... ignore. - -Test. Проверка. Тэстенг. テスト ığüşöçİ ทดสอบ éphémère - Testing right-to-left text: (שרה) should be spelled shin (ש) resh (ר) heh (ה) from right to left. -Testing it in a comment... - Here's a paragraph. Here's another one with *emphasised* text. do ë characters work? Sure. -OpenID test. It works!! - Hupple hupple hupple hupple snork. -Exactly my point! - -Test.. - -A [[nonexistingpage]] - There are Polish diacritical characters: ą, ć, ę, ł, ń, ó, ś, ż, ź. +Korean characters test : 한글테스트입니다. + # Header ## Subheader @@ -83,7 +51,7 @@ Bulleted list * three * four * five - * six + ---- [[template id=note text="this is generated by the [[plugins/haiku]] plugin"]] @@ -99,7 +67,8 @@ Bulleted list * [GNU](http://www.gnu.org/) * [Email](mailto:noone@invalid) * [](http://ikiwiki.info) -* <a href="http://www.google.com/>do html links work?</a> +* <a href="http://www.google.com/">plain old html link</a> + ----- This sandbox is also a [[ikiwiki/blog]]! diff --git a/doc/sandbox/testsubpage.mdwn b/doc/sandbox/testsubpage.mdwn new file mode 100644 index 000000000..3db7aaaab --- /dev/null +++ b/doc/sandbox/testsubpage.mdwn @@ -0,0 +1,3 @@ +# Test subpage + +This is a test subpage. Isn't that special? diff --git a/doc/setup.mdwn b/doc/setup.mdwn index af1adc235..9d7aecabd 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -135,6 +135,12 @@ about using the git repositories. ikiwiki-makerepo mercurial $SRCDIR """]] +[[toggle id=mercurial text="Bazaar"]] +[[toggleable id=bazaar text=""" + REPOSITORY=$SRCDIR + ikiwiki-makerepo bzr $SRCDIR +"""]] + [[toggle id=tla text="TLA"]] [[toggleable id=tla text=""" REPOSITORY=~/wikirepo @@ -180,8 +186,7 @@ about using the git repositories. Once your wiki is checked in to the revision control system, you should configure ikiwiki to use revision control. Edit your ikiwiki.setup, and uncomment the lines for the revision control system -you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using -subversion. Uncomment the block for the wrapper for your revision +you chose to use. Uncomment the block for the wrapper for your revision control system, and configure the wrapper path in that block appropriately (for Git, it should be `$REPOSITORY/hooks/post-update`). diff --git a/doc/sitemap.mdwn b/doc/sitemap.mdwn index 939f20a74..836ccdb9a 100644 --- a/doc/sitemap.mdwn +++ b/doc/sitemap.mdwn @@ -1,5 +1,6 @@ This map excludes discussion pages, as well as subpages that are in feeds. -[[map pages="* and !*/discussion -and !bugs/* and !examples/*/* and !news/* and !tips/* and !plugins/* and !sandbox/* and !todo/* and !users/* +[[map pages="* and !*/discussion and !recentchanges +and !bugs/* and !examples/*/* and !news/* and !tips/* and !plugins/* +and !sandbox/* and !todo/* and !users/* and !*.css and !*.ico and !*.png and !*.svgz and !*.gif"]] diff --git a/doc/style.css b/doc/style.css index 0fa15d2b1..026d2c881 100644 --- a/doc/style.css +++ b/doc/style.css @@ -70,27 +70,49 @@ img { border-style: none; } -/* Stuff for the RecentChanges table. */ -tr.changeheader { +div.recentchanges { + border-style: solid; + border-width: 1px; + overflow: auto; + width: 100%; background: #eee; color: black !important; } -tr.changeinfo { - background: #eee; +.recentchanges .metadata { + padding: 0px 0.5em; +} +.recentchanges .changelog { + font-style: italic; + clear: both; + display: block; + padding: 1px 2px; + background: white !important; color: black !important; } -th.changeheader { - padding: 1px .3em; +.recentchanges .desc { + display: none; +} +.recentchanges .committer { + float: left; + margin: 0; + width: 40%; } -td.changeinfo { - padding: 1px .3em; +.recentchanges .committype { + float: left; + margin: 0; + width: 5%; + font-size: small; } -td.changetime { - white-space: nowrap; - padding: 1px .3em; +.recentchanges .changedate { + float: left; + margin: 0; + width: 35%; + font-size: small; } -td.changelog { - font-style: italic; +.recentchanges .pagelinks { + float: right; + margin: 0; + width: 60%; } /* Used for adding a blog page. */ diff --git a/doc/todo/Commit_emails:_ones_own_changes.mdwn b/doc/todo/Commit_emails:_ones_own_changes.mdwn index d577c454f..862a85071 100644 --- a/doc/todo/Commit_emails:_ones_own_changes.mdwn +++ b/doc/todo/Commit_emails:_ones_own_changes.mdwn @@ -4,3 +4,6 @@ What's the rationale behind excluding ones own changes from the commit emails se > Well, commit mails are intended to keep you informed of changes in the > wiki, and I assumed you'd know about changes you made yourself. > --[[Joey]] + +> [[done]] -- commit mails removed; recentchanges feeds can be configured +> for whatever you like. diff --git a/doc/todo/Inline_plugin_option_to_show_full_page_path.mdwn b/doc/todo/Inline_plugin_option_to_show_full_page_path.mdwn index ab9cd61e4..30490e9d3 100644 --- a/doc/todo/Inline_plugin_option_to_show_full_page_path.mdwn +++ b/doc/todo/Inline_plugin_option_to_show_full_page_path.mdwn @@ -15,14 +15,14 @@ Cheers, > that contains the full page name. Then you just use a modified > `inlinepage.tmpl`, that uses that instead of the title. --[[Joey]] -diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm -index 59eabb6..82913ba 100644 ---- a/IkiWiki/Plugin/inline.pm -+++ b/IkiWiki/Plugin/inline.pm -@@ -229,6 +229,7 @@ sub preprocess_inline (@) { #{{{ - $template->param(content => $content); - } - $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage})); -+ $template->param(page => $page); - $template->param(title => pagetitle(basename($page))); - $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat})); + diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm + index 59eabb6..82913ba 100644 + --- a/IkiWiki/Plugin/inline.pm + +++ b/IkiWiki/Plugin/inline.pm + @@ -229,6 +229,7 @@ sub preprocess_inline (@) { #{{{ + $template->param(content => $content); + } + $template->param(pageurl => urlto(bestlink($params{page}, $page), $params{destpage})); + + $template->param(page => $page); + $template->param(title => pagetitle(basename($page))); + $template->param(ctime => displaytime($pagectime{$page}, $params{timeformat})); diff --git a/doc/todo/__34__subscribe_to_this_page__34___checkbox_on_edit_form.mdwn b/doc/todo/__34__subscribe_to_this_page__34___checkbox_on_edit_form.mdwn index 70970c6cc..dc456bbbf 100644 --- a/doc/todo/__34__subscribe_to_this_page__34___checkbox_on_edit_form.mdwn +++ b/doc/todo/__34__subscribe_to_this_page__34___checkbox_on_edit_form.mdwn @@ -3,4 +3,8 @@ user to add a page to their subscribed list while editing. This would prove particularly useful for [[todo]] and [bug](bugs) items, to allow users to receive notifications for activity on their reports. ---[[JoshTriplett]]
\ No newline at end of file +--[[JoshTriplett]] + +I went and removed commit notification mails entirely, the idea is that you +subscribe using the [[RecentChanges]] rss feed, and filter it on your end. +Good enough? --[[Joey]] diff --git a/doc/todo/aggregate_locking.mdwn b/doc/todo/aggregate_locking.mdwn new file mode 100644 index 000000000..b6c82e923 --- /dev/null +++ b/doc/todo/aggregate_locking.mdwn @@ -0,0 +1,64 @@ +The [[plugin/aggregate]] plugin's locking is a suboptimal. + +There should be no need to lock the wiki while aggregating -- it's annoying +that long aggregate runs can block edits from happening. However, not +locking would present problems. One is, if an aggregate run is happening, +and the feed is removed, it could continue adding pages for that feed. +Those pages would then become orphaned, and stick around, since the feed +that had created them is gone, and thus there's no indication that they +should be removed. + +To fix that, garbage collect any pages that were created by +aggregation once their feed is gone. + +Are there other things that could happen while it's aggregating that it +should check for? + +Well, things like the feed url etc could change, and it +would have to merge in such changes before saving the aggregation state. +New feeds could also be added, feeds could be moved from one source page to +another. + +Merging that feed info seems doable, just re-load the aggregation state +from disk, and set the `message`, `lastupdate`, `numposts`, and `error` +fields to their new values if the feed still exists. + +---- + +Another part of the mess is that it needs to avoid stacking multiple +aggregate processes up if aggregation is very slow. Currently this is done +by taking the lock in nonblocking mode, and not aggregating if it's locked. +This has various problems, for example a page edit at the right time can +prevent aggregation from happening. + +Adding another lock just for aggregation could solve this. Check that lock +(in checkconfig) and exit if another aggregator holds it. + +---- + +The other part of the mess is that it currently does aggregation in +checkconfig, locking the wiki for that, and loading state, and then +dropping the lock, unloading state, and letting the render happen. Which +reloads state. That state reloading is tricky to do just right. + +A simple fix: Move the aggregation to the new 'render' hook. Then state +would be loaded, and there would be no reason to worry about aggregating. + +Or aggregation could be kept in checkconfig, like so: + +* load aggregation state +* get list of feeds needing aggregation +* exit if none +* attempt to take aggregation lock, exit if another aggregation is happening +* fork a child process to do the aggregation + * load wiki state (needed for aggregation to run) + * aggregate + * lock wiki + * reload aggregation state + * merge in aggregation state changes + * unlock wiki +* drop aggregation lock +* force rebuild of sourcepages of feeds that were aggregated +* exit checkconfig and continue with usual refresh process + +[[done]] diff --git a/doc/todo/aggregate_to_internal_pages.mdwn b/doc/todo/aggregate_to_internal_pages.mdwn new file mode 100644 index 000000000..a4164fa25 --- /dev/null +++ b/doc/todo/aggregate_to_internal_pages.mdwn @@ -0,0 +1,5 @@ +The new internal page feature is designed for something like +[[plugins/aggregate]]. + +How to transition to it though? inlines of aggregated content would need to +change their pagespecs to use `internal()`. diff --git a/doc/todo/allow_wiki_syntax_in_commit_messages.mdwn b/doc/todo/allow_wiki_syntax_in_commit_messages.mdwn index 01c5d397b..97691bdc3 100644 --- a/doc/todo/allow_wiki_syntax_in_commit_messages.mdwn +++ b/doc/todo/allow_wiki_syntax_in_commit_messages.mdwn @@ -9,4 +9,13 @@ a whole page into RecentChanges. Of course, it could only use _one_ of the available markups, ie the default markdown. --[[Joey]] To go along with this, the preview should show the formatted commit message. ---[[JoshTriplett]]
\ No newline at end of file +--[[JoshTriplett]] + +This is really easy to do now, but it would have to be limited to applying +markdown formatting (or whatever formatter is default I suppose) to the +content, and *not* to expanding any WikiLinks or preprocessor directives. +Especially with the new static RecentChanges, expanding even wikilinks +would be pretty tricky to do. Applying markdown formatting seems like a +reasonable thing; it would make commit messages that have the form of a +bulletted list be marked up nicely, and would also handle _emphasised_ +words etc, and even http links. --[[Joey]] diff --git a/doc/todo/bzr.mdwn b/doc/todo/bzr.mdwn index dbe35245c..179ea2f24 100644 --- a/doc/todo/bzr.mdwn +++ b/doc/todo/bzr.mdwn @@ -4,6 +4,8 @@ rcs_commit was only changed to work around bzr's lack of a switch to set the username). bzr_log could probably be written better by someone better at perl, and rcs_getctime and rcs_notify aren't written at all. --[[bma]] +(rcs_notify is not needed in this branch --[[Joey]]) + #!/usr/bin/perl use warnings; @@ -183,4 +185,10 @@ and rcs_getctime and rcs_notify aren't written at all. --[[bma]] >>> It's new (in fact I'm not even sure that it made it in to 0.90, it might be in 0.91 due >>> in a couple of weeks. ->>> I was just noting it for a future enhancement. --[[JamesWestby]]
\ No newline at end of file +>>> I was just noting it for a future enhancement. --[[JamesWestby]] + +> I've just posted another patch with support for bzr, including support for +> --author and a testsuite to git://git.samba.org/jelmer/ikiwiki.git. I hadn't +> seen this page earlier. --[[jelmer]] + +> I used jelmer's patch --[[done]]! --[[Joey]] diff --git a/doc/todo/ctime_on_blog_post_pages_.mdwn b/doc/todo/ctime_on_blog_post_pages_.mdwn new file mode 100644 index 000000000..4fd099d9d --- /dev/null +++ b/doc/todo/ctime_on_blog_post_pages_.mdwn @@ -0,0 +1,5 @@ +[[Blog|ikiwiki/blog]] feeds and index pages show the posted time (ctime), the actual blog entry pages only show the modified time. + +The user has to look at the history link to find when a blog item was posted. + +It would be nice if blog entry post pages could include the ctime. -- [[Edward_Betts]] diff --git a/doc/todo/doxygen_support.mdwn b/doc/todo/doxygen_support.mdwn new file mode 100644 index 000000000..ae31c1603 --- /dev/null +++ b/doc/todo/doxygen_support.mdwn @@ -0,0 +1,7 @@ +[[tag wishlist]] + +Given that ikiwiki has a suggested use as a tool for developers, I was thinking it might be cool if ikiwiki had [Doxygen](http://www.doxygen.org/) support. I'm not exactly sure how the integration would work. Something along the lines of a plugin to support .dox files would be my first thought. I'd leave generating the documentation from any source files for a separate run of Doxygen - it'd be easier and you probably don't want the source being edited over the web. + +#### Background #### + +I have been involved with one project that uses Doxygen to generate their web pages and user docs, as well as their 'in code' documentation: <http://orca-robotics.sourceforge.net/orca/index.html>. This makes the whole system somewhat like ikiwiki, but without the cgi for public editing. I was thinking of trying to convince that project to move to ikiwiki, but they're not going to want to re-write all their documentation. diff --git a/doc/todo/httpauth_example.mdwn b/doc/todo/httpauth_example.mdwn index f67f67371..0c6268aa1 100644 --- a/doc/todo/httpauth_example.mdwn +++ b/doc/todo/httpauth_example.mdwn @@ -3,3 +3,6 @@ authentication (perhaps as a [[tip|tips]]), showing how to authenticate the user for edits without requiring authentication for the entire wiki. (Ideally, recentchanges should work without authentication as well, even though it goes through the CGI.) --[[JoshTriplett]] + +> (Now that recentchanges is a static page, it auths the same as other wiki +> pages.) --[[Joey]] diff --git a/doc/todo/mercurial.mdwn b/doc/todo/mercurial.mdwn index e5de93521..608c7d681 100644 --- a/doc/todo/mercurial.mdwn +++ b/doc/todo/mercurial.mdwn @@ -1,6 +1,6 @@ * Need to get post commit hook working (or an example of how to use it.) * See below. --[[bma]] -* rcs_notify is not implemented +* rcs_notify is not implemented (not needed in this branch --[[Joey]]) * Is the code sufficiently robust? It just warns when mercurial fails. * When rcs_commit is called with a $user that is an openid, it will be passed through to mercurial -u. Will mercurial choke on this? diff --git a/doc/todo/mtime.mdwn b/doc/todo/mtime.mdwn new file mode 100644 index 000000000..92cbe84ff --- /dev/null +++ b/doc/todo/mtime.mdwn @@ -0,0 +1,14 @@ +It'd be nice if the mtime of the files ikiwiki renders matched the mtime of +the source files. + +However, this turns out to be more complex than just calling utime() a few +times. If a page inlines other, younger pages, then having an older mtime +means that an old version of it will be kept in web caches, forcing +annoying shift-reloads to see the changed content (for example). + +And it's not just inline. The template plugin means that a change to a +template can result in changes to how a page gets rendered. The version +plugin changes page content without any younger page being involved. And +editing one of the html templates and rebuilding the wiki can change every +page. All of these need to be reflected in the file mtime to avoid caching +problems. diff --git a/doc/todo/multiple_output_formats.mdwn b/doc/todo/multiple_output_formats.mdwn index 76fd39303..00623be39 100644 --- a/doc/todo/multiple_output_formats.mdwn +++ b/doc/todo/multiple_output_formats.mdwn @@ -5,4 +5,13 @@ This would provide true "printable versions" of the wiki pages supporting it. --[[JeremieKoenig]] +Could this be done by making the output format a plugin, similar to the way +pyblosxom works? Atom and RSS could then possibly be moved into plugins. + +Presumably they'd have to work by converting HTML into some other format, as +trying to force all input languages to generate more than one output language +would be impractical to say the least. + +--[[bma]] + [[tag wishlist]] diff --git a/doc/todo/multiple_templates.mdwn b/doc/todo/multiple_templates.mdwn index 361270bb9..d165eebaf 100644 --- a/doc/todo/multiple_templates.mdwn +++ b/doc/todo/multiple_templates.mdwn @@ -1,11 +1,11 @@ -> Another useful feature might be to be able to choose a different template -> file for some pages; blog pages would use a template different from the +> Another useful feature might be to be able to choose a different [[template|wikitemplates]] +> file for some pages; [[blog|ikiwiki/blog]] pages would use a template different from the > home page, even if both are managed in the same repository, etc. -Well, that would probably be fairly easy to add if it used pagespecs to +Well, that would probably be fairly easy to add if it used [[pagespecs|ikiwiki/pagespec]] to specify which pages use the non-default template. -Hmm, I think the pagetemplate hook should allow one to get close enough to +Hmm, I think the [[pagetemplate|plugins/pagetemplate]] hook should allow one to get close enough to this in a plugin now. See also: [[Allow_per-page_template_selection]] -- same thing, really. diff --git a/doc/todo/passwordauth:_sendmail_interface.mdwn b/doc/todo/passwordauth:_sendmail_interface.mdwn index 4714a7a09..4bbda6565 100644 --- a/doc/todo/passwordauth:_sendmail_interface.mdwn +++ b/doc/todo/passwordauth:_sendmail_interface.mdwn @@ -44,7 +44,6 @@ Remaining TODOs: just for this bit of functionality? * Debian news file. * ikiwiki news file. - * Are commit emails still working? --[[tschwinge]] diff --git a/doc/todo/plugin.mdwn b/doc/todo/plugin.mdwn index 0d702975f..89dbb04a2 100644 --- a/doc/todo/plugin.mdwn +++ b/doc/todo/plugin.mdwn @@ -6,20 +6,6 @@ Suggestions of ideas for plugins: > web-server-specific code to list all users, and openid can't feasibly do so > at all. --[[JoshTriplett]] -* Support [[RecentChanges]] as a regular page containing a plugin that - updates each time there is a change, and statically builds the recent - changes list. (Would this be too expensive/inflexible? There might be - other ways to do it as a plugin, like making all links to RecentChanges - link to the cgi and have the cgi render it on demand.) - - Or using an iframe - to inline the cgi, although firefox seems to render that nastily with - nested scroll bars. :-( -> Or just link to the equivalent in the version control system, if available; -> gitweb's shortlog or summary view would work nicely as a -> RecentChanges. --[[JoshTriplett]] ->>Why not fork the process? We wouldn't have to wait around for a response since we would assume the recent changes page was being generated correctly. - * It would be nice to be able to have a button to show "Differences" (or "Show Diff") when editing a page. Is that an option that can be enabled? Using a plugin? @@ -58,4 +44,4 @@ Suggestions of ideas for plugins: * As I couldn't find another place to ask, I'll try here. I would like to install some contributed plugins, but can not find anywhere to downlod them. - > Not sure what you mean, the [[plugins/contrib]] page lists contributed plugins, and each of their pages tells where to download the plugin from.. --[[Joey]]
\ No newline at end of file + > Not sure what you mean, the [[plugins/contrib]] page lists contributed plugins, and each of their pages tells where to download the plugin from.. --[[Joey]] diff --git a/doc/todo/recentchanges.mdwn b/doc/todo/recentchanges.mdwn index d46c0d9a8..91128a860 100644 --- a/doc/todo/recentchanges.mdwn +++ b/doc/todo/recentchanges.mdwn @@ -86,3 +86,59 @@ your pages. --Ethan > backend. > > -- CharlesMauch + +---- + +Here's a full design for redoing recentchanges, based on Ethan's ideas: + +* Add a recentchanges plugin that has a preprocessor directive: + \[[recentchanges num=100 pages=* template=recentchanges.tmpl]] + If put on the [[recentchanges]] page, this would result in up to 100 + recentchanges/change_$id.mdwn files being created. +* Which means the plugin has to store state and use a checkconfig hook + or the like to create the requested pages (and delete old ones) when + the wiki is rebuilt and when the post_commit hook is run. +* Then it's a simple matter of using inline on the recentchanges page + to display the changes. (With a special template to display nicely.) +* Rss/atom comes for free.. +* So drop mail notifications. +* If someone wants to subscribe to notifications for only a subset + of pages, they can either filter the recentchanges in their rss + aggregator, or they can set up their own page that uses the recentchanges + directive for only the pages they want. +* The `rcs_notify` functions will be removed. +* To add diffs, another plugin can add a pagetemplate hook that calls + a `rcs_diff`. (optional) +* So to update the changes files, just call `rcs_recentchanges`, create + files for each new id, and delete files for each id that is no longer + included. +* The cgi support for recentchanges can be dropped, or moved to a different + plugin. + +I'm unsure how fast this will all be, but by using regular pages, there's +cacheing, at least. The main slowdown might turn out to be the inlining and +not the generation of the changes pages. The current cgi recentchanges +code saves a tenth of a second or so by memoizing htmllink, an optimisation +that won't be available when using the more general inlining code. + +An obvious optimisation, and one implied by this design, is that each change +file is only written once. This assumes that the data in them doesn't ever +change, which actually isn't true (svn commit messages can be changed), but +is probably close enough to true for our purposes. + +Another optimisation would be to htmlize the change files when they're +written out -- avoids re-rendering a given file each time a new change is +made (thus doing 1/100th the work). + +Links in the change files to the changed pages will need special handling. +These links should not generate backlinks. They probably shouldn't be +implemented as wikiliks at all. Instead, they should be raw, absolute +html links to the pages that were changed. + +Only problem with this approach is that the links break if the changed +page later gets deleted. I think that's acceptable. It could link to +`ikiwiki.cgi?do=redir&page=foo`, but that's probably overkill. + +--[[Joey]] + +[[done]] !! (in this branch at least :-) diff --git a/doc/todo/unaccent_url_instead_of_encoding.mdwn b/doc/todo/unaccent_url_instead_of_encoding.mdwn new file mode 100644 index 000000000..fbba893c5 --- /dev/null +++ b/doc/todo/unaccent_url_instead_of_encoding.mdwn @@ -0,0 +1,9 @@ +If one puts localized chars in wikilinks ikiwiki will escape it. +This works right from a technical point of view, but the URLs will become ugly. + +So I made a patch which unaccent chars: <http://users.itk.ppke.hu/~cstamas/code/ikiwiki/unaccentpagetitlenames/> +This is a one liner change, but requires a bit of reordering in the code. + +[[cstamas]] + +[[tag wishlist patch]] diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 136e969c2..cd8f0542c 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -33,8 +33,7 @@ These options control the mode that ikiwiki operates in. * --cgi Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and - supports editing pages, signing in, registration, and displaying - [[RecentChanges]]. + supports editing pages, signing in, and registration. To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup to generate a wrapper. The wrapper will generally need to run suid 6755 to @@ -133,11 +132,6 @@ configuration options of their own. access controlled by a group, it makes sense for the ikiwiki wrappers to run setgid to that group. -* --notify, --no-notify - - Enable email notification of commits. This should be used when running - ikiwiki as a [[post-commit]] hook. - * --rcs=svn|git|.., --no-rcs Enable or disable use of a [[revision_control_system|rcs]]. @@ -146,16 +140,10 @@ configuration options of their own. whatever the revision control system you select uses. In [[CGI]] mode, with a revision control system enabled, pages edited via - the web will be committed. Also, the [[RecentChanges]] link will be placed - on pages. + the web will be committed. No revision control is enabled by default. -* --svnrepo /svn/wiki - - Specify the location of the svn repository for the wiki. This is required - for using --notify with [[Subversion|rcs/svn]]. - * --svnpath trunk Specify the path inside your svn repository where the wiki is located. @@ -165,13 +153,25 @@ configuration options of their own. * --rss, --norss - If rss is set, ikiwiki will generate RSS feeds for pages that inline - a [[ikiwiki/blog]]. + If rss is set, ikiwiki will default to generating RSS feeds for pages + that inline a [[ikiwiki/blog]]. + +* --allowrss + + If allowrss is set, and rss is not set, ikiwiki will not default to + generating RSS feeds, but setting `rss=yes` in the blog can override + this default and generate a feed. * --atom, --noatom - If atom is set, ikiwiki will generate Atom feeds for pages that inline - a [[ikiwiki/blog]]. + If atom is set, ikiwiki will default to generating Atom feeds for pages + that inline a [[ikiwiki/blog]]. + +* --allowatom + + If allowatom is set, and rss is not set, ikiwiki will not default to + generating Atom feeds, but setting `atom=yes` in the blog can override + this default and generate a feed. * --pingurl URL diff --git a/doc/users/Edward_Betts.mdwn b/doc/users/Edward_Betts.mdwn new file mode 100644 index 000000000..8653c33c2 --- /dev/null +++ b/doc/users/Edward_Betts.mdwn @@ -0,0 +1,4 @@ +My watchlist: + +[[inline pages="todo/allow_wiki_syntax_in_commit_messages" archive="yes" sort="mtime" atom="yes"]] + diff --git a/doc/users/perolofsson.mdwn b/doc/users/perolofsson.mdwn new file mode 100644 index 000000000..e03cadbb5 --- /dev/null +++ b/doc/users/perolofsson.mdwn @@ -0,0 +1,7 @@ +[[meta title="Per Olofsson"]] + +Per Olofsson + +* <pelle@dsv.su.se> +* <pelle@debian.org> +* <http://people.dsv.su.se/~pelle/>. diff --git a/doc/wikitemplates.mdwn b/doc/wikitemplates.mdwn index 4588b948e..389bdbfe9 100644 --- a/doc/wikitemplates.mdwn +++ b/doc/wikitemplates.mdwn @@ -10,14 +10,11 @@ located in /usr/share/ikiwiki/templates by default. * `page.tmpl` - Used for displaying all regular wiki pages. * `misc.tmpl` - Generic template used for any page that doesn't have a custom template. -* `recentchanges.tmpl` - Used for the RecentChanges page. * `editpage.tmpl` - Create/edit page. -* `notifymail.tmpl` - Not a html template, this is used to - generate change notification mails for users who have subscribed to - changes to a page. +* `change.tmpl` - Used to create a page describing a change made to the wiki. * `passwordmail.tmpl` - Not a html template, this is used to generate the mail with the user's password in it. -* `rsspage.tmpl` - Used for generating rss feeds for [blogs|[ikiwiki/blog]]. +* `rsspage.tmpl` - Used for generating rss feeds for [[blogs|ikiwiki/blog]]. * `rssitem.tmpl` - Used for generating individual items on rss feeds. * `atompage.tmpl` - Used for generating atom feeds for blogs. * `atomitem.tmpl` - Used for generating individual items on atom feeds. |