X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/e0bfd0cafda6a44a826cdfe07b99299cc96dfdf3..0cd67c515fad03797fa7792c10b507a0abb77c28:/IkiWiki/Plugin/trail.pm
diff --git a/IkiWiki/Plugin/trail.pm b/IkiWiki/Plugin/trail.pm
index 87d99dd3d..330d2a31d 100644
--- a/IkiWiki/Plugin/trail.pm
+++ b/IkiWiki/Plugin/trail.pm
@@ -1,6 +1,6 @@
#!/usr/bin/perl
# Copyright © 2008-2011 Joey Hess
-# Copyright © 2009-2011 Simon McVittie
+# Copyright © 2009-2012 Simon McVittie
# Licensed under the GNU GPL, version 2, or any later version published by the
# Free Software Foundation
package IkiWiki::Plugin::trail;
@@ -12,54 +12,45 @@ use IkiWiki 3.00;
sub import {
hook(type => "getsetup", id => "trail", call => \&getsetup);
hook(type => "needsbuild", id => "trail", call => \&needsbuild);
- hook(type => "preprocess", id => "trail", call => \&preprocess_trail, scan => 1);
- hook(type => "preprocess", id => "trailinline", call => \&preprocess_trailinline, scan => 1);
+ hook(type => "preprocess", id => "trailoptions", call => \&preprocess_trailoptions, scan => 1);
hook(type => "preprocess", id => "trailitem", call => \&preprocess_trailitem, scan => 1);
+ hook(type => "preprocess", id => "trailitems", call => \&preprocess_trailitems, scan => 1);
hook(type => "preprocess", id => "traillink", call => \&preprocess_traillink, scan => 1);
hook(type => "pagetemplate", id => "trail", call => \&pagetemplate);
+ hook(type => "build_affected", id => "trail", call => \&build_affected);
}
-=head1 Page state
-
-If a page C<$T> is a trail, then it can have
-
-=over
-
-=item * C<$pagestate{$T}{trail}{contents}>
-
-Reference to an array of pagespecs or links in the trail.
-
-=item * C<$pagestate{$T}{trail}{sort}>
-
-A [[ikiwiki/pagespec/sorting]] order; if absent or undef, the trail is in
-the order given by the links that form it
-
-=item * C<$pagestate{$T}{trail}{circular}>
-
-True if this trail is circular (i.e. going "next" from the last item is
-allowed, and takes you back to the first)
-
-=item * C<$pagestate{$T}{trail}{reverse}>
-
-True if C is to be reversed.
-
-=back
-
-If a page C<$M> is a member of a trail C<$T>, then it has
-
-=over
-
-=item * C<$pagestate{$M}{trail}{item}{$T}[0]>
-
-The page before this one in C<$T> at the last rebuild, or undef.
-
-=item * C<$pagestate{$M}{trail}{item}{$T}[1]>
-
-The page after this one in C<$T> at the last refresh, or undef.
-
-=back
-
-=cut
+# Page state
+#
+# If a page $T is a trail, then it can have
+#
+# * $pagestate{$T}{trail}{contents}
+# Reference to an array of lists each containing either:
+# - [link, "link"]
+# A link specification, pointing to the same page that [[link]]
+# would select
+# - [pagespec, "posts/*", "age", 0]
+# A match by pagespec; the third array element is the sort order
+# and the fourth is whether to reverse sorting
+#
+# * $pagestate{$T}{trail}{sort}
+# A sorting order; if absent or undef, the trail is in the order given
+# by the links that form it
+#
+# * $pagestate{$T}{trail}{circular}
+# True if this trail is circular (i.e. going "next" from the last item is
+# allowed, and takes you back to the first)
+#
+# * $pagestate{$T}{trail}{reverse}
+# True if C is to be reversed.
+#
+# If a page $M is a member of a trail $T, then it has
+#
+# * $pagestate{$M}{trail}{item}{$T}[0]
+# The page before this one in C<$T> at the last rebuild, or undef.
+#
+# * $pagestate{$M}{trail}{item}{$T}[1]
+# The page after this one in C<$T> at the last refresh, or undef.
sub getsetup () {
return
@@ -90,44 +81,9 @@ sub needsbuild (@) {
my $scanned = 0;
-=for wiki
-
-The `trail` directive is supplied by the [[plugins/contrib/trail]]
-plugin. It sets options for the trail represented by this page. Example usage:
-
- \[[!trail sort="meta(date)" circular="no" pages="blog/posts/*"]]
-
-The available options are:
-
-* `sort`: sets a [[ikiwiki/pagespec/sorting]] order; if not specified, the
- items of the trail are ordered according to the first link to each item
- found on the trail page
-
-* `circular`: if set to `yes` or `1`, the trail is made into a loop by
- making the last page's "next" link point to the first page, and the first
- page's "previous" link point to the last page
-
-* `pages`: add the given pages to the trail
-
-=cut
-
-sub preprocess_trail (@) {
+sub preprocess_trailoptions (@) {
my %params = @_;
- # avoid collecting everything in the preprocess stage if we already
- # did in the scan stage
- if (defined wantarray) {
- return "" if $scanned;
- }
- else {
- $scanned = 1;
- }
-
- # trail members from a pagespec ought to be in some sort of order,
- # and path is a nice obvious default
- $params{sortthese} = 'path' unless exists $params{sortthese};
- $params{reversethese} = 'no' unless exists $params{reversethese};
-
if (exists $params{circular}) {
$pagestate{$params{page}}{trail}{circular} =
IkiWiki::yesno($params{circular});
@@ -141,100 +97,9 @@ sub preprocess_trail (@) {
$pagestate{$params{page}}{trail}{reverse} = $params{reverse};
}
- if (exists $params{pages}) {
- push @{$pagestate{$params{page}}{trail}{contents}},
- ["pagespec" => $params{pages}, $params{sortthese},
- IkiWiki::yesno($params{reversethese})];
- }
-
- if (exists $params{pagenames}) {
- my @list = map { [link => $_] } split ' ', $params{pagenames};
- push @{$pagestate{$params{page}}{trail}{contents}}, @list;
- }
-
return "";
}
-=for wiki
-
-The `trailinline` directive is supplied by the [[plugins/contrib/trail]]
-plugin. It behaves like the [[trail]] and [[inline]] directives combined.
-Like [[inline]], it includes the selected pages into the page with the
-directive and/or an RSS or Atom feed; like [[trail]], it turns the
-included pages into a "trail" in which each page has a link to the
-previous and next pages.
-
- \[[!inline sort="meta(date)" circular="no" pages="blog/posts/*"]]
-
-All the options for the [[inline]] and [[trail]] directives are valid.
-
-The `show`, `skip` and `feedshow` options from [[inline]] do not apply
-to the trail.
-
-* `sort`: sets a [[ikiwiki/pagespec/sorting]] order; if not specified, the
- items of the trail are ordered according to the first link to each item
- found on the trail page
-
-* `circular`: if set to `yes` or `1`, the trail is made into a loop by
- making the last page's "next" link point to the first page, and the first
- page's "previous" link point to the last page
-
-* `pages`: add the given pages to the trail
-
-=cut
-
-sub preprocess_trailinline (@) {
- my %params = @_;
-
- if (exists $params{sort}) {
- $params{sortthese} = $params{sort};
- delete $params{sort};
- }
- else {
- # sort in the same order as [[plugins/inline]]'s default
- $params{sortthese} = 'age';
- }
-
- if (exists $params{reverse}) {
- $params{reversethese} = $params{reverse};
- delete $params{reverse};
- }
-
- if (exists $params{trailsort}) {
- $params{sort} = $params{trailsort};
- }
-
- if (exists $params{trailreverse}) {
- $params{reverse} = $params{trailreverse};
- }
-
- if (defined wantarray) {
- scalar preprocess_trail(%params);
-
- if (IkiWiki->can("preprocess_inline")) {
- return IkiWiki::preprocess_inline(@_);
- }
- else {
- error("trailinline directive requires the inline plugin");
- }
- }
- else {
- preprocess_trail(%params);
- }
-}
-
-=for wiki
-
-The `trailitem` directive is supplied by the [[plugins/contrib/trail]] plugin.
-It is used like this:
-
- \[[!trailitem some_other_page]]
-
-to add `some_other_page` to the trail represented by this page, without
-generating a visible hyperlink.
-
-=cut
-
sub preprocess_trailitem (@) {
my $link = shift;
shift;
@@ -259,23 +124,36 @@ sub preprocess_trailitem (@) {
return "";
}
-=for wiki
-
-The `traillink` directive is supplied by the [[plugins/contrib/trail]] plugin.
-It generates a visible [[ikiwiki/WikiLink]], and also adds the linked page to
-the trail represented by the page containing the directive.
+sub preprocess_trailitems (@) {
+ my %params = @_;
-In its simplest form, the first parameter is like the content of a WikiLink:
+ # avoid collecting everything in the preprocess stage if we already
+ # did in the scan stage
+ if (defined wantarray) {
+ return "" if $scanned;
+ }
+ else {
+ $scanned = 1;
+ }
- \[[!traillink some_other_page]]
+ # trail members from a pagespec ought to be in some sort of order,
+ # and path is a nice obvious default
+ $params{sort} = 'path' unless exists $params{sort};
+ $params{reverse} = 'no' unless exists $params{reverse};
-The displayed text can also be overridden, either with a `|` symbol or with
-a `text` parameter:
+ if (exists $params{pages}) {
+ push @{$pagestate{$params{page}}{trail}{contents}},
+ ["pagespec" => $params{pages}, $params{sort},
+ IkiWiki::yesno($params{reverse})];
+ }
- \[[!traillink Click_here_to_start_the_trail|some_other_page]]
- \[[!traillink some_other_page text="Click here to start the trail"]]
+ if (exists $params{pagenames}) {
+ my @list = map { [link => $_] } split ' ', $params{pagenames};
+ push @{$pagestate{$params{page}}{trail}{contents}}, @list;
+ }
-=cut
+ return "";
+}
sub preprocess_traillink (@) {
my $link = shift;
@@ -375,14 +253,9 @@ sub trails_differ {
my $done_prerender = 0;
-my %origsubs;
-
sub prerender {
return if $done_prerender;
- $origsubs{render_backlinks} = \&IkiWiki::render_backlinks;
- inject(name => "IkiWiki::render_backlinks", call => \&render_backlinks);
-
%trail_to_members = ();
%member_to_trails = ();
@@ -468,18 +341,14 @@ sub prerender {
$done_prerender = 1;
}
-# This is called at about the right time that we can hijack it to render
-# extra pages.
-sub render_backlinks ($) {
- my $blc = shift;
+sub build_affected {
+ my %affected;
foreach my $member (keys %rebuild_trail_members) {
- next unless exists $pagesources{$member};
-
- IkiWiki::render($pagesources{$member}, sprintf(gettext("building %s, its previous or next page has changed"), $member));
+ $affected{$member} = sprintf(gettext("building %s, its previous or next page has changed"), $member);
}
- $origsubs{render_backlinks}($blc);
+ return %affected;
}
sub title_of ($) {