From 486f460132434db1eaff92dcadb265011f394bf1 Mon Sep 17 00:00:00 2001 From: intrigeri Date: Tue, 15 Jul 2008 16:09:40 +0200 Subject: pedigree rename to parentlinks: renamed files, to start with Signed-off-by: intrigeri --- IkiWiki/Plugin/parentlinks.pm | 55 +++++++++++++++ IkiWiki/Plugin/pedigree.pm | 55 --------------- doc/plugins/parentlinks.mdwn | 113 +++++++++++++++++++++++++++++++ doc/plugins/pedigree.mdwn | 113 ------------------------------- t/parentlinks.t | 83 +++++++++++++++++++++++ t/parentlinks/templates/parentlinks.tmpl | 4 ++ t/pedigree.t | 83 ----------------------- t/pedigree/templates/pedigree.tmpl | 4 -- 8 files changed, 255 insertions(+), 255 deletions(-) create mode 100644 IkiWiki/Plugin/parentlinks.pm delete mode 100644 IkiWiki/Plugin/pedigree.pm create mode 100644 doc/plugins/parentlinks.mdwn delete mode 100644 doc/plugins/pedigree.mdwn create mode 100755 t/parentlinks.t create mode 100644 t/parentlinks/templates/parentlinks.tmpl delete mode 100755 t/pedigree.t delete mode 100644 t/pedigree/templates/pedigree.tmpl diff --git a/IkiWiki/Plugin/parentlinks.pm b/IkiWiki/Plugin/parentlinks.pm new file mode 100644 index 000000000..eb8bfa83b --- /dev/null +++ b/IkiWiki/Plugin/parentlinks.pm @@ -0,0 +1,55 @@ +#!/usr/bin/perl +# -*- cperl-indent-level: 8; -*- +# Ikiwiki pedigree plugin. +package IkiWiki::Plugin::pedigree; + +use warnings; +use strict; +use IkiWiki 2.00; + +sub import { #{{{ + hook(type => "pagetemplate", id => "pedigree", call => \&pagetemplate); +} # }}} + +sub pedigree ($) { #{{{ + my $page=shift; + + my @ret; + my $path=""; + my $title=$config{wikiname}; + my $i=0; + my $depth=0; + my $height=0; + + my @pagepath=(split("/", $page)); + my $pagedepth=@pagepath; + foreach my $dir (@pagepath) { + next if $dir eq 'index'; + $depth=$i; + $height=($pagedepth - $depth); + push @ret, { + url => urlto($path, $page), + page => $title, + depth => $depth, + height => $height, + "depth_$depth" => 1, + "height_$height" => 1, + }; + $path.="/".$dir; + $title=IkiWiki::pagetitle($dir); + $i++; + } + return @ret; +} #}}} + +sub pagetemplate (@) { #{{{ + my %params=@_; + my $page=$params{page}; + my $template=$params{template}; + + if ($template->query(name => "pedigree")) { + $template->param(pedigree => [pedigree($page)]); + } +} # }}} + +1 diff --git a/IkiWiki/Plugin/pedigree.pm b/IkiWiki/Plugin/pedigree.pm deleted file mode 100644 index eb8bfa83b..000000000 --- a/IkiWiki/Plugin/pedigree.pm +++ /dev/null @@ -1,55 +0,0 @@ -#!/usr/bin/perl -# -*- cperl-indent-level: 8; -*- -# Ikiwiki pedigree plugin. -package IkiWiki::Plugin::pedigree; - -use warnings; -use strict; -use IkiWiki 2.00; - -sub import { #{{{ - hook(type => "pagetemplate", id => "pedigree", call => \&pagetemplate); -} # }}} - -sub pedigree ($) { #{{{ - my $page=shift; - - my @ret; - my $path=""; - my $title=$config{wikiname}; - my $i=0; - my $depth=0; - my $height=0; - - my @pagepath=(split("/", $page)); - my $pagedepth=@pagepath; - foreach my $dir (@pagepath) { - next if $dir eq 'index'; - $depth=$i; - $height=($pagedepth - $depth); - push @ret, { - url => urlto($path, $page), - page => $title, - depth => $depth, - height => $height, - "depth_$depth" => 1, - "height_$height" => 1, - }; - $path.="/".$dir; - $title=IkiWiki::pagetitle($dir); - $i++; - } - return @ret; -} #}}} - -sub pagetemplate (@) { #{{{ - my %params=@_; - my $page=$params{page}; - my $template=$params{template}; - - if ($template->query(name => "pedigree")) { - $template->param(pedigree => [pedigree($page)]); - } -} # }}} - -1 diff --git a/doc/plugins/parentlinks.mdwn b/doc/plugins/parentlinks.mdwn new file mode 100644 index 000000000..15c032838 --- /dev/null +++ b/doc/plugins/parentlinks.mdwn @@ -0,0 +1,113 @@ +[[!template id=plugin name=pedigree author="intrigeri"]] +[[!tag type/useful]] + +This plugin offers a `HTML::Template` loop that iterates over all or +a subset of a page's parents, providing a few bonus possibilities, +such as styling the parent links depending on their place in the path. +One can think of pedigree as "`PARENTLINKS` on steroids". + +[[!toc ]] + +Content +======= + +This plugin provides one template loop, called `PEDIGREE`, that +returns the same parents list as `PARENTLINKS` would; as a bonus, +every path element returned by the `PEDIGREE` loop has the following +variables set: + +* `URL` (string): url to the current path element +* `PAGE` (string): title of the current path element +* `DEPTH` (positive integer): depth of the path leading to the + current path element, counting from the wiki's root, which has + `DEPTH=0` +* `HEIGHT` (positive integer): distance, expressed in path elements, + from the current page to the current path element; e.g. this is + 1 for the current page's mother, 2 for its grand-mother, etc. +* `DEPTH_n` (boolean): true if, and only if, `DEPTH==n` +* `HEIGHT_n` (boolean): true if, and only if, `HEIGHT==n` + +Usage +===== + +The `DEPTH_n` and `HEIGHT_n` variables allow the template writer to +skip arbitrary elements in the parents list: they are arbitrary +page-range selectors. + +The `DEPTH` and `HEIGHT` variables allow the template writer to apply +general treatment, depending on one of these variables, to *every* +parent: they are counters. + +Styling parents depending on their depth +---------------------------------------- + +Say you want the parent links to be styled depending on their depth in +the path going from the wiki root to the current page; just add the +following lines in `page.tmpl`: + + + " class="depth"> + + / + + +Then write the appropriate CSS bits for `a.depth1`, etc. + +Skip some parents, style the others depending on their distance to the current page +----------------------------------------------------------------------------------- + +Say you want to display all the parents links but the wiki homepage, +styled depending on their distance to the current page; just add the +following lines in `page.tmpl`: + + + + + " class="height"> + + / + + +Then write the appropriate CSS bits for `a.height1`, etc. + +Full-blown example +------------------ + +Let's have a look at a more complicated example; combining the boolean +loop variables provided by this plugin (`IS_ROOT` and friends) and +`HTML::Template` flow control structures, you can have custom HTML +and/or CSS generated for some special path components; e.g.: + + +
+
    + + + + + +
  • ">
    • +     +     +     +
