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

add test case to ensure all templates are documented

master
Joey Hess 2010-04-23 17:23:31 -04:00
parent 6c64ce0336
commit 9b112cc986
2 changed files with 35 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/templates.mdwn
View File

@ -30,34 +30,34 @@ html out of ikiwiki and in the templates.
* `page.tmpl` - Used for displaying all regular wiki pages. * `page.tmpl` - Used for displaying all regular wiki pages.
* `misc.tmpl` - Generic template used for any page that doesn't * `misc.tmpl` - Generic template used for any page that doesn't
have a custom template. have a custom template.
* `editpage.tmpl` - Create/edit page. * `rsspage.tmpl` - Used for generating rss feeds for blogs.
* `change.tmpl` - Used to create a page describing a change made to the wiki.
* `passwordmail.tmpl` - Not a html template, this is used to
generate a mail with an url the user can use to reset their password.
* `rsspage.tmpl` - Used for generating rss feeds for [[blogs|blog]].
* `rssitem.tmpl` - Used for generating individual items on rss feeds. * `rssitem.tmpl` - Used for generating individual items on rss feeds.
* `atompage.tmpl` - Used for generating atom feeds for blogs. * `atompage.tmpl` - Used for generating atom feeds for blogs.
* `atomitem.tmpl` - Used for generating individual items on atom feeds. * `atomitem.tmpl` - Used for generating individual items on atom feeds.
* `inlinepage.tmpl` - Used for adding a page inline in a blog * `inlinepage.tmpl` - Used for displaying a post in a blog.
page.
* `archivepage.tmpl` - Used for listing a page in a blog archive page. * `archivepage.tmpl` - Used for listing a page in a blog archive page.
* `titlepage.tmpl` - Used for listing a page by title in a blog archive page.
* `microblog.tmpl` - Used for showing a microblogging post inline. * `microblog.tmpl` - Used for showing a microblogging post inline.
* `blogpost.tmpl` - Used for a form to add a post to a blog (and a rss/atom links) * `blogpost.tmpl` - Used for a form to add a post to a blog (and a rss/atom links)
* `feedlink.tmpl` - Used to add rss/atom links if blogpost.tmpl is not used. * `feedlink.tmpl` - Used to add rss/atom links if `blogpost.tmpl` is not used.
* `aggregatepost.tmpl` - Used by the [[plugins/aggregate]] plugin to create * `aggregatepost.tmpl` - Used by the aggregate plugin to create
a page for a post. a page for a post.
* `searchform.tmpl` - Used by the [[plugins/search]] plugin to add a search * `searchform.tmpl`, `googleform.tmpl` - Used by the search plugin
form to wiki pages. and google plugin to add search forms to wiki pages.
* `searchquery.tmpl` - This is an omega template, used by the * `searchquery.tmpl` - This is a Omega template, used by the
[[plugins/search]] plugin. search plugin.
* `comment.tmpl` - This template is used to display a comment * `comment.tmpl` - Used by the comments plugin to display a comment.
by the [[plugins/comments]] plugin. * `change.tmpl` - Used to create a page describing a change made to the wiki.
* `editcomment.tmpl` - This template is the comment post form for the * `recentchanges.tmpl` - Used for listing a change on the RecentChanges page.
[[plugins/comments]] plugin. * `autoindex.tmpl` - Filled in by the autoindex plugin to make index pages.
* `commentmoderation.tmpl` - This template is used to produce the comment * `autotag.tmpl` - Filled in by the tag plugin to make tag pages.
moderation form. * `calendarmonth.tmpl`, `calendaryear.tmpl` - Used by ikiwiki-calendar to
* `recentchanges.tmpl` - This template is used for listing a change make calendar archive pages.
on the RecentChanges page. * `editpage.tmpl`, `editconflict.tmpl`, `editcreationconflict.tmpl`,
`editfailedsave.tmpl`, `editpagegone.tmpl`, `pocreatepage.tmpl`,
`editcomment.tmpl` `commentmoderation.tmpl`, `renamesummary.tmpl`,
`passwordmail.tmpl` - Parts of ikiwiki's user interface; do not
normally need to be customised.
[[!if test="enabled(pagetemplate)" then=""" [[!if test="enabled(pagetemplate)" then="""
## The pagetemplate directive ## The pagetemplate directive

14
t/templates_documented.t 100755
View File

@ -0,0 +1,14 @@
#!/usr/bin/perl
use warnings;
use strict;
use Test::More 'no_plan';
$/=undef;
open(IN, "doc/templates.mdwn") || die "doc/templates.mdwn: $!";
my $page=<IN>;
close IN;
foreach my $file (glob("templates/*.tmpl")) {
$file=~s/templates\///;
ok($page =~ /\Q$file\E/, "$file documented on doc/templates.mdwn");
}