update info on my split-view setup, and ask for plugin advice

[git.ikiwiki.info.git] / IkiWiki / Plugin / trail.pm

diff --git a/IkiWiki/Plugin/trail.pm b/IkiWiki/Plugin/trail.pm
index 5ee152155187d718d314bb70776ff2ecb8503c6b..330d2a31d77aac49ed6227d5a0bf24c6b752689c 100644 (file)
--- a/IkiWiki/Plugin/trail.pm
+++ b/IkiWiki/Plugin/trail.pm
@@ -1,6 +1,6 @@
 #!/usr/bin/perl
 # Copyright © 2008-2011 Joey Hess
 #!/usr/bin/perl
 # Copyright © 2008-2011 Joey Hess

-# Copyright © 2009-2011 Simon McVittie <http://smcv.pseudorandom.co.uk/>
+# Copyright © 2009-2012 Simon McVittie <http://smcv.pseudorandom.co.uk/>

 # Licensed under the GNU GPL, version 2, or any later version published by the
 # Free Software Foundation
 package IkiWiki::Plugin::trail;
 # Licensed under the GNU GPL, version 2, or any later version published by the
 # Free Software Foundation
 package IkiWiki::Plugin::trail;


@@ -13,67 +13,44 @@ sub import {
        hook(type => "getsetup", id => "trail", call => \&getsetup);
        hook(type => "needsbuild", id => "trail", call => \&needsbuild);
        hook(type => "preprocess", id => "trailoptions", call => \&preprocess_trailoptions, scan => 1);
        hook(type => "getsetup", id => "trail", call => \&getsetup);
        hook(type => "needsbuild", id => "trail", call => \&needsbuild);
        hook(type => "preprocess", id => "trailoptions", call => \&preprocess_trailoptions, scan => 1);

-       hook(type => "preprocess", id => "trailinline", call => \&preprocess_trailinline, 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 => "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 lists each containing either:
-
-=over
-
-=item * C<[link, "link"]>
-
-A link specification, pointing to the same page that C<[[link]]> would select
-
-=item * C<[pagespec, "posts/*", "age", 0]>
-
-A match by pagespec; the third array element is the sort order and the fourth
-is whether to reverse sorting
-
-=back
-
-=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<sort> 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<sort> 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
 
 sub getsetup () {
        return


@@ -123,29 +100,6 @@ sub preprocess_trailoptions (@) {
        return "";
 }
 
        return "";
 }
 

-sub preprocess_trailinline (@) {
-       my %params = @_;
-
-       if (! exists $params{sort}) {
-               # sort in the same order as [[plugins/inline]]'s default
-               $params{sort} = 'age';
-       }
-
-       if (defined wantarray) {
-               scalar preprocess_trailitems(%params);
-
-               if (IkiWiki->can("preprocess_inline")) {
-                       return IkiWiki::preprocess_inline(@_);
-               }
-               else {
-                       error("trailinline directive requires the inline plugin");
-               }
-       }
-       else {
-               preprocess_trailitems(%params);
-       }
-}
-

 sub preprocess_trailitem (@) {
        my $link = shift;
        shift;
 sub preprocess_trailitem (@) {
        my $link = shift;
        shift;


@@ -299,14 +253,9 @@ sub trails_differ {
 
 my $done_prerender = 0;
 
 
 my $done_prerender = 0;
 

-my %origsubs;
-

 sub prerender {
        return if $done_prerender;
 
 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 = ();
 
        %trail_to_members = ();
        %member_to_trails = ();
 


@@ -392,18 +341,14 @@ sub prerender {
        $done_prerender = 1;
 }
 
        $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) {
 
        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 ($) {
 }
 
 sub title_of ($) {