Hakyll.Web.Template.DirList

Documentation

data Configuration

Configuration for allowing variation of collection and item tags in dependency of the hierarchical directory level. The level count begins with zero.

Constructors

Configuration

Fields

• beginItemTag :: Int -> String

  begin of item tag, default returns '<li>'

• endItemTag :: Int -> String

  end of item tag, default returns '</li>'

• beginCollectionTag :: Int -> String

  begin of collection tag, default returns '<ul>'

• endCollectionTag :: Int -> String

  end of collection tag, default returns '</ul>'

Instances

Default Configuration

Defined in Hakyll.Web.Template.DirList

Methods

def :: Configuration

defaultConfiguration :: Configuration

Default configuration for dirListField

metadataConfiguration :: Metadata -> Configuration -> Configuration

Read Configuration from Metadata the given default Configuration is used if no coresponding metadata field is found. The fields are: beginItemTag, endItemTag, beginCollectionTag, endCollectionTag These fields can hold a list of tags which are separated by the value of the field tagDelimiter, or if not given an ','. The list holds the tags per level, if level is higher than the tags in the list the last tag is used. Use a double hyphen '--' to get an empty string as tag.

dirListField :: Configuration -> String -> Context a -> Compiler [Item a] -> Context b

The exported dirListField function is similar to the listField template function but creates additional context information which can be used in the template to create a hierarchical menu.

Context usable inside the template

$begin-tags$

injects <li> and <ul> tags if apropriate

$end-tags$

contains the corresponding </li> and </ul> tags

$full-page-id$

is the hyphen seperated path of the page

Metainformation in the source files

For each subdirectory which should be processed one source file with the same base name should exist which can contain meta information:

pages/a.md

top page for directory a

pages/a/foo.md

page foo within a

The following meta information can be given

page-id

part of the generated id, if not given the base name of the file

page-order

give an ordering key for sorting in the current directory level, if not given the page-id will be used