sitemap to handle dynamic urls

[amitu]

Background

Sitemap feature is for site owners to organise the site, especially so the header can show appropriate navigation links as selected.

Basically there is a global toc tree that you can access using the sitemap processor:

-- import: fastn/processors as pr

-- pr.sitemap-data sitemap:
$processor$: pr.sitemap

As you can see in the returned JSON:

{
  "sitemap": {
    "sections": [
      {
        "title": "Section Title",
        "url": "/",
        "is-active": true,
        "children": []
      }
    ]
    .. rest omitted ..
},

Notice the is-active flag, this is set based on current page, our processor looks for the current URL in the entire sub tree, and the entire subtree corresponding to current URL is marked is-active: true, which can be used by the site-header to highlight things.

Apps And Dynamic URLs

Now that we have fastn app feature, some apps support dynamic URLs. Actually even without app, our dynamic urls feature we can have dynamic URLs, which can not be listed in our static sitemap file.

So we want to allow dynamic URLs in sitemap entries:

-- fastn.dynamic-urls:

# User Profile Page
  url: /<string:username>/
  document: profile.ftd
  id: foo

Or the future planned "unified url-mappings feature":

-- fastn.url-mappings:

;; dynamic url mapping
presentation-page@foo: /p/<string:team-slug>/<string:presentation-slug>/ -> presentation.ftd

In both above example we see foo as the "id" given to the dynamic URL pattern.

We can then refer to this foo the way we mentioned in the Linking using id syntax:

-- fastn.sitemap:

# Section: foo

## Subsection: foo2

- ToC: foo3