+
+ + + + +
+ "> +
+ + +
+ "> +
+ + + + + + + diff --git a/doc/plugins/pedigree.mdwn b/doc/plugins/pedigree.mdwn deleted file mode 100644 index 15c032838..000000000 --- a/doc/plugins/pedigree.mdwn +++ /dev/null @@ -1,113 +0,0 @@ -[[!template id=plugin name=pedigree author="intrigeri"]] -[[!tag type/useful]] - -This plugin offers a `HTML::Template` loop that iterates over all or -a subset of a page's parents, providing a few bonus possibilities, -such as styling the parent links depending on their place in the path. -One can think of pedigree as "`PARENTLINKS` on steroids". - -[[!toc ]] - -Content -======= - -This plugin provides one template loop, called `PEDIGREE`, that -returns the same parents list as `PARENTLINKS` would; as a bonus, -every path element returned by the `PEDIGREE` loop has the following -variables set: - -* `URL` (string): url to the current path element -* `PAGE` (string): title of the current path element -* `DEPTH` (positive integer): depth of the path leading to the - current path element, counting from the wiki's root, which has - `DEPTH=0` -* `HEIGHT` (positive integer): distance, expressed in path elements, - from the current page to the current path element; e.g. this is - 1 for the current page's mother, 2 for its grand-mother, etc. -* `DEPTH_n` (boolean): true if, and only if, `DEPTH==n` -* `HEIGHT_n` (boolean): true if, and only if, `HEIGHT==n` - -Usage -===== - -The `DEPTH_n` and `HEIGHT_n` variables allow the template writer to -skip arbitrary elements in the parents list: they are arbitrary -page-range selectors. - -The `DEPTH` and `HEIGHT` variables allow the template writer to apply -general treatment, depending on one of these variables, to *every* -parent: they are counters. - -Styling parents depending on their depth ----------------------------------------- - -Say you want the parent links to be styled depending on their depth in -the path going from the wiki root to the current page; just add the -following lines in `page.tmpl`: - - - " class="depth"> - - / - - -Then write the appropriate CSS bits for `a.depth1`, etc. - -Skip some parents, style the others depending on their distance to the current page ------------------------------------------------------------------------------------ - -Say you want to display all the parents links but the wiki homepage, -styled depending on their distance to the current page; just add the -following lines in `page.tmpl`: - - - - - " class="height"> - - / - - -Then write the appropriate CSS bits for `a.height1`, etc. - -Full-blown example ------------------- - -Let's have a look at a more complicated example; combining the boolean -loop variables provided by this plugin (`IS_ROOT` and friends) and -`HTML::Template` flow control structures, you can have custom HTML -and/or CSS generated for some special path components; e.g.: - - -
-
    - - - - - -
  • ">
    • -     -     -     -
