Data about tags
Modulehakyll-4.17.0.0Haskell2010
Hakyll.Web.Tags
This module containing some specialized functions to deal with tags. It assumes you follow some conventions.
We support two types of tags: tags and categories.
To use default tags, use buildTags. Tags are placed in a comma-separated metadata field like this:
---
author: Philip K. Dick
title: Do androids dream of electric sheep?
tags: future, science fiction, humanoid
---
The novel is set in a post-apocalyptic near future, where the Earth and
its populations have been damaged greatly by Nuclear...To use categories, use the buildCategories function. Categories are determined by the directory a page is in, for example, the post
posts/coding/2010-01-28-hakyll-categories.markdownwill receive the coding category.
Advanced users may implement custom systems using buildTagsWith if desired.
In the above example, we would want to create a page which lists all pages in
the coding category, for example, with the Identifier:
tags/coding.htmlThis is where the first parameter of buildTags and buildCategories comes in. In the above case, we used the function:
fromCapture "tags/*.html" :: String -> IdentifierThe tagsRules function lets you generate such a page for each tag in the Rules monad.
Synopsis
- data Tags
- value getTags
- value getTagsByField
- value getCategory
- value buildTagsWith
- value buildTags
- value buildCategories
- value tagsRules
- value renderTags
- value renderTagCloud
- value renderTagCloudWith
- value tagCloudField
- value tagCloudFieldWith
- value renderTagList
- value tagsField
- value tagsFieldWith
- value categoryField
- value simpleRenderLink
- value sortTagsBy
- value caseInsensitiveTags
- Packagehakyll-4.17.0.0
- Exports20
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceTags.hs
Obtain tags from a page in the default way: parse them from the tags
metadata field. This can either be a list or a comma-separated string.
Obtain tags from a page by name of the metadata field. These can be a list or a comma-separated string
Obtain category from a page.
Higher-order function to read tags
value
renderTags Render tags in HTML (the flexible higher-order function)
value
renderTagCloud Render a tag cloud in HTML
value
renderTagCloudWith Render a tag cloud in HTML
value
tagCloudField Render a tag cloud in HTML as a context
value
tagCloudFieldWith Render a tag cloud in HTML as a context
Render a simple tag list in HTML, with the tag count next to the item TODO: Maybe produce a Context here
Render tags with links
value
tagsFieldWith Render tags with links with custom functions to get tags and to render links
Render the category in a link
Render one tag link
Sort tags using supplied function. First element of the tuple passed to the comparing function is the actual tag name.
Sample sorting function that compares tags case insensitively.