urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

* Support inlining pages raw, rather than creating a blog. 

* Clean up yes/no parameter parsing in inline plugin.
* Implemented better cycle detection in the inline plugin; nested inlines
  will now work.
master
joey 2006-08-18 03:56:18 +00:00
parent 516c9eb3eb
commit c6ee9cbf45
3 changed files with 80 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
IkiWiki/Plugin/inline.pm
View File

@ -22,29 +22,29 @@ sub import { #{{{
package IkiWiki; package IkiWiki;
my %toping; my %toping;
my $processing_inline=0; my @processing_inline;
sub yesno ($) { #{{{
my $val=shift;
return (defined $val && lc($val) eq "yes");
} #}}}
sub preprocess_inline (@) { #{{{ sub preprocess_inline (@) { #{{{
my %params=@_; my %params=@_;
# Avoid nested inlines, to avoid loops etc.
return "" if grep { $_ eq $params{page} } @processing_inline;
push @processing_inline, $params{page};
if (! exists $params{pages}) { if (! exists $params{pages}) {
return ""; return "";
} }
if (! exists $params{archive}) { my $raw=yesno($params{raw});
$params{archive}="no"; my $archive=yesno($params{archive});
} my $rss=exists $params{rss} ? yesno($params{rss}) : 1;
if (! exists $params{show} && $params{archive} eq "no") { if (! exists $params{show} && ! $archive) {
$params{show}=10; $params{show}=10;
} }
if (! exists $params{rss}) {
$params{rss}="yes";
}
# Avoid nested inlines, to avoid loops etc.
if ($processing_inline) {
return "";
}
$processing_inline=1;
my @list; my @list;
foreach my $page (keys %pagesources) { foreach my $page (keys %pagesources) {
@ -72,7 +72,7 @@ sub preprocess_inline (@) { #{{{
} }
$ret.=$formtemplate->output; $ret.=$formtemplate->output;
} }
elsif ($config{rss} && $params{rss} eq "yes") { elsif ($config{rss} && $rss) {
# Add a rss link button. # Add a rss link button.
my $linktemplate=template("rsslink.tmpl", blind_cache => 1); my $linktemplate=template("rsslink.tmpl", blind_cache => 1);
$linktemplate->param(rssurl => rsspage(basename($params{page}))); $linktemplate->param(rssurl => rsspage(basename($params{page})));
@ -80,46 +80,56 @@ sub preprocess_inline (@) { #{{{
} }
my $template=template( my $template=template(
(($params{archive} eq "no") ($archive ? "inlinepagetitle.tmpl" : "inlinepage.tmpl"),
? "inlinepage.tmpl"
: "inlinepagetitle.tmpl"),
blind_cache => 1, blind_cache => 1,
); ) unless $raw;
foreach my $page (@list) { foreach my $page (@list) {
# Don't use htmllink because this way the title is separate if (! $raw) {
# and can be overridden by other plugins. # Don't use htmllink because this way the title is separate
my $link=htmlpage(bestlink($params{page}, $page)); # and can be overridden by other plugins.
$link=abs2rel($link, dirname($params{page})); my $link=htmlpage(bestlink($params{page}, $page));
$template->param(pageurl => $link); $link=abs2rel($link, dirname($params{page}));
$template->param(title => pagetitle(basename($page))); $template->param(pageurl => $link);
# TODO: if $params{archive} eq "no", the only reason to do this $template->param(title => pagetitle(basename($page)));
# is to let the meta plugin get page title info; so stop # TODO: if $archive=1, the only reason to do this
# calling this next line then once the meta plugin can # is to let the meta plugin get page title info; so stop
# store that accross runs (also tags plugin). # calling this next line then once the meta plugin can
$template->param(content => get_inline_content($page, $params{page})); # store that accross runs (also tags plugin).
$template->param(ctime => displaytime($pagectime{$page})); $template->param(content => get_inline_content($page, $params{page}));
$template->param(ctime => displaytime($pagectime{$page}));
run_hooks(pagetemplate => sub { run_hooks(pagetemplate => sub {
shift->(page => $page, destpage => $params{page}, shift->(page => $page, destpage => $params{page},
template => $template,); template => $template,);
}); });
$ret.=$template->output; $ret.=$template->output;
$template->clear_params; $template->clear_params;
}
else {
my $file=$pagesources{$page};
my $type=pagetype($file);
if (defined $type) {
$ret.="\n".
preprocess($page, $params{page},
linkify($page, $params{page},
filter($page,
readfile(srcfile($file)))));
}
}
} }
# TODO: should really add this to renderedfiles and call # TODO: should really add this to renderedfiles and call
# check_overwrite, but currently renderedfiles # check_overwrite, but currently renderedfiles
# only supports listing one file per page. # only supports listing one file per page.
if ($config{rss} && $params{rss} eq "yes") { if ($config{rss} && $rss) {
writefile(rsspage($params{page}), $config{destdir}, writefile(rsspage($params{page}), $config{destdir},
genrss($params{page}, @list)); genrss($params{page}, @list));
$toping{$params{page}}=1 unless $config{rebuild}; $toping{$params{page}}=1 unless $config{rebuild};
} }
$processing_inline=0; pop @processing_inline;
return $ret; return $ret;
} #}}} } #}}}

6
debian/changelog vendored
View File

@ -5,8 +5,12 @@ ikiwiki (1.21) UNRELEASED; urgency=low
class="selflink" so that it can be styled. I don't have a useful style class="selflink" so that it can be styled. I don't have a useful style
defined for that though. defined for that though.
* Call filter hooks on inlined page content. * Call filter hooks on inlined page content.
* Support inlining pages raw, rather than creating a blog.
* Clean up yes/no parameter parsing in inline plugin.
* Implemented better cycle detection in the inline plugin; nested inlines
will now work.
-- Joey Hess <joeyh@debian.org> Thu, 17 Aug 2006 20:39:20 -0400 -- Joey Hess <joeyh@debian.org> Thu, 17 Aug 2006 23:27:38 -0400
ikiwiki (1.20) unstable; urgency=low ikiwiki (1.20) unstable; urgency=low

27
doc/plugins/inline.mdwn
View File

@ -1,5 +1,28 @@
Allows including one wiki page inside another, generating blogs and RSS This is a [[PreProcessorDirective]] that allows including one wiki page
feeds. See [[blog]] for details. inside another. For example:
\[[inline pages="blog/*"]]
The most common use of inlining is generating blogs and RSS feeds.
See [[blog]] for details.
## usage
Here are descriptions of all the supported parameters to the `inline`
directive:
* `pages` - A [[PageSpec]] of the pages to inline.
* `show` - Specify the maximum number of matching pages to inline.
Default is 10, unless archiving, when the default is to show all.
Set to 0 to show all matching pages.
* `rss` - Controls generation of an RSS feed. On by default, set to "no" to
disable.
* `rootpage` - Enables a form to post new pages to a [[blog]].
* `archive` - If set to "yes", only list page titles and some metadata, not
full controls.
* `raw` - Rather than the default behavior of creating a [[blog]],
if raw is set to "yes", the page will be included raw, without additional
markup around it, as if it were a literal part of the inlining page.
This plugin is enabled by default. This plugin is enabled by default.