Skip to content
Creates XML sitemaps for BedSheet Applications
Fantom
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.f4
dev
doc
fan
test
.buildpath
.classpath
.hgignore
.project
build.fan
readme.md
todo.txt

readme.md

#Sitemap v1.1.0

Written in: Fantom pod: v1.1.0 Licence: MIT

Overview

Sitemap is a support library that aids Alien-Factory in the development of other libraries, frameworks and applications. Though you are welcome to use it, you may find features are missing and the documentation incomplete.

Sitemap is a library that creates XML sitemaps for your Bed Apps.

Install

Install Sitemap with the Fantom Repository Manager ( fanr ):

C:\> fanr install -r http://pods.fantomfactory.org/fanr/ afSitemap

To use in a Fantom project, add a dependency to build.fan:

depends = ["sys 1.0", ..., "afSitemap 1.1"]

Documentation

Full API & fandocs are available on the Fantom Pod Repository.

Usage

The SitemapUrl object contains the data needed to render an individual URL object. These are gathered by Sitemap in serveral ways:

Pillow Pages

URLs from Pillow pages are added automatically. The page location is generated using BedSheet's host config value - so ensure this has been set!

Pillow pages are ignored if they contain an @InitRender method or @PageContext fields. Such pages take additional URL parameters of which, obviously, Sitemap can not determine valid values for. These pages should implement SitemapSource and return a list of valid SitemapUrls.

If you don't wish a Pillow page to be scanned or included, let it implement SitemapExempt.

Or you can disable all Pillow Pages by removing the SitemapPage contribution:

@Contribute { serviceType=SitemapPage# }
Void contributeSitemapPage(Configuration config) {
    config.remove("afSitemap.fromPillowPages")
}

IoC Services

The IoC service registry is scanned for services that implement SitemapSource. Any service that does is called upon to generate SitemapUrls.

Disable all service scanning by removing the SitemapPage contribution:

@Contribute { serviceType=SitemapPage# }
Void contributeSitemapPage(Configuration config) {
    config.remove("afSitemap.fromServices")
}

IoC Contribution

You may also manually contribute SitemapSource objects to the SitemapPage service:

@Contribute { serviceType=SitemapPage# }
Void contributeSitemapPage(Configuration config) {
    url := SitemapUrl(`/wotever`) { ... }
    config.add(SitemapSourceImpl(url))
}
You can’t perform that action at this time.