]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Plugin/toggle.pm
update info on my split-view setup, and ask for plugin advice
[git.ikiwiki.info.git] / IkiWiki / Plugin / toggle.pm
index 54c9a0d9a29223e98aecfc6e49f707c7263adfae..af4d2ba3a858774ac6b77be58479fb2a4a18d69c 100644 (file)
@@ -3,67 +3,28 @@ package IkiWiki::Plugin::toggle;
 
 use warnings;
 use strict;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
 
-# Here's the javascript that makes this possible. A key feature is the use
-# of css to hide toggleables, to avoid any flashing on page load. The css
-# is only emitted after the javascript tests that it's going to be able to
-# show the toggleables.
-our $javascript=<<'EOF';
-<script type="text/javascript">
-<!--
-if (document.getElementById && document.getElementsByTagName && document.createTextNode) {
-       document.write('<style type="text/css">div.toggleable { display: none; }</style>');
-       window.onload = inittoggle;
-}
-
-function inittoggle() {
-       var as = getElementsByClass('toggle');
-       for (var i = 0; i < as.length; i++) {
-               var id = as[i].href.match(/#(\w.+)/)[1];
-               if (document.getElementById(id).className == "toggleable")
-                       document.getElementById(id).style.display="none";
-               as[i].onclick = function() {
-                       toggle(this);
-                       return false;
-               }
-       }
-}
-
-function toggle(s) {
-       var id = s.href.match(/#(\w.+)/)[1];
-       style = document.getElementById(id).style;
-       if (style.display == "none")
-               style.display = "block";
-       else
-               style.display = "none";
-}
-
-function getElementsByClass(class) {
-       var ret = new Array();
-       var pattern = new RegExp("(^|\\s)"+class+"(\\s|$)");
-       var els = document.getElementsByTagName('*');
-       for (i = 0, j = 0; i < els.length; i++) {
-               if ( pattern.test(els[i].className) ) {
-                       ret[j] = els[i];
-                       j++;
-               }
-       }
-       return ret;
-}
-//-->
-</script>
-EOF
-
-sub import { #{{{
+sub import {
+       add_underlay("javascript");
+       hook(type => "getsetup", id => "toggle", call => \&getsetup);
        hook(type => "preprocess", id => "toggle",
                call => \&preprocess_toggle);
        hook(type => "preprocess", id => "toggleable",
                call => \&preprocess_toggleable);
        hook(type => "format", id => "toggle", call => \&format);
        hook(type => "preprocess", id => "toggle",
                call => \&preprocess_toggle);
        hook(type => "preprocess", id => "toggleable",
                call => \&preprocess_toggleable);
        hook(type => "format", id => "toggle", call => \&format);
-} # }}}
+}
+
+sub getsetup () {
+       return
+               plugin => {
+                       safe => 1,
+                       rebuild => undef,
+                       section => "widget",
+               },
+}
 
 
-sub genid ($$) { #{{{
+sub genid ($$) {
        my $page=shift;
        my $id=shift;
 
        my $page=shift;
        my $id=shift;
 
@@ -75,50 +36,53 @@ sub genid ($$) { #{{{
                $id="id$id";
        }
        return $id;
                $id="id$id";
        }
        return $id;
-} #}}}
+}
 
 
-sub preprocess_toggle (@) { #{{{
+sub preprocess_toggle (@) {
        my %params=(id => "default", text => "more", @_);
 
        my $id=genid($params{page}, $params{id});
        my %params=(id => "default", text => "more", @_);
 
        my $id=genid($params{page}, $params{id});
-       if (! $params{preview}) {
-               return "<a class=\"toggle\" href=\"#$id\">$params{text}</a>";
-       }
-       else {
-               return "$params{text} ".
-                       gettext("(not toggleable in preview mode)");
-       }
-} # }}}
+       return "<a class=\"toggle\" href=\"#$id\">$params{text}</a>";
+}
 
 
-sub preprocess_toggleable (@) { #{{{
-       my %params=(id => "default", text => "", @_);
+sub preprocess_toggleable (@) {
+       my %params=(id => "default", text => "", open => "no", @_);
 
        # Preprocess the text to expand any preprocessor directives
        # embedded inside it.
 
        # Preprocess the text to expand any preprocessor directives
        # embedded inside it.
-       $params{text}=IkiWiki::preprocess($params{page}, $params{destpage}, 
-               IkiWiki::filter($params{page}, $params{destpage}, $params{text}));
+       $params{text}=IkiWiki::preprocess($params{page}, $params{destpage}, $params{text});
        
        my $id=genid($params{page}, $params{id});
        
        my $id=genid($params{page}, $params{id});
+       my $class=(lc($params{open}) ne "yes") ? "toggleable" : "toggleable-open";
 
        # Should really be a postprocessor directive, oh well. Work around
        # markdown's dislike of markdown inside a <div> with various funky
        # whitespace.
        my ($indent)=$params{text}=~/( +)$/;
        $indent="" unless defined $indent;
 
        # Should really be a postprocessor directive, oh well. Work around
        # markdown's dislike of markdown inside a <div> with various funky
        # whitespace.
        my ($indent)=$params{text}=~/( +)$/;
        $indent="" unless defined $indent;
-       return "<div class=\"toggleable\" id=\"$id\"></div>\n\n$params{text}\n$indent<div class=\"toggleableend\"></div>";
-} # }}}
+       return "<div class=\"$class\" id=\"$id\"></div>\n\n$params{text}\n$indent<div class=\"toggleableend\"></div>";
+}
 
 
-sub format (@) { #{{{
+sub format (@) {
         my %params=@_;
 
         my %params=@_;
 
-       if ($params{content}=~s!(<div class="toggleable" id="[^"]+">)</div>!$1!g) {
+       if ($params{content}=~s!(<div class="toggleable(?:-open)?" id="[^"]+">\s*)</div>!$1!g) {
                $params{content}=~s/<div class="toggleableend">//g;
                $params{content}=~s/<div class="toggleableend">//g;
-               if (! ($params{content}=~s!^<\/body>!$javascript</body>!m)) {
-                       # no </body> tag, probably in preview mode
-                       $params{content}.=$javascript;
+               if (! ($params{content}=~s!^(<body[^>]*>)!$1.include_javascript($params{page})!em)) {
+                       # no <body> tag, probably in preview mode
+                       $params{content}=include_javascript(undef).$params{content};
                }
        }
        return $params{content};
                }
        }
        return $params{content};
-} # }}}
+}
+
+sub include_javascript ($) {
+       my $from=shift;
+       
+       return '<script src="'.urlto("ikiwiki/ikiwiki.js", $from).
+               '" type="text/javascript" charset="utf-8"></script>'."\n".
+               '<script src="'.urlto("ikiwiki/toggle.js", $from).
+               '" type="text/javascript" charset="utf-8"></script>';
+}
 
 1
 
 1