-
- - - - -
- "> -
- - -
- "> -
- - - - - - - diff --git a/t/parentlinks.t b/t/parentlinks.t new file mode 100755 index 000000000..74871cfa8 --- /dev/null +++ b/t/parentlinks.t @@ -0,0 +1,83 @@ +#!/usr/bin/perl +# -*- cperl-indent-level: 8; -*- +# Testcases for the Ikiwiki pedigree plugin. + +use warnings; +use strict; +use Test::More 'no_plan'; + +my %expected; + +BEGIN { use_ok("IkiWiki"); } + +# Init +%config=IkiWiki::defaultconfig(); +$config{srcdir}=$config{destdir}="/dev/null"; +$config{underlaydir}="underlays/basewiki"; +$config{templatedir}="t/pedigree/templates"; +IkiWiki::loadplugins(); +IkiWiki::checkconfig(); +ok(IkiWiki::loadplugin("pedigree"), "pedigree plugin loaded"); + +# Test data +$expected{'pedigree'} = + { + "" => [], + "ikiwiki" => [], + "ikiwiki/pagespec" => + [ {depth => 0, height => 2, }, + {depth => 1, height => 1, }, + ], + "ikiwiki/pagespec/attachment" => + [ {depth => 0, height => 3, depth_0 => 1, height_3 => 1}, + {depth => 1, height => 2, }, + {depth => 2, height => 1, }, + ], + }; + +# Test function +sub test_loop($$) { + my $loop=shift; + my $expected=shift; + my $template; + my %params; + + ok($template=template('pedigree.tmpl'), "template created"); + ok($params{template}=$template, "params populated"); + + while ((my $page, my $exp) = each %{$expected}) { + my @path=(split("/", $page)); + my $pagedepth=@path; + my $msgprefix="$page $loop"; + + # manually run the plugin hook + $params{page}=$page; + $template->clear_params(); + IkiWiki::Plugin::pedigree::pagetemplate(%params); + my $res=$template->param($loop); + + is(scalar(@$res), $pagedepth, "$msgprefix: path length"); + # logic & arithmetic validation tests + for (my $i=0; $i<$pagedepth; $i++) { + my $r=$res->[$i]; + is($r->{height}, $pagedepth - $r->{depth}, + "$msgprefix\[$i\]: height = pagedepth - depth"); + ok($r->{depth} ge 0, "$msgprefix\[$i\]: depth>=0"); + ok($r->{height} ge 0, "$msgprefix\[$i\]: height>=0"); + } + # comparison tests, iff the test-suite has been written + if (scalar(@$exp) eq $pagedepth) { + for (my $i=0; $i<$pagedepth; $i++) { + my $e=$exp->[$i]; + my $r=$res->[$i]; + map { is($r->{$_}, $e->{$_}, "$msgprefix\[$i\]: $_"); } keys %$e; + } + } + # else { + # diag("Testsuite is incomplete for ($page,$loop); cannot run comparison tests."); + # } + } +} + +# Main +test_loop('pedigree', $expected{'pedigree'}); diff --git a/t/parentlinks/templates/parentlinks.tmpl b/t/parentlinks/templates/parentlinks.tmpl new file mode 100644 index 000000000..5fa25733a --- /dev/null +++ b/t/parentlinks/templates/parentlinks.tmpl @@ -0,0 +1,4 @@ + + + + diff --git a/t/pedigree.t b/t/pedigree.t deleted file mode 100755 index 74871cfa8..000000000 --- a/t/pedigree.t +++ /dev/null @@ -1,83 +0,0 @@ -#!/usr/bin/perl -# -*- cperl-indent-level: 8; -*- -# Testcases for the Ikiwiki pedigree plugin. - -use warnings; -use strict; -use Test::More 'no_plan'; - -my %expected; - -BEGIN { use_ok("IkiWiki"); } - -# Init -%config=IkiWiki::defaultconfig(); -$config{srcdir}=$config{destdir}="/dev/null"; -$config{underlaydir}="underlays/basewiki"; -$config{templatedir}="t/pedigree/templates"; -IkiWiki::loadplugins(); -IkiWiki::checkconfig(); -ok(IkiWiki::loadplugin("pedigree"), "pedigree plugin loaded"); - -# Test data -$expected{'pedigree'} = - { - "" => [], - "ikiwiki" => [], - "ikiwiki/pagespec" => - [ {depth => 0, height => 2, }, - {depth => 1, height => 1, }, - ], - "ikiwiki/pagespec/attachment" => - [ {depth => 0, height => 3, depth_0 => 1, height_3 => 1}, - {depth => 1, height => 2, }, - {depth => 2, height => 1, }, - ], - }; - -# Test function -sub test_loop($$) { - my $loop=shift; - my $expected=shift; - my $template; - my %params; - - ok($template=template('pedigree.tmpl'), "template created"); - ok($params{template}=$template, "params populated"); - - while ((my $page, my $exp) = each %{$expected}) { - my @path=(split("/", $page)); - my $pagedepth=@path; - my $msgprefix="$page $loop"; - - # manually run the plugin hook - $params{page}=$page; - $template->clear_params(); - IkiWiki::Plugin::pedigree::pagetemplate(%params); - my $res=$template->param($loop); - - is(scalar(@$res), $pagedepth, "$msgprefix: path length"); - # logic & arithmetic validation tests - for (my $i=0; $i<$pagedepth; $i++) { - my $r=$res->[$i]; - is($r->{height}, $pagedepth - $r->{depth}, - "$msgprefix\[$i\]: height = pagedepth - depth"); - ok($r->{depth} ge 0, "$msgprefix\[$i\]: depth>=0"); - ok($r->{height} ge 0, "$msgprefix\[$i\]: height>=0"); - } - # comparison tests, iff the test-suite has been written - if (scalar(@$exp) eq $pagedepth) { - for (my $i=0; $i<$pagedepth; $i++) { - my $e=$exp->[$i]; - my $r=$res->[$i]; - map { is($r->{$_}, $e->{$_}, "$msgprefix\[$i\]: $_"); } keys %$e; - } - } - # else { - # diag("Testsuite is incomplete for ($page,$loop); cannot run comparison tests."); - # } - } -} - -# Main -test_loop('pedigree', $expected{'pedigree'}); diff --git a/t/pedigree/templates/pedigree.tmpl b/t/pedigree/templates/pedigree.tmpl deleted file mode 100644 index 5fa25733a..000000000 --- a/t/pedigree/templates/pedigree.tmpl +++ /dev/null @@ -1,4 +0,0 @@ - - - - -- cgit v1.2.3