README

Requirement: Kirby 3.0

Coffee, Beer, etc.

A humungous amount of work went into creating this plugin. Seriously it did. Just look at the source code if you dare, because there is a lot going on in there to make your life easier (even if it means that I have to spend days hunched over a keyboard doing this so you don't have to!). Who knew that traversing through all the pages in a kirby 3 site and spitting out the right xml elements could be so much fun (and I use the word fun there in its alternative-reality meaning). If you run a multi-language site you should be jumping up and down with joy because it gets the sitemaps right, and trust me when I say this is not as easy to do as you might think it is. For kicks, and to stop your processor getting hammered because generating process is a bit intense, the result is cached, and writing that cache code involved a lot of coffee. I also get a dopamine hit if you star this repo. So go star it. Pretty please!

This plugin is free but if you use it in a commercial project to show your support you are welcome (greatly encouraged) to:

Documentation

Purpose

For a kirby3 site, this plugin (omz13/xmlsitemap) automatically generates an xml-based sitemap at /sitemap.xml and provides a prettifier (/sitemap.xsl) for humans.

Generates a sitemap; valid too.
Works with both single-language and multi-language sites.
For multilingual sites an entry (<url>) is generated for each language, and within each <loc> there are appropriate <xhtml:link> members, one for each language with hreflang computed from the language's configured locale), and an additional pseudo-language of x-default per the site's default language.
The generated page can be cached for a determined amount of time, c.f. cacheTTL in Configuration. This not only improves the response time if it can be retrieved from the cache, but also reduces load on your server's cpu (because it takes effort to generate).
For all pages, <loc> and <lastmod> are given; <priority> is not given because "its a bag of noise"; <changefreq> is also not given because it does not affect ranking.
<lastmod> is calculated using the date in a page's field called updatedat, or if not present then from the field date; if neither were found, it is based on the modification time (failing that, the creation time) for the page's content file.
When a page is included in the xml-sitemap, information for images (<image:loc>) on each page is included unless this is disabled; c.f. disableImages in Configuration.
The generated sitemap.xml has an accompanying sitemap.xsl to produce a prettified page for human consumption.
Only pages that have a status of "published" are included (everything else, drafts and unlisted, are excluded).
Pages or their children can be excluded based on the following criteria, and in the following order:
- The homepage is always included.
- The error page is always excluded.
- Only pages that have a status of "published" are included, i.e. those with "draft" or "unpublished" are excluded.
- Unpublished pages can be explicitly included based on their slugname; c.f. includeUnlistedWhenSlugIs in Configuration.
- Unpublished pages can be explicitly included based on their template; c.f. includeUnlistedWhenTemplateIs in Configuration.
- Pages made using certain templates can be excluded; c.f. excludePageWhenTemplateIs in Configuration.
- Pages with certain slugnames can be excluded; c.f. excludePageWhenSlugIs in Configuration.
- Pages with a content field excludefromxmlsitemap that is true are excluded.
- Pages with a method issunset that returns true are excluded.
- Pages with a method isunderembargo that returns true are excluded.
- For use with "one-pagers", children of pages made using certain templates can be excluded as sub-ordinate links (c.f. excludeChildrenWhenTemplateIs in Configuration) but any images in those children will be included and listed as normal (which is how one-pagers are expected to work).
A closure can be specified to return a set of pages to be included in the sitemap, c.f. addPages in Configuration.
For debugging purposes, the generated sitemap can include additional information as xml comments; c.f. debugqueryvalue in Configuration.
For debugging purposes, the cache can be bypassed and an explicitly regenerated sitemap returned; c.f. nocache in Use

Related plugins

For a user-oriented html-based sitemap, kindly see omz13/kirby3-htmlsitemap.

For a plugin that provides the methods issunset and isunderembargo, kindly see omz13/kirby3-suncyclepages.

For a plugin to generate robots.txt and that magically integrates with this one, kindly see omz13/kirby3-wellknown.

Other plugins that I have developed for kirby 3 are to be found in my github repos. Go take a look; you might find some useful. Apparently my README files are highly entertaining. YMMV.

Roadmap

The non-binding list of planned features and implementation notes are:

MVP (loc and lastmod) done 0.1
~~<priority>~~
~~<changefreq>~~
Respect page status done 0.2
Allow specific unlisted pages to be included done 0.2 c.f. includeUnlistedWhenSlugIs
One-pager support done 0.1 c.f. excludeChildrenWhenTemplateIs
Include image sitemap <image:image>
<image:loc> done 0.2
<image:caption>
<image:title>
<image:license>
Exclude image sitemap; c.f. disableImages done 0.3
Exclusion of individual pages – done 0.2 c.f. excludePageWhenSlugIs
Exclusion of pages by template – done 0.1 c.f. excludePageWhenTemplateIs
Better heuristics for <lastmod> (e.g. modifiedat field?)
~~Overriding of stylesheet~~
Disable stylesheet
Remove credits
robots.txt - works with omz13/kirby3-wellknown
Cache done 0.4 c.f. cacheTTL
Automate GitHub release – gothub? github-release-notes?
Inform search engine crawlers when map changes
Guard 50,000 URLs limit
Guard 50MB limit
Sitemap Index files
Video sitemap <video:video>
Support Multilingual sites - done 0.5 REQUIRES kirby 3.0.0-beta-6.16 or better
x-default in ML sitemap done 0.5
Headers to stop sitemap.xml being cached?
Bypass cache and return freshly-generated sitemap, c.f. nocache in Use.

If you want these features, or other ones, implemented, feed me coffee (or EUR or USD).

Installation

Pick one of the following per your epistemological model:

composer require omz13/kirby3-xmlsitemap; the plugin will automagically appear in site/plugins.
Download a zip of the latest release - master.zip - and copy the contents to your site/plugins/kirby3-xmlsitemap.
git submodule add https://github.com/omz13/kirby3-xmlsitemap.git site/plugins/kirby3-xmlsitemap.

For the record: installation by composer is cool; supporting installation by zip and submodule was an absolute pain, especially as I am an installation by composer person, so do feel guilted into getting me Coffee, Beer, etc., because this is for your benefit and not mine (and yes, I would have have preferred to spend my time somewhere warm and sunny instead of being hunched over a keyboard while the snow falls outside and the thermometer shows no inclination to get above 0C).

Configuration

The following mechanisms can be used to modify the plugin's behavior.

via `config.php`

In your site's site/config/config.php the following entries prefixed with omz13.xmlsitemap. can be used:

disable : a boolean which, if true, to disable the xmlsitemap functionality (c.f. xmlsitemap in via site.txt).
cacheTTL : the number of minutes that the xml-sitemap should be cached before being regenerated; if explicitly set to zero, the cache is disabled. If not specified a default of 10 minutes is assumed.
hideuntranslated : a boolean which, if true, will exclude any untranslated pages (for a multi-language site) from the sitemap (thanks to @mauricerenck for the idea).
debugqueryvalue : a string to be as the value for the query parameter debug to return the xml-sitemap with debugging information (as comment nodes within the xml stream). The global kirby debug configuration must also be true for this to work. The url must be to /sitemap.xml?debug=debugqueryvalue and not /sitemap?debug=_debugqueryvalue_ (i.e. the .xls part is important). Be aware that the debugging information will show, if applicable, details of any pages that have been excluded (so if you are using this in production and you don't want things to leak, set debugqueryvalue to something random). Furthermore, the site debug flag needs to be set too (i.e. the debug flag in site/config.php).
includeUnlistedWhenSlugIs : an array of slug names whose pages are to be included if their status is unlisted.
includeUnlistedWhenTemplateIs : an array of template names whose pages are to be included if their status is unlisted.
excludePageWhenTemplateIs : an array of templates names whose pages are to be excluded from the xml-sitemap.
excludePageWhenSlugIs : an array of slug names whose pages are to be excluded from the xml-sitemap.
excludeChildrenWhenTemplateIs : an array of templates names whose children are to be ignored (but pages associated with the template is to be included); this is used for one-pagers (where the principal page will be included and all the 'virtual' children ignored).
disableImages : a boolean which, if true, disables including data for images related to pages included in the xml-sitemap.
addPages : a closure which, if present, returns a collection of Pages to be added. This is how you get virtual pages into the sitemap.

Example - configuration for the Starter Kit

For the Kirby Starter Kit, the following would be applicable:

<?php

return [
  'omz13.xmlsitemap.cacheTTL' => 60,
  'omz13.xmlsitemap.includeUnlistedWhenSlugIs' => [ ],
  'omz13.xmlsitemap.includeUnlistedWhenTemplateIs' => [ ],
  'omz13.xmlsitemap.excludePageWhenTemplateIs' => [ 'contact','sandbox' ],
  'omz13.xmlsitemap.excludePageWhenSlugIs' => [ 'form' ],
  'omz13.xmlsitemap.excludeChildrenWhenTemplateIs' => [ 'events','one-pager','shop','team','testimonials' ],
  ],
];

For experimental purposes this plugin implements a single-level pseudo-namespace. You can mix discrete vs array options, but try not to, and be aware that priority is given to the array variant. The above discrete configuration would therefore become:

<?php

return [
  'omz13.xmlsitemap' => [
    'cacheTTL' => 60,
    'includeUnlistedWhenSlugIs' => [ 'about' ],
    'includeUnlistedWhenTemplateIs' => [ ],
    'excludePageWhenTemplateIs' => ['contact','sandbox'],
    'excludePageWhenSlugIs' => [ 'form' ],
    'excludeChildrenWhenTemplateIs' => [ 'events','one-pager','shop','team','testimonials' ],
    'disableImages' => false,
  ],
];

See Kirby3's ideas issue #32 for more about namespaced options.

And to have a debugged sitemap returned at /sitemap.xml?debug=wombat, it would be:

<?php

return [
  'debug'  => true,

  'omz13.xmlsitemap' => [
    'omz13.xmlsitemap.debugqueryvalue' => 'wombat,'
    'omz13.xmlsitemap.includeUnlistedWhenSlugIs' => [ ],
    'omz13.xmlsitemap.excludeChildrenWhenTemplateIs' => ['events','one-pager','shop','team','testimonials'],
    'omz13.xmlsitemap.excludePageWhenTemplateIs' => ['contact','sandbox'],
    'omz13.xmlsitemap.excludePageWhenSlugIs' => [ 'form' ],
  ],
];

Example 2 - sample closures for `addPages`

Add pages that are in a named collection:

'omz13.xmlsitemap.addPages' => function() {
   return kirby()->collection('articles');
   }

Add a specific page:

'omz13.xmlsitemap.addPages' => function() {
  $c = new Kirby\Cms\Pages;
  $c->add( kirby()->site()->find('blog/the-sweet-dessert') );
  return $c;
  }

via `content/site.txt`

The plugin can be explicitly disabled in content/site.txt by having an entry for xmlsitemap and setting this to false. This could be achieved through the panel by adding the following into site/blueprints/site.yml:

type:          fields
fields:
  xmlsitemap:
    label:     XML sitemap
    type:      toggle
    default:   off
    text:
      - disabled
      - enabled

via content fields

If a page's content has a field called excludefromxmlsitemap and this is set to true, then that page (and any children, if present) will be excluded. Similarly to site.txt, this can be easily achieved in a blueprint.

type:          fields
fields:
  excludefromxmlsitemap:
    label:     Exclude from sitemap.xml
    type:      toggle
    default:   off
    text:
      - include implicitly
      - explicitly exclude

As pages are implicitly included within a sitemap, this mechanism should only be used when you have a reason to explicitly exclude a page when it is not possible to do otherwise (e.g. using excludePageWhenTemplateIs).

PageMethods

headLinkAlternates

If you have a multi-language site, as well as having the sitemap include links to all the different languages, on the site itself each page needs to include <link rel="alternate" hreflang="" /> elements in the <head>.

To make this easy, this plugin provides a pageMethod to do this. So, in your <head>, simply add:

<?= $page->headLinkAlternates(); ?>

Use

The plugin makes a sitemap available at /sitemap.xml, and an associated stylesheet '/sitemap.xls'.

The sitemap can therefore be retrieved by a simple get to these endpoints:

curl -H host:whatever.test -k https://whatever.test/sitemap.xml

Getting a debugged response

If the site is in debug mode, the /sitemap.xml will return a verbose debug-filled response if a debug parameter is set and this matches the value in the configuration's debugqueryvalue, e.g.:

curl -H host:whatever.test -k https://whatever.test/sitemap.xml?debug=42

In debug mode, the endpoint will take an additional optional parameter, nocache, which if true, will bypass and cached response and explicitly return a freshly generated response, e.g.:

curl -H host:whatever.test -k https://whatever.test/sitemap.xml?debug=42&nocache=1

--dev

To develop on this plugin, composer update --dev will pull in the necessary packages and whatnots.

The composer package include scripts that are useful during development:

composer lint to lint the source (using parallel-lint)
composer style to check style issues (using phpcs from PHP_CodeSniffer) against coding standard omz13-k3p in omz13/coding-standard).
composer fix to fix code style issues (using phpcbf from PHP_CodeSniffer)
composer mess to check for potential messes (using phpmd from the PHP Mess Detector)
composer stan to do static analysis of the source (using phpstan from the PHP Static Analysis Tool)
composer sanity to run all the above in sequence. If no errors are shown, this is good.

A makefile is provided because:

make sanity to check the validity of the composer file and run the sanity script (and its less keys than typing composer sanity, and also because I keep mistyping it as compsoer sanity).
make release to release an updated version using liip/rmt.

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

You are prohibited from using this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.

wearejust / kirby3-xmlsitemap

Maintainers

Details

README

Coffee, Beer, etc.

Documentation

Purpose

Related plugins

Roadmap

Installation

Configuration

via `config.php`

Example - configuration for the Starter Kit

Example 2 - sample closures for `addPages`

via `content/site.txt`

via content fields

PageMethods

headLinkAlternates

Use

Getting a debugged response

--dev

Disclaimer

License

wearejust / kirby3-xmlsitemap

Maintainers

Details

README

Coffee, Beer, etc.

Documentation

Purpose

Related plugins

Roadmap

Installation

Configuration

via config.php

Example - configuration for the Starter Kit

Example 2 - sample closures for addPages

via content/site.txt

via content fields

PageMethods

headLinkAlternates

Use

Getting a debugged response

--dev

Disclaimer

License

via `config.php`

Example 2 - sample closures for `addPages`

via `content/site.txt`