Kirby Enhanced Sitemap Templates

by Jannik Beyerstedt from Hamburg, Germany
jannikbeyerstedt.de | Github
license: GNU GPL v3
version: v1.2.1

Introduction

Sitemap-Templates with option to exclude pages by template e.g. for one-pagers

This template for the kirby CMS let’s you have fine grained control over the pages included in the sitemap. Especially I needed features to exclude onepager sections.

The main features are:

• you can ignore special sites by it’s URI
• and you can ignore sites by the template it uses !
  in detail it is the "intended template", aka filename of the content file!

Invisible pages will not be shown in the sitemap, but there is an option to show invisible pages at the top level anyway (e.g. to show imprint and contact pages in the sitemap as well).

There is also a html version of the sitemap available, but this template uses some special snippets I use for my header, navigation and footer, so you would have to adjust this to your site’s structure.

User Manual

Installation

store the files of the templates folder in

site/templates/

store the files of the snippets folder in

site/snippets/

store the files of the blueprints folder in

site/blueprints/

There are two files each! One is for the xml sitemap, one for an html sitemap, which is human readable.

Html Sitemap

The html sitemap can be embedded in your content section by the handy snippet. E.g. create a template named htmlsitemap with your normal site structure and replace your normal (text) content with the snippet. The snippet creates two columns with the twitter bootstrap markup, so you have to have bootstrap or you have to write a little css to put the columns in the right place.
There is a corresponding blueprint for a htmlsitemap template, which displays some information in the panel.

Preparation

set some constants in your config.php

c::set('smap_ignoreSite',     array('sitemap', 'htmlsitemap'));
c::set('smap_ignoreTemplate', array('foo'));
c::set('smap_showHiddenPagesAtRootLevel', true);

smap_ignoreSite contains all sites you want to be excluded from the sitemap.
smap_ignoreTemplate contains all templates you want to be excluded from the sitemap.
smap_showHiddenPagesAtRootLevel option to show hidden pages at top level

For the html sitemap, you should set some other values:

c::set('smap_heading_visible', 'visible pages (e.g. menu)');
c::set('smap_heading_invisible', 'invisible pages (e.g. others)');

smap_heading_visible sets a heading for all visible pages. These are often the pages included in the main menu, so it would be nice to title them as main menu.
smap_heading_invisible set a heading for all invisible pages.

Including the Template

As for every other kirby template, generate a page (folder) for your URI and let the the content file have the same name as the template.

The Snippet

The snippet is very easy to use:

snippet('htmlsitemap');

contribution

Feel free to fork this repository and make it better.