diff options
36 files changed, 309 insertions, 163 deletions
diff --git a/IkiWiki.pm b/IkiWiki.pm index 2face7082..7ead13cf6 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -4,6 +4,7 @@ package IkiWiki; use warnings; use strict; use Encode; +use HTML::Entities; use open qw{:utf8 :std}; # Optimisation. @@ -290,7 +291,7 @@ sub styleurl (;$) { #{{{ return $page."style.css"; } #}}} -sub abs2rel ($$) { +sub abs2rel ($$) { #{{{ # Work around very innefficient behavior in File::Spec if abs2rel # is passed two relative paths. It's much faster if paths are # absolute! @@ -301,7 +302,7 @@ sub abs2rel ($$) { my $ret=File::Spec->abs2rel($path, $base); $ret=~s/^// if defined $ret; return $ret; -} +} #}}} sub htmllink ($$$;$$$) { #{{{ my $lpage=shift; # the page doing the linking @@ -380,7 +381,7 @@ sub loadindex () { #{{{ $items{link}=[]; foreach my $i (split(/ /, $_)) { my ($item, $val)=split(/=/, $i, 2); - push @{$items{$item}}, $val; + push @{$items{$item}}, decode_entities($val); } next unless exists $items{src}; # skip bad lines for now @@ -391,8 +392,7 @@ sub loadindex () { #{{{ $oldpagemtime{$page}=$items{mtime}[0]; $oldlinks{$page}=[@{$items{link}}]; $links{$page}=[@{$items{link}}]; - $depends{$page}=join(" ", @{$items{depends}}) - if exists $items{depends}; + $depends{$page}=$items{depends}[0] if exists $items{depends}; $renderedfiles{$page}=$items{dest}[0]; } $pagectime{$page}=$items{ctime}[0]; @@ -416,7 +416,7 @@ sub saveindex () { #{{{ "dest=$renderedfiles{$page}"; $line.=" link=$_" foreach @{$links{$page}}; if (exists $depends{$page}) { - $line.=" depends=$_" foreach split " ", $depends{$page}; + $line.=" depends=".encode_entities($depends{$page}, " \t\n"); } print OUT $line."\n"; } @@ -454,49 +454,6 @@ sub misctemplate ($$) { #{{{ return $template->output; }#}}} -sub glob_match ($$) { #{{{ - my $page=shift; - my $glob=shift; - - if ($glob =~ /^link\((.+)\)$/) { - my $rev = $links{$page} or return undef; - foreach my $p (@$rev) { - return 1 if lc $p eq $1; - } - return 0; - } elsif ($glob =~ /^backlink\((.+)\)$/) { - my $rev = $links{$1} or return undef; - foreach my $p (@$rev) { - return 1 if lc $p eq $page; - } - return 0; - } else { - # turn glob into safe regexp - $glob=quotemeta($glob); - $glob=~s/\\\*/.*/g; - $glob=~s/\\\?/./g; - $glob=~s!\\/!/!g; - - return $page=~/^$glob$/i; - } -} #}}} - -sub globlist_match ($$) { #{{{ - my $page=shift; - my @globlist=split(" ", shift); - - # check any negated globs first - foreach my $glob (@globlist) { - return 0 if $glob=~/^!(.*)/ && glob_match($page, $1); - } - - foreach my $glob (@globlist) { - return 1 if glob_match($page, $glob); - } - - return 0; -} #}}} - sub hook (@) { # {{{ my %param=@_; @@ -520,4 +477,136 @@ sub run_hooks ($$) { # {{{ } } #}}} +sub globlist_to_pagespec ($) { #{{{ + my @globlist=split(' ', shift); + + my (@spec, @skip); + foreach my $glob (@globlist) { + if ($glob=~/^!(.*)/) { + push @skip, $glob; + } + else { + push @spec, $glob; + } + } + + my $spec=join(" or ", @spec); + if (@skip) { + my $skip=join(" and ", @skip); + if (length $spec) { + $spec="$skip and ($spec)"; + } + else { + $spec=$skip; + } + } + return $spec; +} #}}} + +sub is_globlist ($) { #{{{ + my $s=shift; + $s=~/[^\s]+\s+([^\s]+)/ && $1 ne "and" && $1 ne "or"; +} #}}} + +sub safequote ($) { #{{{ + my $s=shift; + $s=~s/[{}]//g; + return "q{$s}"; +} #}}} + +sub pagespec_merge ($$) { #{{{ + my $a=shift; + my $b=shift; + + # Support for old-style GlobLists. + if (is_globlist($a)) { + $a=globlist_to_pagespec($a); + } + if (is_globlist($b)) { + $b=globlist_to_pagespec($b); + } + + return "($a) or ($b)"; +} #}}} + +sub pagespec_match ($$) { #{{{ + my $page=shift; + my $spec=shift; + + # Support for old-style GlobLists. + if (is_globlist($spec)) { + $spec=globlist_to_pagespec($spec); + } + + # Convert spec to perl code. + my $code=""; + while ($spec=~m/\s*(\!|\(|\)|\w+\([^\)]+\)|[^\s()]+)\s*/ig) { + my $word=$1; + if (lc $word eq "and") { + $code.=" &&"; + } + elsif (lc $word eq "or") { + $code.=" ||"; + } + elsif ($word eq "(" || $word eq ")" || $word eq "!") { + $code.=" ".$word; + } + elsif ($word =~ /^(link|backlink|creation_month|creation_year|creation_day)\((.+)\)$/) { + $code.=" match_$1(\$page, ".safequote($2).")"; + } + else { + $code.=" match_glob(\$page, ".safequote($word).")"; + } + } + + return eval $code; +} #}}} + +sub match_glob ($$) { #{{{ + my $page=shift; + my $glob=shift; + + # turn glob into safe regexp + $glob=quotemeta($glob); + $glob=~s/\\\*/.*/g; + $glob=~s/\\\?/./g; + + return $page=~/^$glob$/; +} #}}} + +sub match_link ($$) { #{{{ + my $page=shift; + my $link=shift; + + my $links = $links{$page} or return undef; + foreach my $p (@$links) { + return 1 if lc $p eq $link; + } + return 0; +} #}}} + +sub match_backlink ($$) { #{{{ + my $page=shift; + my $linkto=shift; + + my $links = $links{$linkto} or return undef; + foreach my $p (@$links) { + return 1 if lc $p eq $page; + } + return 0; +} #}}} + +sub match_creation_day ($$) { #{{{ + return if (localtime($pagectime{shift()}))[3] == shift; +} #}}} + +sub match_creation_month ($$) { #{{{ + return if (localtime($pagectime{shift()}))[4] + 1 == shift; +} #}}} + +sub match_creation_year ($$) { #{{{ + return if (localtime($pagectime{shift()}))[5] + 1900 == shift; +} #}}} + + 1 diff --git a/IkiWiki/CGI.pm b/IkiWiki/CGI.pm index fc5dfc2ef..f69f02a15 100644 --- a/IkiWiki/CGI.pm +++ b/IkiWiki/CGI.pm @@ -31,7 +31,7 @@ sub page_locked ($$;$) { #{{{ foreach my $admin (@{$config{adminuser}}) { my $locked_pages=userinfo_get($admin, "locked_pages"); - if (globlist_match($page, userinfo_get($admin, "locked_pages"))) { + if (pagespec_match($page, userinfo_get($admin, "locked_pages"))) { return 1 if $nonfatal; error(htmllink("", "", $page, 1)." is locked by ". htmllink("", "", $admin, 1)." and cannot be edited."); @@ -278,9 +278,9 @@ sub cgi_prefs ($$) { #{{{ $form->field(name => "password", type => "password"); $form->field(name => "confirm_password", type => "password"); $form->field(name => "subscriptions", size => 50, - comment => "(".htmllink("", "", "GlobList", 1).")"); + comment => "(".htmllink("", "", "PageSpec", 1).")"); $form->field(name => "locked_pages", size => 50, - comment => "(".htmllink("", "", "GlobList", 1).")"); + comment => "(".htmllink("", "", "PageSpec", 1).")"); if (! is_admin($user_name)) { $form->field(name => "locked_pages", type => "hidden"); diff --git a/IkiWiki/Plugin/aggregate.pm b/IkiWiki/Plugin/aggregate.pm index 7142e6106..46f2d5128 100644 --- a/IkiWiki/Plugin/aggregate.pm +++ b/IkiWiki/Plugin/aggregate.pm @@ -108,8 +108,6 @@ sub delete (@) { #{{{ } #}}} sub loadstate () { #{{{ - eval q{use HTML::Entities}; - die $@ if $@; if (-e "$IkiWiki::config{wikistatedir}/aggregate") { open (IN, "$IkiWiki::config{wikistatedir}/aggregate" || die "$IkiWiki::config{wikistatedir}/aggregate: $!"); diff --git a/IkiWiki/Plugin/brokenlinks.pm b/IkiWiki/Plugin/brokenlinks.pm index 09ce181cf..7fae9a2f2 100644 --- a/IkiWiki/Plugin/brokenlinks.pm +++ b/IkiWiki/Plugin/brokenlinks.pm @@ -21,7 +21,7 @@ sub preprocess (@) { #{{{ my @broken; foreach my $page (keys %IkiWiki::links) { - if (IkiWiki::globlist_match($page, $params{pages})) { + if (IkiWiki::pagespec_match($page, $params{pages})) { foreach my $link (@{$IkiWiki::links{$page}}) { next if $link =~ /.*\/discussion/i && $IkiWiki::config{discussion}; my $bestlink=IkiWiki::bestlink($page, $link); diff --git a/IkiWiki/Plugin/inline.pm b/IkiWiki/Plugin/inline.pm index 6a0f00f0f..d8f2ca0d8 100644 --- a/IkiWiki/Plugin/inline.pm +++ b/IkiWiki/Plugin/inline.pm @@ -48,7 +48,7 @@ sub preprocess_inline (@) { #{{{ my @list; foreach my $page (keys %pagesources) { next if $page eq $params{page}; - if (globlist_match($page, $params{pages})) { + if (pagespec_match($page, $params{pages})) { push @list, $page; } } diff --git a/IkiWiki/Plugin/orphans.pm b/IkiWiki/Plugin/orphans.pm index ac4b77527..2219634ca 100644 --- a/IkiWiki/Plugin/orphans.pm +++ b/IkiWiki/Plugin/orphans.pm @@ -28,7 +28,7 @@ sub preprocess (@) { #{{{ my @orphans; foreach my $page (keys %IkiWiki::renderedfiles) { next if $linkedto{$page}; - next unless IkiWiki::globlist_match($page, $params{pages}); + next unless IkiWiki::pagespec_match($page, $params{pages}); # If the page has a link to some other page, it's # indirectly linked to a page via that page's backlinks. next if grep { diff --git a/IkiWiki/Plugin/pagecount.pm b/IkiWiki/Plugin/pagecount.pm index 8a1376e09..cfc962b6c 100644 --- a/IkiWiki/Plugin/pagecount.pm +++ b/IkiWiki/Plugin/pagecount.pm @@ -23,7 +23,7 @@ sub preprocess (@) { #{{{ return $#pages+1 if $params{pages} eq "*"; # optimisation my $count=0; foreach my $page (@pages) { - $count++ if IkiWiki::globlist_match($page, $params{pages}); + $count++ if IkiWiki::pagespec_match($page, $params{pages}); } return $count; } # }}} diff --git a/IkiWiki/Plugin/pagestats.pm b/IkiWiki/Plugin/pagestats.pm index a1b4c1d45..de559e2c5 100644 --- a/IkiWiki/Plugin/pagestats.pm +++ b/IkiWiki/Plugin/pagestats.pm @@ -34,7 +34,7 @@ sub preprocess (@) { #{{{ my %counts; my $max = 0; foreach my $page (keys %IkiWiki::links) { - if (IkiWiki::globlist_match($page, $params{pages})) { + if (IkiWiki::pagespec_match($page, $params{pages})) { my @bl = IkiWiki::backlinks($page); $counts{$page} = scalar(@bl); $max = $counts{$page} if $counts{$page} > $max; diff --git a/IkiWiki/Render.pm b/IkiWiki/Render.pm index 1449b8931..7cb55f128 100644 --- a/IkiWiki/Render.pm +++ b/IkiWiki/Render.pm @@ -129,37 +129,16 @@ sub preprocess ($$$;$) { #{{{ sub add_depends ($$) { #{{{ my $page=shift; - my $globlist=shift; + my $pagespec=shift; if (! exists $depends{$page}) { - $depends{$page}=$globlist; + $depends{$page}=$pagespec; } else { - $depends{$page}=globlist_merge($depends{$page}, $globlist); + $depends{$page}=pagespec_merge($depends{$page}, $pagespec); } } # }}} -sub globlist_merge ($$) { #{{{ - my $a=shift; - my $b=shift; - - my $ret=""; - # Only add negated globs if they are not matched by the other globlist. - foreach my $i ((map { [ $a, $_ ] } split(" ", $b)), - (map { [ $b, $_ ] } split(" ", $a))) { - if ($i->[1]=~/^!(.*)/) { - if (! globlist_match($1, $i->[0])) { - $ret.=" ".$i->[1]; - } - } - else { - $ret.=" ".$i->[1]; - } - } - - return $ret; -} #}}} - sub genpage ($$$) { #{{{ my $page=shift; my $content=shift; @@ -441,7 +420,7 @@ FILE: foreach my $file (@files) { foreach my $file (keys %rendered, @del) { next if $f eq $file; my $page=pagename($file); - if (globlist_match($page, $depends{$p})) { + if (pagespec_match($page, $depends{$p})) { debug("rendering $f, which depends on $page"); render($f); $rendered{$f}=1; diff --git a/IkiWiki/UserInfo.pm b/IkiWiki/UserInfo.pm index fabe495bb..a944cafa6 100644 --- a/IkiWiki/UserInfo.pm +++ b/IkiWiki/UserInfo.pm @@ -83,7 +83,7 @@ sub commit_notify_list ($@) { #{{{ length $userinfo->{$user}->{subscriptions} && exists $userinfo->{$user}->{email} && length $userinfo->{$user}->{email} && - grep { globlist_match($_, $userinfo->{$user}->{subscriptions}) } @pages) { + grep { pagespec_match($_, $userinfo->{$user}->{subscriptions}) } @pages) { push @ret, $userinfo->{$user}->{email}; } } diff --git a/basewiki/blog.mdwn b/basewiki/blog.mdwn index 1993f3720..4c8d7d406 100644 --- a/basewiki/blog.mdwn +++ b/basewiki/blog.mdwn @@ -1,9 +1,9 @@ You can turn any page on this wiki into a weblog by inserting a [[PreProcessorDirective]]. Like this: - \\[[inline pages="blog/* !*/Discussion" show="10" rootpage="blog"]] + \\[[inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]] -Any pages that match the specified [[GlobList]] (in the example, any +Any pages that match the specified [[PageSpec]] (in the example, any [[SubPage]] of "blog") will be part of the blog, and the newest 10 of them will appear in the page. @@ -18,20 +18,20 @@ globally configured to do so, but you can set `rss=no` to disable this. If you want your blog to have an archive page listing every post ever made to it, you can accomplish that like this: - \\[[inline pages="blog/* !*/Discussion" archive="yes"]] + \\[[inline pages="blog/* and !*/Discussion" archive="yes"]] You can even create an automatically generated list of all the pages on the wiki, with the most recently added at the top, like this: - \\[[inline pages="* !*/Discussion" archive="yes"]] + \\[[inline pages="* and !*/Discussion" archive="yes"]] If you want to be able to add pages to a given blog feed by tagging them, you can do that too. To tag a page, just make it link to a page or pages -that represent its tags. Then use the special link() [[GlobList]] to match +that represent its tags. Then use the special link() [[PageSpec]] to match all pages that have a given tag: \\[[inline pages="link(life)"]] Or include some tags and exclude others: - \\[[inline pages="link(debian) !link(social)"]] + \\[[inline pages="link(debian) and !link(social)"]] diff --git a/basewiki/globlist.mdwn b/basewiki/globlist.mdwn deleted file mode 100644 index 20a9eed1b..000000000 --- a/basewiki/globlist.mdwn +++ /dev/null @@ -1,20 +0,0 @@ -When the wiki stores lists of pages, such as pages that are locked or pages -whose commit emails you want subscribe to, it uses a GlobList. - -This is a list of page names, separated by white space. The "glob" bit is -that as well as full page names, it can contain glob patterns. "`*`" stands -in for any part of the page name, and "`?`" for any single letter of its -name. So if you wanted to list all the pages about tea, and any -[[SubPage]]s of the SandBox, but not including the SandBox itself: - - *tea* SandBox/* - -You can also prefix an item in the list with "`!`" to skip matching any -pages that match it. So if you want to specify all pages except for -Discussion pages and the SandBox: - - * !SandBox !*/Discussion - -It's also possible to match pages that link to a given page, by writing -"link(page)" in a globlist. Or, match pages that a given page links to, by -writing "backlink(page)". diff --git a/basewiki/pagespec.mdwn b/basewiki/pagespec.mdwn new file mode 100644 index 000000000..318be42f9 --- /dev/null +++ b/basewiki/pagespec.mdwn @@ -0,0 +1,61 @@ +To select a set of pages, such as pages that are locked, pages +whose commit emails you want subscribe to, or pages to combine into a +[[blog]], the wiki uses a PageSpec. This is an expression that matches +a set of pages. + +The simplest PageSpec is a simple list of pages. For example, this matches +any of the three listed pages: + + foo or bar or baz + +More often you will want to match any pages that have a particular thing in +their name. You can do this using a glob pattern. "`*`" stands for any part +of a page name, and "`?`" for any single letter of a page name. So this +matches all pages about music, and any [[SubPage]]s of the SandBox, but does +not match the SandBox itself: + + *music* or SandBox/* + +You can also prefix an item with "`!`" to skip pages that match it. So to +match all pages except for Discussion pages and the SandBox: + + * and !SandBox and !*/Discussion + +It's also possible to match pages that link to a given page, by writing +"`link(page)`". Or, match pages that a given page links to, by +writing "`backlink(page)`". Or match pages created in a given month, year, +or day of the month by writing "`creation_month(month)`", +"`creation_year(year)`" or "`creation_day(mday)`". + +For example, to match all pages in a blog that link to the page about music +and were written on Mondays in 2005: + + blog/* and link(music) and creation_year(2005) and creation_day(0) + +Matches can also be used to limit matching to pages created before or after +a given date. + +More complex expressions can also be created, by using parentheses for +grouping. For example, to match pages in a blog that are tagged with either +of two tags, use: + + blog/* and (link(tag/foo) or link(tag/bar)) + +## Old syntax + +The old PageSpec syntax was called a "GlobList", and worked differently in +two ways: + +1. "and" and "or" were not used; any page matching any item from the list + matched. +2. If an item was prefixed with "`!`", then no page matching that item + matched, even if it matched an earlier list item. + +For example, here is the old way to match all pages except for the SandBox +and Discussion pages: + + * !SandBox !*/Discussion + +Using this old syntax is still supported. However, the old syntax is +deprecated and will be removed at some point, and using the new syntax is +recommended. diff --git a/debian/NEWS b/debian/NEWS index 1c087d2dc..4393a4cbb 100644 --- a/debian/NEWS +++ b/debian/NEWS @@ -1,3 +1,19 @@ +ikiwiki (1.13) unstable; urgency=low + + The GlobList format which was used for specifiying sets of pages, has been + replaced with a new PageSpec format. While GlobLists will continue to work, + that format is deprecated, and you are recommended to use PageSpecs from now + on, and also to change any GlobLists in your wiki to PageSpecs. + + See the new PageSpec page for details. + + You will need to rebuild your wiki when upgrading 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 ikiiki-mass-rebuild to force a + rebuild. + + -- Joey Hess <joeyh@debian.org> Tue, 1 Aug 2006 18:29:51 -0400 + ikiwiki (1.11) unstable; urgency=low Some changes to tags in this release, due to a new tag plugin. If you have diff --git a/debian/changelog b/debian/changelog index 9e183576b..befe1dda4 100644 --- a/debian/changelog +++ b/debian/changelog @@ -24,6 +24,18 @@ ikiwiki (1.13) UNRELEASED; urgency=low index. (Aka Please Please Please, let that be the last one.) * Patch from Roland Mas to support an rss=no parameter to inline directives. Closes: #380743 + * Renamed GlobLists to PageSpecs. + * PageSpecs can now include nested parens, "and", and "or". This remains + backwards compatible to the old GlobList format. It's implemented by + treating the GlobList as a very limited microlanguage that is transformed + to perl code that does the matching. + * The old GlobList format is deprecated, and I encourage users to switch to + using the new PageSpec format. Compatability with the old format will be + removed at some point, possibly by 2.0. + * Wiki rebuild needed on upgrade to this version due to PageSpec change. + * Add support for creation_month and creation_year to PageSpec. + Closes: #380680 + * Changes to index file encoding. -- Joey Hess <joeyh@debian.org> Tue, 1 Aug 2006 16:00:58 -0400 diff --git a/debian/postinst b/debian/postinst index 4e2425fcb..b3031bd9b 100755 --- a/debian/postinst +++ b/debian/postinst @@ -4,7 +4,7 @@ set -e # Change this when some incompatible change is made that requires # rebuilding all wikis. -firstcompat=1.4 +firstcompat=1.13 if [ "$1" = configure ] && \ dpkg --compare-versions "$2" lt "$firstcompat"; then diff --git a/doc/bugs.mdwn b/doc/bugs.mdwn index c4895cb7b..2046fb820 100644 --- a/doc/bugs.mdwn +++ b/doc/bugs.mdwn @@ -1,9 +1,9 @@ This is ikiwiki's bug list. Link bugs to [[bugs/done]] when done. -[[inline pages="bugs/* !bugs/done !link(bugs/done) !*/Discussion" rootpage="bugs" show="30"]] +[[inline pages="bugs/* and !bugs/done and !link(bugs/done) and !*/Discussion" rootpage="bugs" show="30"]] ---- # Full list of open bugs: -[[inline pages="bugs/* !bugs/done !link(bugs/done) !*/Discussion" archive="yes" rss="no"]] +[[inline pages="bugs/* and !bugs/done and !link(bugs/done) and !*/Discussion" archive="yes" rss="no"]] diff --git a/doc/bugs/done.mdwn b/doc/bugs/done.mdwn index 58c4719b7..a92862bd4 100644 --- a/doc/bugs/done.mdwn +++ b/doc/bugs/done.mdwn @@ -1,3 +1,3 @@ recently fixed [[bugs]] -[[inline pages="link(bugs/done) !bugs !*/Discussion" show="10"]] +[[inline pages="link(bugs/done) and !bugs and !*/Discussion" show="10"]] diff --git a/doc/bugs/inline_page_not_updated_on_removal.mdwn b/doc/bugs/inline_page_not_updated_on_removal.mdwn index 35fe5e189..69dc6fb8d 100644 --- a/doc/bugs/inline_page_not_updated_on_removal.mdwn +++ b/doc/bugs/inline_page_not_updated_on_removal.mdwn @@ -2,16 +2,16 @@ If a page inlines some other page (such as this page by the bugs page), and the page is removed (such as by this page being linked to bugs/done), the inlining page is not updated to remove it. -This only happens if the page is removed from the inlined globlist due to +This only happens if the page is removed from the inlined pagespec due to a tag changing; the problem is that once the tag is changed, ikiwiki does not know that the page used to match before. To fix, seems I would need to record the actual list of pages that are currently included on an inline page, and do a comparison to see if any have changed. At first I thought, why not just add them to the dependencies -explicitly, but that fails because the dependencies globlist fails to match +explicitly, but that fails because the dependencies pagespec fails to match when a negated expression like "!tag(bugs/done)" is matched. So, quick fixes aside, what's the generic mechanism here that a plugin can use to let ikiwiki know that a page should be updated if some other page -stops matching its dependencies globlist? +stops matching its dependencies pagespec? diff --git a/doc/features.mdwn b/doc/features.mdwn index 0a235d708..27db7bc65 100644 --- a/doc/features.mdwn +++ b/doc/features.mdwn @@ -46,7 +46,7 @@ Some of ikiwiki's features: * [[blogging|blog]] You can turn any page in the wiki into a [[blog]]. Pages matching a - specified [[GlobList]] will be displayed as a weblog within the blog + specified [[PageSpec]] will be displayed as a weblog within the blog page. And an RSS feed can be generated to follow the blog. Ikiwiki's own [[TODO]], [[news]], and [[plugins]] pages are good examples diff --git a/doc/install.mdwn b/doc/install.mdwn index eb5b91e67..d2b6b8833 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -1,10 +1,10 @@ The easiest way to install ikiwiki is using the Debian package. -Ikiwiki requires [[MarkDown]] be installed, and also uses the following -perl modules if available: `CGI::Session` `CGI::FormBuilder` (version -3.02.02 or newer) `HTML::Template` `Mail::SendMail` `Time::Duration` -`Date::Parse` (libtimedate-perl), `HTML::Scrubber`, `RPC::XML`, -`XML::Simple`, `XML::Feed`, `HTML::Parser` +Ikiwiki requires [[MarkDown]] and the `HTML::Parser` perl module be +installed, and also uses the following perl modules if available: +`CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer) +`HTML::Template` `Mail::SendMail` `Time::Duration` `Date::Parse`, +`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed` If you want to install from the tarball, you should make sure that the required perl modules are installed, then run: diff --git a/doc/news.mdwn b/doc/news.mdwn index 816fc74d3..781666c2a 100644 --- a/doc/news.mdwn +++ b/doc/news.mdwn @@ -2,7 +2,7 @@ This is where annoucements of new releases, features, and other news is posted. [[IkiWikiUsers]] are recommended to subscribe to this page's RSS feed. -[[inline pages="news/* !*/Discussion" rootpage="news" show="30"]] +[[inline pages="news/* and !*/Discussion" rootpage="news" show="30"]] By the way, some other pages with RSS feeds about ikiwiki include [[plugins]], [[TODO]] and [[bugs]]. diff --git a/doc/patchqueue.mdwn b/doc/patchqueue.mdwn index 29631fe9d..91dc224a7 100644 --- a/doc/patchqueue.mdwn +++ b/doc/patchqueue.mdwn @@ -5,5 +5,4 @@ Feel free to either copy the patch inline, or link to one elsewhere (or nag Joey to open up anonymous svn access to this wiki so you can check in the patches directly). -[[inline pages="patchqueue/* !patchqueue/done !link(patchqueue/done) !*/Discussion" rootpage="patchqueue" show="30" archive="yes"]] - +[[inline pages="patchqueue/* and !patchqueue/done and !link(patchqueue/done) and !*/Discussion" rootpage="patchqueue" show="30" archive="yes"]] diff --git a/doc/plugins/brokenlinks.mdwn b/doc/plugins/brokenlinks.mdwn index 3c23c9d68..e3f6357b7 100644 --- a/doc/plugins/brokenlinks.mdwn +++ b/doc/plugins/brokenlinks.mdwn @@ -2,7 +2,7 @@ This plugin generates a list of broken links on pages in the wiki. This is a useful way to find pages that still need to be written, or links that are written wrong. -The optional parameter "pages" can be a [[GlobList]] specifying the pages +The optional parameter "pages" can be a [[PageSpec]] specifying the pages to search for broken links, default is search them all. This plugin is included in ikiwiki, but is not enabled by default. diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn index 0c2ea69da..2c4e52a3f 100644 --- a/doc/plugins/orphans.mdwn +++ b/doc/plugins/orphans.mdwn @@ -1,7 +1,7 @@ This plugin generates a list of possibly orphaned pages -- pages that no other page links to. -The optional parameter "pages" can be a [[GlobList]] specifying the pages +The optional parameter "pages" can be a [[PageSpec]] specifying the pages to check for orphans, default is search them all. Note that it takes [[BackLinks]] into account, but does not count inlining a diff --git a/doc/plugins/pagecount.mdwn b/doc/plugins/pagecount.mdwn index 0fddecf30..8fc04ff76 100644 --- a/doc/plugins/pagecount.mdwn +++ b/doc/plugins/pagecount.mdwn @@ -1,7 +1,7 @@ Provides a \\[[pagecount ]] [[PreProcessorDirective]] that is replaced with the total number of pages currently in the wiki. -The optional parameter "pages" can be a [[GlobList]] specifying the pages +The optional parameter "pages" can be a [[PageSpec]] specifying the pages to count, default is to count them all. This plugin is included in ikiwiki, but is not enabled by default. diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index ed5336ad5..94a6280ca 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -3,7 +3,7 @@ This plugin allows tagging pages. List tags as follows: \[[tag tech life linux]] The tags work the same as if you had put a (hidden) [[WikiLink]] on the page -for each tag, so you can use a [[GlobList]] to link to all pages that are +for each tag, so you can use a [[PageSpec]] to link to all pages that are tagged with a given tag, for example. The tags will also show up on blog entries and at the bottom of the tagged pages, as well as in rss feeds. diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 925717777..79bd75e9b 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -183,13 +183,13 @@ use the following hashes, using a page name as the key: * `%IkiWiki::renderedfiles` contains the name of the file rendered by a page * `%IkiWiki::pagesources` contains the name of the source file for a page. -* `%IkiWiki::depends` contains a [[GlobList]] that is used to specify other +* `%IkiWiki::depends` contains a [[PageSpec]] that is used to specify other pages that a page depends on. If one of its dependencies is updated, the page will also get rebuilt. Many plugins will need to add dependencies to this hash; the best way to do it is by using the IkiWiki::add_depends function, which takes as its - parameters the page name and a [[GlobList]] of dependencies to add. + parameters the page name and a [[PageSpec]] of dependencies to add. * `%IkiWiki::forcerebuild` any pages set as the keys to this hash will be treated as if they're modified and rebuilt. diff --git a/doc/roadmap.mdwn b/doc/roadmap.mdwn index 05ee48dff..672dfe3c4 100644 --- a/doc/roadmap.mdwn +++ b/doc/roadmap.mdwn @@ -13,7 +13,7 @@ Released 29 April 2006. # 2.0 * Unit test suite (with tests of at least core stuff like - [[GlobList]]). (status: exists, could of course use more tests) + [[PageSpec]]). (status: exists, could of course use more tests) * [[Plugins]] _(status: done, interface still not quite stable)_ * [[Tags]] _(status: partial)_ * Should have fully working [[todo/utf8]] support. _(status: fair)_ diff --git a/doc/todo.mdwn b/doc/todo.mdwn index b89d2cdf0..9a0a593be 100644 --- a/doc/todo.mdwn +++ b/doc/todo.mdwn @@ -1,9 +1,9 @@ Welcome to ikiwiki's todo list. Link items to [[todo/done]] when done. -[[inline pages="todo/* !todo/done !link(todo/done) !*/Discussion" rootpage="todo" show="30"]] +[[inline pages="todo/* and !todo/done and !link(todo/done) and !*/Discussion" rootpage="todo" show="30"]] ---- # Full list of open items: -[[inline pages="todo/* !todo/done !link(todo/done) !*/Discussion" archive="yes" rss="no"]] +[[inline pages="todo/* and !todo/done and !link(todo/done) and !*/Discussion" archive="yes" rss="no"]] diff --git a/doc/todo/done.mdwn b/doc/todo/done.mdwn index 847d0a2e5..8d01666c0 100644 --- a/doc/todo/done.mdwn +++ b/doc/todo/done.mdwn @@ -1,3 +1,3 @@ recently fixed [[TODO]] items -[[inline pages="link(todo/done) !todo !*/Discussion" show="10"]] +[[inline pages="link(todo/done) and !todo and !*/Discussion" show="10"]] diff --git a/doc/todo/improve_globlists.mdwn b/doc/todo/improve_globlists.mdwn index 80b545e4e..86a4ba154 100644 --- a/doc/todo/improve_globlists.mdwn +++ b/doc/todo/improve_globlists.mdwn @@ -1,6 +1,8 @@ -Need to improve [[globlist]]s, adding more powerful boolean expressions. +Need to improve globlists, adding more powerful boolean expressions. The current behavior is to check for negated expressions, and not match if there are any, then check for normal expressions and match if any match, This fails if you want to do something like match only pages with tag foo that are under directory bar. I think we need parens for grouping, and probably also boolean OR. + +[[todo/done]] diff --git a/doc/todo/multiple_templates.mdwn b/doc/todo/multiple_templates.mdwn index 459a5fa4f..258d584dd 100644 --- a/doc/todo/multiple_templates.mdwn +++ b/doc/todo/multiple_templates.mdwn @@ -2,7 +2,7 @@ > file for some pages; 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 globlists to +Well, that would probably be fairly easy to add if it used pagespecs to specify which pages use the non-default template. Hmm, I think the pagetemplate hook should allow one to get close enough to diff --git a/t/globlist_match.t b/t/globlist_match.t deleted file mode 100755 index b60d83a2a..000000000 --- a/t/globlist_match.t +++ /dev/null @@ -1,18 +0,0 @@ -#!/usr/bin/perl -use warnings; -use strict; -use Test::More tests => 13; - -BEGIN { use_ok("IkiWiki"); } -ok(IkiWiki::globlist_match("foo", "foo bar"), "simple list"); -ok(IkiWiki::globlist_match("bar", "foo bar"), "simple list 2"); -ok(IkiWiki::globlist_match("foo", "*")); -ok(IkiWiki::globlist_match("foo", "f?? !foz")); -ok(! IkiWiki::globlist_match("foo", "f?? !foo")); -ok(! IkiWiki::globlist_match("foo", "* !foo")); -ok(! IkiWiki::globlist_match("foo", "foo !foo")); -ok(IkiWiki::globlist_match("page", "?ag?")); -ok(! IkiWiki::globlist_match("page", "?a?g?")); -ok(! IkiWiki::globlist_match("foo.png", "* !*.*")); -ok(IkiWiki::globlist_match("foo.png", "*.*")); -ok(! IkiWiki::globlist_match("foo", "*.*")); diff --git a/t/pagespec_match.t b/t/pagespec_match.t new file mode 100755 index 000000000..35d420f10 --- /dev/null +++ b/t/pagespec_match.t @@ -0,0 +1,28 @@ +#!/usr/bin/perl +use warnings; +use strict; +use Test::More tests => 20; + +BEGIN { use_ok("IkiWiki"); } + +ok(IkiWiki::pagespec_match("foo", "*")); +ok(IkiWiki::pagespec_match("page", "?ag?")); +ok(! IkiWiki::pagespec_match("page", "?a?g?")); +ok(IkiWiki::pagespec_match("foo.png", "*.*")); +ok(! IkiWiki::pagespec_match("foo", "*.*")); +ok(IkiWiki::pagespec_match("foo", "foo or bar"), "simple list"); +ok(IkiWiki::pagespec_match("bar", "foo or bar"), "simple list 2"); +ok(IkiWiki::pagespec_match("foo", "f?? and !foz")); +ok(! IkiWiki::pagespec_match("foo", "f?? and !foo")); +ok(! IkiWiki::pagespec_match("foo", "* and !foo")); +ok(! IkiWiki::pagespec_match("foo", "foo and !foo")); +ok(! IkiWiki::pagespec_match("foo.png", "* and !*.*")); + +# old style globlists +ok(IkiWiki::pagespec_match("foo", "foo bar"), "simple list"); +ok(IkiWiki::pagespec_match("bar", "foo bar"), "simple list 2"); +ok(IkiWiki::pagespec_match("foo", "f?? !foz")); +ok(! IkiWiki::pagespec_match("foo", "f?? !foo")); +ok(! IkiWiki::pagespec_match("foo", "* !foo")); +ok(! IkiWiki::pagespec_match("foo", "foo !foo")); +ok(! IkiWiki::pagespec_match("foo.png", "* !*.*")); diff --git a/t/globlist_merge.t b/t/pagespec_merge.t index db76f1cd4..c2860709b 100755 --- a/t/globlist_merge.t +++ b/t/pagespec_merge.t @@ -8,14 +8,14 @@ sub same { my $b=shift; my $match=shift; - my $imatch=(IkiWiki::globlist_match($match, $a) || - IkiWiki::globlist_match($match, $b)); - my $cmatch=IkiWiki::globlist_match($match, IkiWiki::globlist_merge($a, $b)); + my $imatch=(IkiWiki::pagespec_match($match, $a) || + IkiWiki::pagespec_match($match, $b)); + my $cmatch=IkiWiki::pagespec_match($match, IkiWiki::pagespec_merge($a, $b)); return $imatch == $cmatch; } -BEGIN { use_ok("IkiWiki::Render"); } +BEGIN { use_ok("IkiWiki"); } ok(same("foo", "bar", "foo"), "basic match 1"); ok(same("foo", "bar", "bar"), "basic match 2"); @@ -36,8 +36,8 @@ ok(same("f?? !f??", "!bar", "bar"), "matching glob and matching inverted glob"); ok(same("b??", "!b?z", "bar"), "matching glob and non-matching inverted glob"); ok(same("f?? !f?z", "!bar", "bar"), "matching glob and non-matching inverted glob"); ok(same("!foo bar baz", "!bar", "bar"), "matching list and matching inversion"); -ok(IkiWiki::globlist_match("foo/Discussion", - IkiWiki::globlist_merge("* !*/Discussion", "*/Discussion")), "should match"); +ok(IkiWiki::pagespec_match("foo/Discussion", + IkiWiki::pagespec_merge("* !*/Discussion", "*/Discussion")), "should match"); ok(same("* !*/Discussion", "*/Discussion", "foo/Discussion"), "Discussion merge 1"); ok(same("*/Discussion", "* !*/Discussion", "foo/Discussion"), "Discussion merge 2"); ok(same("*/Discussion !*/bar", "*/bar !*/Discussion", "foo/Discussion"), "bidirectional merge 1"); |