allow a bare page name to be specified as a template
authorJoey Hess <joey@kitenet.net>
Fri, 23 Apr 2010 18:44:37 +0000 (14:44 -0400)
committerJoey Hess <joey@kitenet.net>
Fri, 23 Apr 2010 18:44:37 +0000 (14:44 -0400)
IkiWiki.pm
doc/plugins/write.mdwn
template-transition-notes

index 0aaf605694d9fc2a53cb5c527a3b2e38e11da506..03441b594da3fd604d628dff1bea29855045abe6 100644 (file)
@@ -1653,9 +1653,18 @@ sub saveindex () {
 
 sub template_file ($) {
        my $name=shift;
+       
+       my $tpage="templates/$name";
+       if ($name !~ /\.tmpl$/ && exists $pagesources{$tpage}) {
+               $tpage=$pagesources{$tpage};
+               $name.=".tmpl";
+       }
 
-       my $template=srcfile("templates/$name", 1);
-       return $template if defined $template;
+       my $template=srcfile($tpage, 1);
+       if (defined $template) {
+               return $template, $tpage if wantarray;
+               return $template;
+       }
        
        foreach my $dir ($config{templatedir},
                         "$installdir/share/ikiwiki/templates") {
@@ -1664,18 +1673,16 @@ sub template_file ($) {
        return;
 }
 
-sub template ($;@) {
-       template_depends(shift, undef, @_);
-}
-
 sub template_depends ($$;@) {
        my $name=shift;
        my $page=shift;
-
-       if (defined $page) {
-               add_depends($page, "templates/$name");
+       
+       my ($filename, $tpage)=template_file($name);
+       if (defined $page && defined $tpage) {
+               add_depends($page, $tpage);
        }
-       my $filename=template_file($name);
+
+       return unless defined $filename;
 
        require HTML::Template;
        return HTML::Template->new(
@@ -1691,6 +1698,10 @@ sub template_depends ($$;@) {
        );
 }
 
+sub template ($;@) {
+       template_depends(shift, undef, @_);
+}
+
 sub misctemplate ($$;@) {
        my $title=shift;
        my $pagebody=shift;
index eaa0081319d223a0934b7b48d4edbaf27eac501e..1407b5a1270a1843bb21b20ba50acd243bd6be6d 100644 (file)
@@ -702,8 +702,15 @@ the entire wiki build and make the wiki unusable.
 ### `template($;@)`
 
 Creates and returns a [[!cpan HTML::Template]] object. The first parameter
-is the name of the file in the template directory. The optional remaining
-parameters are passed to `HTML::Template->new`.
+is the name of the template file. The optional remaining parameters are
+passed to `HTML::Template->new`.
+
+The template file is first looked for in the templates/ subdirectory of the
+srcdir. Failing that, it is looked for in the templatedir. Typically
+the filename will have a ".tmpl" extension. If a filename with no extension
+is passed, a wiki page in templates/ with its name is used as the template.
+That should only be done for templates which it is safe to let wiki users
+edit.
 
 ### `template_depends($$;@)`
 
index 193dd79d406e23d4e6ae6e99399764bf2a7d7869..ccff3e78fe48370a0340ea0079ee3ef82ae2dd5f 100644 (file)
@@ -3,3 +3,4 @@
 * includes no longer allowed in templates
 * template directive no longer uses $foo.tmpl , only
   page $foo.
+* template_params removed (not exported API)