clone plugin sidebar as branding, farbar, footer, and topbar [2/2]

4 files changed, 128 insertions, 124 deletions

diff --git a/IkiWiki/Plugin/branding.pm b/IkiWiki/Plugin/branding.pm
index c1146b7..e1dd79e 100644
--- a/IkiWiki/Plugin/branding.pm
+++ b/IkiWiki/Plugin/branding.pm
@@ -1,17 +1,18 @@
 #!/usr/bin/perl
-# Sidebar plugin.
-# by Tuomo Valkonen <tuomov at iki dot fi>
+# Branding plugin.
+# by Jonas Smedegaard <dr@jones.dk>
+# Heavily based on Sidebar by Tuomo Valkonen <tuomov at iki dot fi>
 
-package IkiWiki::Plugin::sidebar;
+package IkiWiki::Plugin::branding;
 
 use warnings;
 use strict;
 use IkiWiki 3.00;
 
 sub import {
-	hook(type => "getsetup", id => "sidebar", call => \&getsetup);
-	hook(type => "preprocess", id => "sidebar", call => \&preprocess);
-	hook(type => "pagetemplate", id => "sidebar", call => \&pagetemplate);
+	hook(type => "getsetup", id => "branding", call => \&getsetup);
+	hook(type => "preprocess", id => "branding", call => \&preprocess);
+	hook(type => "pagetemplate", id => "branding", call => \&pagetemplate);
 }
 
 sub getsetup () {
@@ -20,16 +21,16 @@ sub getsetup () {
 			safe => 1,
 			rebuild => 1,
 		},
-		global_sidebars => {
+		global_brandings => {
 			type => "boolean",
 			example => 1,
-			description => "show sidebar page on all pages?",
+			description => "show branding page on all pages?",
 			safe => 1,
 			rebuild => 1,
 		},
 }
 
-my %pagesidebar;
+my %pagebranding;
 
 sub preprocess (@) {
 	my %params=@_;
@@ -38,13 +39,13 @@ sub preprocess (@) {
 	return "" unless $page eq $params{destpage};
 	
 	if (! defined $params{content}) {
-		$pagesidebar{$page}=undef;
+		$pagebranding{$page}=undef;
 	}
 	else {
 		my $file = $pagesources{$page};
 		my $type = pagetype($file);
 
-		$pagesidebar{$page}=
+		$pagebranding{$page}=
 			IkiWiki::htmlize($page, $page, $type,
 			IkiWiki::linkify($page, $page,
 			IkiWiki::preprocess($page, $page, $params{content})));
@@ -56,39 +57,39 @@ sub preprocess (@) {
 my $oldfile;
 my $oldcontent;
 
-sub sidebar_content ($) {
+sub branding_content ($) {
 	my $page=shift;
 	
-	return delete $pagesidebar{$page} if defined $pagesidebar{$page};
+	return delete $pagebranding{$page} if defined $pagebranding{$page};
 
-	return if ! exists $pagesidebar{$page} && 
-		defined $config{global_sidebars} && ! $config{global_sidebars};
+	return if ! exists $pagebranding{$page} && 
+		defined $config{global_brandings} && ! $config{global_brandings};
 
-	my $sidebar_page=bestlink($page, "sidebar") || return;
-	my $sidebar_file=$pagesources{$sidebar_page} || return;
-	my $sidebar_type=pagetype($sidebar_file);
+	my $branding_page=bestlink($page, "branding") || return;
+	my $branding_file=$pagesources{$branding_page} || return;
+	my $branding_type=pagetype($branding_file);
 	
-	if (defined $sidebar_type) {
+	if (defined $branding_type) {
 		# FIXME: This isn't quite right; it won't take into account
-		# adding a new sidebar page. So adding such a page
+		# adding a new branding page. So adding such a page
 		# currently requires a wiki rebuild.
-		add_depends($page, $sidebar_page);
+		add_depends($page, $branding_page);
 
 		my $content;
-		if (defined $oldfile && $sidebar_file eq $oldfile) {
+		if (defined $oldfile && $branding_file eq $oldfile) {
 			$content=$oldcontent;
 		}
 		else {
-			$content=readfile(srcfile($sidebar_file));
+			$content=readfile(srcfile($branding_file));
 			$oldcontent=$content;
-			$oldfile=$sidebar_file;
+			$oldfile=$branding_file;
 		}
 
 		return unless length $content;
-		return IkiWiki::htmlize($sidebar_page, $page, $sidebar_type,
-		       IkiWiki::linkify($sidebar_page, $page,
-		       IkiWiki::preprocess($sidebar_page, $page,
-		       IkiWiki::filter($sidebar_page, $page, $content))));
+		return IkiWiki::htmlize($branding_page, $page, $branding_type,
+		       IkiWiki::linkify($branding_page, $page,
+		       IkiWiki::preprocess($branding_page, $page,
+		       IkiWiki::filter($branding_page, $page, $content))));
 	}
 
 }
@@ -98,10 +99,10 @@ sub pagetemplate (@) {
 
 	my $template=$params{template};
 	if ($params{destpage} eq $params{page} &&
-	    $template->query(name => "sidebar")) {
-		my $content=sidebar_content($params{destpage});
+	    $template->query(name => "branding")) {
+		my $content=branding_content($params{destpage});
 		if (defined $content && length $content) {
-		        $template->param(sidebar => $content);
+		        $template->param(branding => $content);
 		}
 	}
 }
diff --git a/IkiWiki/Plugin/farbar.pm b/IkiWiki/Plugin/farbar.pm
index c1146b7..67b28ed 100644
--- a/IkiWiki/Plugin/farbar.pm
+++ b/IkiWiki/Plugin/farbar.pm
@@ -1,17 +1,18 @@
 #!/usr/bin/perl
-# Sidebar plugin.
-# by Tuomo Valkonen <tuomov at iki dot fi>
+# Farbar plugin.
+# by Jonas Smedegaard <dr@jones.dk>
+# Heavily based on Sidebar by Tuomo Valkonen <tuomov at iki dot fi>
 
-package IkiWiki::Plugin::sidebar;
+package IkiWiki::Plugin::farbar;
 
 use warnings;
 use strict;
 use IkiWiki 3.00;
 
 sub import {
-	hook(type => "getsetup", id => "sidebar", call => \&getsetup);
-	hook(type => "preprocess", id => "sidebar", call => \&preprocess);
-	hook(type => "pagetemplate", id => "sidebar", call => \&pagetemplate);
+	hook(type => "getsetup", id => "farbar", call => \&getsetup);
+	hook(type => "preprocess", id => "farbar", call => \&preprocess);
+	hook(type => "pagetemplate", id => "farbar", call => \&pagetemplate);
 }
 
 sub getsetup () {
@@ -20,16 +21,16 @@ sub getsetup () {
 			safe => 1,
 			rebuild => 1,
 		},
-		global_sidebars => {
+		global_farbars => {
 			type => "boolean",
 			example => 1,
-			description => "show sidebar page on all pages?",
+			description => "show farbar page on all pages?",
 			safe => 1,
 			rebuild => 1,
 		},
 }
 
-my %pagesidebar;
+my %pagefarbar;
 
 sub preprocess (@) {
 	my %params=@_;
@@ -38,13 +39,13 @@ sub preprocess (@) {
 	return "" unless $page eq $params{destpage};
 	
 	if (! defined $params{content}) {
-		$pagesidebar{$page}=undef;
+		$pagefarbar{$page}=undef;
 	}
 	else {
 		my $file = $pagesources{$page};
 		my $type = pagetype($file);
 
-		$pagesidebar{$page}=
+		$pagefarbar{$page}=
 			IkiWiki::htmlize($page, $page, $type,
 			IkiWiki::linkify($page, $page,
 			IkiWiki::preprocess($page, $page, $params{content})));
@@ -56,39 +57,39 @@ sub preprocess (@) {
 my $oldfile;
 my $oldcontent;
 
-sub sidebar_content ($) {
+sub farbar_content ($) {
 	my $page=shift;
 	
-	return delete $pagesidebar{$page} if defined $pagesidebar{$page};
+	return delete $pagefarbar{$page} if defined $pagefarbar{$page};
 
-	return if ! exists $pagesidebar{$page} && 
-		defined $config{global_sidebars} && ! $config{global_sidebars};
+	return if ! exists $pagefarbar{$page} && 
+		defined $config{global_farbars} && ! $config{global_farbars};
 
-	my $sidebar_page=bestlink($page, "sidebar") || return;
-	my $sidebar_file=$pagesources{$sidebar_page} || return;
-	my $sidebar_type=pagetype($sidebar_file);
+	my $farbar_page=bestlink($page, "farbar") || return;
+	my $farbar_file=$pagesources{$farbar_page} || return;
+	my $farbar_type=pagetype($farbar_file);
 	
-	if (defined $sidebar_type) {
+	if (defined $farbar_type) {
 		# FIXME: This isn't quite right; it won't take into account
-		# adding a new sidebar page. So adding such a page
+		# adding a new farbar page. So adding such a page
 		# currently requires a wiki rebuild.
-		add_depends($page, $sidebar_page);
+		add_depends($page, $farbar_page);
 
 		my $content;
-		if (defined $oldfile && $sidebar_file eq $oldfile) {
+		if (defined $oldfile && $farbar_file eq $oldfile) {
 			$content=$oldcontent;
 		}
 		else {
-			$content=readfile(srcfile($sidebar_file));
+			$content=readfile(srcfile($farbar_file));
 			$oldcontent=$content;
-			$oldfile=$sidebar_file;
+			$oldfile=$farbar_file;
 		}
 
 		return unless length $content;
-		return IkiWiki::htmlize($sidebar_page, $page, $sidebar_type,
-		       IkiWiki::linkify($sidebar_page, $page,
-		       IkiWiki::preprocess($sidebar_page, $page,
-		       IkiWiki::filter($sidebar_page, $page, $content))));
+		return IkiWiki::htmlize($farbar_page, $page, $farbar_type,
+		       IkiWiki::linkify($farbar_page, $page,
+		       IkiWiki::preprocess($farbar_page, $page,
+		       IkiWiki::filter($farbar_page, $page, $content))));
 	}
 
 }
@@ -98,10 +99,10 @@ sub pagetemplate (@) {
 
 	my $template=$params{template};
 	if ($params{destpage} eq $params{page} &&
-	    $template->query(name => "sidebar")) {
-		my $content=sidebar_content($params{destpage});
+	    $template->query(name => "farbar")) {
+		my $content=farbar_content($params{destpage});
 		if (defined $content && length $content) {
-		        $template->param(sidebar => $content);
+		        $template->param(farbar => $content);
 		}
 	}
 }
diff --git a/IkiWiki/Plugin/footer.pm b/IkiWiki/Plugin/footer.pm
index c1146b7..af3f158 100644
--- a/IkiWiki/Plugin/footer.pm
+++ b/IkiWiki/Plugin/footer.pm
@@ -1,17 +1,18 @@
 #!/usr/bin/perl
-# Sidebar plugin.
-# by Tuomo Valkonen <tuomov at iki dot fi>
+# Footer plugin.
+# by Jonas Smedegaard <dr@jones.dk>
+# Heavily based on Sidebar by Tuomo Valkonen <tuomov at iki dot fi>
 
-package IkiWiki::Plugin::sidebar;
+package IkiWiki::Plugin::footer;
 
 use warnings;
 use strict;
 use IkiWiki 3.00;
 
 sub import {
-	hook(type => "getsetup", id => "sidebar", call => \&getsetup);
-	hook(type => "preprocess", id => "sidebar", call => \&preprocess);
-	hook(type => "pagetemplate", id => "sidebar", call => \&pagetemplate);
+	hook(type => "getsetup", id => "footer", call => \&getsetup);
+	hook(type => "preprocess", id => "footer", call => \&preprocess);
+	hook(type => "pagetemplate", id => "footer", call => \&pagetemplate);
 }
 
 sub getsetup () {
@@ -20,16 +21,16 @@ sub getsetup () {
 			safe => 1,
 			rebuild => 1,
 		},
-		global_sidebars => {
+		global_footers => {
 			type => "boolean",
 			example => 1,
-			description => "show sidebar page on all pages?",
+			description => "show footer page on all pages?",
 			safe => 1,
 			rebuild => 1,
 		},
 }
 
-my %pagesidebar;
+my %pagefooter;
 
 sub preprocess (@) {
 	my %params=@_;
@@ -38,13 +39,13 @@ sub preprocess (@) {
 	return "" unless $page eq $params{destpage};
 	
 	if (! defined $params{content}) {
-		$pagesidebar{$page}=undef;
+		$pagefooter{$page}=undef;
 	}
 	else {
 		my $file = $pagesources{$page};
 		my $type = pagetype($file);
 
-		$pagesidebar{$page}=
+		$pagefooter{$page}=
 			IkiWiki::htmlize($page, $page, $type,
 			IkiWiki::linkify($page, $page,
 			IkiWiki::preprocess($page, $page, $params{content})));
@@ -56,39 +57,39 @@ sub preprocess (@) {
 my $oldfile;
 my $oldcontent;
 
-sub sidebar_content ($) {
+sub footer_content ($) {
 	my $page=shift;
 	
-	return delete $pagesidebar{$page} if defined $pagesidebar{$page};
+	return delete $pagefooter{$page} if defined $pagefooter{$page};
 
-	return if ! exists $pagesidebar{$page} && 
-		defined $config{global_sidebars} && ! $config{global_sidebars};
+	return if ! exists $pagefooter{$page} && 
+		defined $config{global_footers} && ! $config{global_footers};
 
-	my $sidebar_page=bestlink($page, "sidebar") || return;
-	my $sidebar_file=$pagesources{$sidebar_page} || return;
-	my $sidebar_type=pagetype($sidebar_file);
+	my $footer_page=bestlink($page, "footer") || return;
+	my $footer_file=$pagesources{$footer_page} || return;
+	my $footer_type=pagetype($footer_file);
 	
-	if (defined $sidebar_type) {
+	if (defined $footer_type) {
 		# FIXME: This isn't quite right; it won't take into account
-		# adding a new sidebar page. So adding such a page
+		# adding a new footer page. So adding such a page
 		# currently requires a wiki rebuild.
-		add_depends($page, $sidebar_page);
+		add_depends($page, $footer_page);
 
 		my $content;
-		if (defined $oldfile && $sidebar_file eq $oldfile) {
+		if (defined $oldfile && $footer_file eq $oldfile) {
 			$content=$oldcontent;
 		}
 		else {
-			$content=readfile(srcfile($sidebar_file));
+			$content=readfile(srcfile($footer_file));
 			$oldcontent=$content;
-			$oldfile=$sidebar_file;
+			$oldfile=$footer_file;
 		}
 
 		return unless length $content;
-		return IkiWiki::htmlize($sidebar_page, $page, $sidebar_type,
-		       IkiWiki::linkify($sidebar_page, $page,
-		       IkiWiki::preprocess($sidebar_page, $page,
-		       IkiWiki::filter($sidebar_page, $page, $content))));
+		return IkiWiki::htmlize($footer_page, $page, $footer_type,
+		       IkiWiki::linkify($footer_page, $page,
+		       IkiWiki::preprocess($footer_page, $page,
+		       IkiWiki::filter($footer_page, $page, $content))));
 	}
 
 }
@@ -98,10 +99,10 @@ sub pagetemplate (@) {
 
 	my $template=$params{template};
 	if ($params{destpage} eq $params{page} &&
-	    $template->query(name => "sidebar")) {
-		my $content=sidebar_content($params{destpage});
+	    $template->query(name => "footer")) {
+		my $content=footer_content($params{destpage});
 		if (defined $content && length $content) {
-		        $template->param(sidebar => $content);
+		        $template->param(footer => $content);
 		}
 	}
 }
diff --git a/IkiWiki/Plugin/topbar.pm b/IkiWiki/Plugin/topbar.pm
index c1146b7..0cc8e28 100644
--- a/IkiWiki/Plugin/topbar.pm
+++ b/IkiWiki/Plugin/topbar.pm
@@ -1,17 +1,18 @@
 #!/usr/bin/perl
-# Sidebar plugin.
-# by Tuomo Valkonen <tuomov at iki dot fi>
+# Topbar plugin.
+# by Jonas Smedegaard <dr@jones.dk>
+# Heavily based on Sidebar by Tuomo Valkonen <tuomov at iki dot fi>
 
-package IkiWiki::Plugin::sidebar;
+package IkiWiki::Plugin::topbar;
 
 use warnings;
 use strict;
 use IkiWiki 3.00;
 
 sub import {
-	hook(type => "getsetup", id => "sidebar", call => \&getsetup);
-	hook(type => "preprocess", id => "sidebar", call => \&preprocess);
-	hook(type => "pagetemplate", id => "sidebar", call => \&pagetemplate);
+	hook(type => "getsetup", id => "topbar", call => \&getsetup);
+	hook(type => "preprocess", id => "topbar", call => \&preprocess);
+	hook(type => "pagetemplate", id => "topbar", call => \&pagetemplate);
 }
 
 sub getsetup () {
@@ -20,16 +21,16 @@ sub getsetup () {
 			safe => 1,
 			rebuild => 1,
 		},
-		global_sidebars => {
+		global_topbars => {
 			type => "boolean",
 			example => 1,
-			description => "show sidebar page on all pages?",
+			description => "show topbar page on all pages?",
 			safe => 1,
 			rebuild => 1,
 		},
 }
 
-my %pagesidebar;
+my %pagetopbar;
 
 sub preprocess (@) {
 	my %params=@_;
@@ -38,13 +39,13 @@ sub preprocess (@) {
 	return "" unless $page eq $params{destpage};
 	
 	if (! defined $params{content}) {
-		$pagesidebar{$page}=undef;
+		$pagetopbar{$page}=undef;
 	}
 	else {
 		my $file = $pagesources{$page};
 		my $type = pagetype($file);
 
-		$pagesidebar{$page}=
+		$pagetopbar{$page}=
 			IkiWiki::htmlize($page, $page, $type,
 			IkiWiki::linkify($page, $page,
 			IkiWiki::preprocess($page, $page, $params{content})));
@@ -56,39 +57,39 @@ sub preprocess (@) {
 my $oldfile;
 my $oldcontent;
 
-sub sidebar_content ($) {
+sub topbar_content ($) {
 	my $page=shift;
 	
-	return delete $pagesidebar{$page} if defined $pagesidebar{$page};
+	return delete $pagetopbar{$page} if defined $pagetopbar{$page};
 
-	return if ! exists $pagesidebar{$page} && 
-		defined $config{global_sidebars} && ! $config{global_sidebars};
+	return if ! exists $pagetopbar{$page} && 
+		defined $config{global_topbars} && ! $config{global_topbars};
 
-	my $sidebar_page=bestlink($page, "sidebar") || return;
-	my $sidebar_file=$pagesources{$sidebar_page} || return;
-	my $sidebar_type=pagetype($sidebar_file);
+	my $topbar_page=bestlink($page, "topbar") || return;
+	my $topbar_file=$pagesources{$topbar_page} || return;
+	my $topbar_type=pagetype($topbar_file);
 	
-	if (defined $sidebar_type) {
+	if (defined $topbar_type) {
 		# FIXME: This isn't quite right; it won't take into account
-		# adding a new sidebar page. So adding such a page
+		# adding a new topbar page. So adding such a page
 		# currently requires a wiki rebuild.
-		add_depends($page, $sidebar_page);
+		add_depends($page, $topbar_page);
 
 		my $content;
-		if (defined $oldfile && $sidebar_file eq $oldfile) {
+		if (defined $oldfile && $topbar_file eq $oldfile) {
 			$content=$oldcontent;
 		}
 		else {
-			$content=readfile(srcfile($sidebar_file));
+			$content=readfile(srcfile($topbar_file));
 			$oldcontent=$content;
-			$oldfile=$sidebar_file;
+			$oldfile=$topbar_file;
 		}
 
 		return unless length $content;
-		return IkiWiki::htmlize($sidebar_page, $page, $sidebar_type,
-		       IkiWiki::linkify($sidebar_page, $page,
-		       IkiWiki::preprocess($sidebar_page, $page,
-		       IkiWiki::filter($sidebar_page, $page, $content))));
+		return IkiWiki::htmlize($topbar_page, $page, $topbar_type,
+		       IkiWiki::linkify($topbar_page, $page,
+		       IkiWiki::preprocess($topbar_page, $page,
+		       IkiWiki::filter($topbar_page, $page, $content))));
 	}
 
 }
@@ -98,10 +99,10 @@ sub pagetemplate (@) {
 
 	my $template=$params{template};
 	if ($params{destpage} eq $params{page} &&
-	    $template->query(name => "sidebar")) {
-		my $content=sidebar_content($params{destpage});
+	    $template->query(name => "topbar")) {
+		my $content=topbar_content($params{destpage});
 		if (defined $content && length $content) {
-		        $template->param(sidebar => $content);
+		        $template->param(topbar => $content);
 		}
 	}
 }