urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ikiwiki/IkiWiki/Plugin/toggle.pm

120 lines
3.2 KiB
Perl
Raw Normal View History

* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
#!/usr/bin/perl
package IkiWiki::Plugin::toggle;
use warnings;
use strict;
* pagespec_match() has changed to take named parameters, to better allow for extended pagespecs. The old calling convention will still work for back-compat for now. * The calling convention for functions in the IkiWiki::PageSpec namespace has changed so they are passed named parameters. * Plugin interface version increased to 2.00 since I don't anticipate any more interface changes before 2.0.
2007-04-27 04:55:52 +02:00
use IkiWiki 2.00;
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01: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.
export javascript, and support default-open toggles
2008-07-02 21:33:52 +02:00
our $javascript=<<'EOF';
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
<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];
export javascript, and support default-open toggles
2008-07-02 21:33:52 +02:00
if (document.getElementById(id).className == "toggleable")
document.getElementById(id).style.display="none";
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
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 { #{{{
hook(type => "preprocess", id => "toggle",
call => \&preprocess_toggle);
hook(type => "preprocess", id => "toggleable",
don't need to scan after all; links inside blocks of text should be found normally
2006-11-26 20:45:39 +01:00
call => \&preprocess_toggleable);
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
hook(type => "format", id => "toggle", call => \&format);
} # }}}
bugfixen
2006-11-22 05:26:44 +01:00
sub genid ($$) { #{{{
my $page=shift;
my $id=shift;
$id="$page.$id";
# make it a legal html id attribute
$id=~s/[^-a-zA-Z0-9.]/-/g;
if ($id !~ /^[a-zA-Z]/) {
$id="id$id";
}
return $id;
} #}}}
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
sub preprocess_toggle (@) { #{{{
my %params=(id => "default", text => "more", @_);
bugfixen
2006-11-22 05:26:44 +01:00
my $id=genid($params{page}, $params{id});
toggle: Add support for toggles that are open by default. Also fix to work in preview mode.
2008-07-02 22:02:01 +02:00
return "<a class=\"toggle\" href=\"#$id\">$params{text}</a>";
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
} # }}}
sub preprocess_toggleable (@) { #{{{
toggle: Add support for toggles that are open by default. Also fix to work in preview mode.
2008-07-02 22:02:01 +02:00
my %params=(id => "default", text => "", open => "no", @_);
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
# Preprocess the text to expand any preprocessor directives
don't need to scan after all; links inside blocks of text should be found normally
2006-11-26 20:45:39 +01:00
# embedded inside it.
* Fix the template, toggle, and conditional plugins to filter text before preprocessing it. * Fix smiley plugin to support smileys at the very beginning or end of the content.
2007-02-14 01:11:19 +01:00
$params{text}=IkiWiki::preprocess($params{page}, $params{destpage},
* Add a destpage parameter to the filter hook. * Fix links to smilies generated by the smiley plugin for inlined pages. The old links were often wrong, but often still worked by accident.
2007-05-17 21:55:11 +02:00
IkiWiki::filter($params{page}, $params{destpage}, $params{text}));
bugfixen
2006-11-22 05:26:44 +01:00
my $id=genid($params{page}, $params{id});
toggle: Add support for toggles that are open by default. Also fix to work in preview mode.
2008-07-02 22:02:01 +02:00
my $class=(lc($params{open}) ne "yes") ? "toggleable" : "toggleable-open";
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
# Should really be a postprocessor directive, oh well. Work around
updates
2006-11-22 15:28:38 +01:00
# markdown's dislike of markdown inside a <div> with various funky
# whitespace.
my ($indent)=$params{text}=~/( +)$/;
$indent="" unless defined $indent;
toggle: Add support for toggles that are open by default. Also fix to work in preview mode.
2008-07-02 22:02:01 +02:00
return "<div class=\"$class\" id=\"$id\"></div>\n\n$params{text}\n$indent<div class=\"toggleableend\"></div>";
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
} # }}}
sub format (@) { #{{{
my %params=@_;
toggle: Add support for toggles that are open by default. Also fix to work in preview mode.
2008-07-02 22:02:01 +02:00
if ($params{content}=~s!(<div class="toggleable(?:-open)?" id="[^"]+">)</div>!$1!g) {
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
$params{content}=~s/<div class="toggleableend">//g;
toggle: Add javascript to top of page, not to end. This avoids flicker since closed toggles will not be displayed as the page is loading.
2008-07-02 22:14:18 +02:00
if (! ($params{content}=~s!^<body>!<body>$javascript!m)) {
call format hooks when generating page previews * toc: Revert change in 2.45 that made it run at sanitize time. This breaks use of toc in a sidebar. * Call format hooks when generating page previews, thus fixing toc display there, as well as fixing inlins to again display in page previews, since it's started using format hooks. This also allows several other things, like embed, that use format hooks, to work during page preview time. * Format hooks should not rely on getting an entire html document, as they will only get the body during page preview. * toggle: Deal with preview mode when adding javascript.
2008-06-29 05:08:24 +02:00
# no </body> tag, probably in preview mode
toggle: Add javascript to top of page, not to end. This avoids flicker since closed toggles will not be displayed as the page is loading.
2008-07-02 22:14:18 +02:00
$params{content}=$javascript.$params{content};
call format hooks when generating page previews * toc: Revert change in 2.45 that made it run at sanitize time. This breaks use of toc in a sidebar. * Call format hooks when generating page previews, thus fixing toc display there, as well as fixing inlins to again display in page previews, since it's started using format hooks. This also allows several other things, like embed, that use format hooks, to work during page preview time. * Format hooks should not rely on getting an entire html document, as they will only get the body during page preview. * toggle: Deal with preview mode when adding javascript.
2008-06-29 05:08:24 +02:00
}
* Add toggle plugin. * Introduce the nicebundle. This is a kind of plugin, that just enables many other plugins. It's an easy way to boost ikiwiki from its default, basic wiki, to a full-featured wiki, without manually picking the right set of plugins. New plugins will be added to the nicebundle from time to time.
2006-11-22 03:28:42 +01:00
}
return $params{content};
} # }}}
1