Your files can be as simple or as complex as you want. Kipper doesn't write the HTML--you do!
There are only a few things you need to know. Kipper uses HTML comment tags to mark content and other data. The few places where we write code to your page, it is in XHTML style, which is why you will find the HTML/XHTML option in the interface settings. Kipper will perform some simple conversions based on your selection.
The template needs to be a full web page from top to bottom. To indicate the location of page content, use this once:
<!-- content -->
or
<!-- content:start --><!-- content:end -->
The :start and :end tags can be used if you have template content that needs to be stripped from the rest of the pages. This allows you to use your homepage for the template, simply by adding these tags to your pre-existing file.
You might also be using some other template system that uses different content tags. Autokeen, for example, inserts a comic strip into the homepage with `***todays_comic***`. The following code would allow you to use the same template with Autokeen and Kipper at the same time.
<!-- content:start -->
todays_comic
<!-- content:end -->
When the template is used by Kipper, the Autokeen tag is stripped away; when Autokeen uses the template, it ignores the invisible Kipper tags.
Do not use the content tags more than once! If you have more things to hide, use these tags:
<!-- strip:start --><!-- strip:end -->
You can include or exclude content conditionally, by filename:
<!-- if:filename:start -->
This text appears if the page
is named filename.php
<!-- if:filename:end -->
<!-- ifnot:filename:start -->
This text disappears if the page
is named filename.php
<!-- ifnot:filename:end -->
You can include or exclude content conditionally, by directory:
<!-- ifdir:folder:start -->
This text will appear on every
page in folder, but will
disappear everywhere else.
<!-- ifdir:folder:end -->
<!-- ifnotdir:folder:start -->
This text disappears on every
page in folder, but shows up
everywhere else.
<!-- ifnotdir:folder:end -->
Nesting tags can be used for different results. For instance, if you want code to appear in only one folder, except for its index page, you would combine ifdir and ifnot.
<!-- ifdir:folder:start -->
<!-- ifnot:index:start -->
This text will appear on every
page in folder, but will
disappear everywhere else.
<!-- ifnot:index:end -->
<!-- ifdir:folder:end -->
Use nesting with care! Some combinations don't work. Experiment and find out what works for you.
To include archive navigation, include this code:
<!-- archive:navigation -->
Go to advanced archive navigation for more details.
Just for the heck of it, you can include a stunning Kipper button with either tag below. Not only will we insert the proper code, but we will also copy the button and upload it for you.
<!-- microbutton --> [or] <!-- minibutton -->
The only firm rule is that the content files have to be an HTML fragment; that is, you cannot include full HTML document tags, like <HEAD>, <HTML>, and <BODY>.
There are a number of comment tags that can be used to include content. These are all optional, and can go anywhere in the file, top, middle, or bottom.
<!-- description:Where all the cool kids are. --> <!-- keywords:stamps, philately, philatelists --> <!-- author:Moonshine McFloogle --> <!-- copyright:2009 --> <!-- robots:noindex,follow -->
The first tag creates a specific page title which is appended to the template page title, using a page title divider that you can edit in the settings.
The rest of the tags create (or attempt to edit, if they exist) metatags. If you don't include a particular metatag comment, then the page inherits the metatag content from the template.
Page specific CSS styles can be included in the head, as well.
<!-- style: body { background-color:linen; } body, div, p, li { font: 14pt verdana; } pre { font-size: 14pt; } h1:before, h2:before, h3:before { content:""; } h1, h2, h3 { background-color:tan; } table { width:100%; } td { font: 10pt verdana; } -->
You can use tags in the source file to manually order your pages in an archive, although you would probably find it easier just to make a list in the info.data file.
[in the source file for index.php] <!-- first:index --> <!-- prev:none --> <!-- next:info --> <!-- last:download -->[in the source file for info.php] <!-- first:index --> <!-- prev:index --> <!-- next:details --> <!-- last:download -->
[in the source file for details.php] <!-- first:index --> <!-- prev:info --> <!-- next:tips --> <!-- last:download -->
This method requires more work than the list, but one reason you might prefer this option is that the info.data list also limits the pages made; any source file left off the list will simply not be made. With this method, you can order some pages, and allow others to be made as well.
