Safe Haskell	None
Language	Haskell98

Hakyll.Web.Template.Context

Synopsis

Documentation

data ContextField Source

Mostly for internal usage

Constructors

StringField String
forall a . ListField (Context a) [Item a]

newtype Context a Source

The Context monoid. Please note that the order in which you compose the items is important. For example in

field "A" f1 <> field "A" f2

the first context will overwrite the second. This is especially important when something is being composed with metadataField (or defaultContext). If you want your context to be overwritten by the metadata fields, compose it from the right:

metadataField <> field "date" fDate

Constructors

Context
Fields unContext :: String -> [String] -> Item a -> Compiler ContextField

Instances

Monoid (Context a)

field Source

Arguments

:: String	Key
-> (Item a -> Compiler String)	Function that constructs a value based on the item
-> Context a

Constructs a new field in the 'Context.'

boolField :: String -> (Item a -> Bool) -> Context a Source

Creates a field to use with the $if()$ template macro.

constField :: String -> String -> Context a Source

Creates a field that does not depend on the Item

listField :: String -> Context a -> Compiler [Item a] -> Context b Source

listFieldWith :: String -> Context a -> (Item b -> Compiler [Item a]) -> Context b Source

functionField :: String -> ([String] -> Item a -> Compiler String) -> Context a Source

mapContext :: (String -> String) -> Context a -> Context a Source

defaultContext :: Context String Source

A context that contains (in that order)

A $body$ field
1. Metadata fields
2. A $url$ urlField
3. A $path$ pathField
4. A $title$ titleField

bodyField :: String -> Context String Source

Constructs a field that contains the body of the item.

metadataField :: Context a Source

Map any field to its metadata value, if present

urlField :: String -> Context a Source

Absolute url to the resulting item

pathField :: String -> Context a Source

Filepath of the underlying file of the item

titleField :: String -> Context a Source

This title field takes the basename of the underlying file by default

dateField Source

Arguments

:: String	Key in which the rendered date should be placed
-> String	Format to use on the date
-> Context a	Resulting context

When the metadata has a field called published in one of the following formats then this function can render the date.

```
Mon, 06 Sep 2010 00:01:00 +0000
```
```
Mon, 06 Sep 2010 00:01:00 UTC
```
```
Mon, 06 Sep 2010 00:01:00
```
```
2010-09-06T00:01:00+0000
```
```
2010-09-06T00:01:00Z
```
```
2010-09-06T00:01:00
```
```
2010-09-06 00:01:00+0000
```
```
2010-09-06 00:01:00
```
```
September 06, 2010 00:01 AM
```

Following date-only formats are supported too (00:00:00 for time is assumed)

```
2010-09-06
```
```
September 06, 2010
```

Alternatively, when the metadata has a field called path in a folder/yyyy-mm-dd-title.extension format (the convention for pages) and no published metadata field set, this function can render the date. This pattern matches the file name or directory names that begins with yyyy-mm-dd . For example: folder/yyyy-mm-dd-titledist/main.extension . In case of multiple matches, the rightmost one is used.

dateFieldWith Source

Arguments

:: TimeLocale	Output time locale
-> String	Destination key
-> String	Format to use on the date
-> Context a	Resulting context

This is an extended version of dateField that allows you to specify a time locale that is used for outputting the date. For more details, see dateField.

getItemUTC Source

Arguments

:: MonadMetadata m
=> TimeLocale	Output time locale
-> Identifier	Input page
-> m UTCTime	Parsed UTCTime

Parser to try to extract and parse the time from the published field or from the filename. See dateField for more information. Exported for user convenience.

modificationTimeField Source

Arguments

:: String	Key
-> String	Format
-> Context a	Resuting context

modificationTimeFieldWith Source

Arguments

:: TimeLocale	Time output locale
-> String	Key
-> String	Format
-> Context a	Resulting context

teaserField Source

Arguments

:: String	Key to use
-> Snapshot	Snapshot to load
-> Context String	Resulting context

A context with "teaser" key which contain a teaser of the item. The item is loaded from the given snapshot (which should be saved in the user code before any templates are applied).

missingField :: Context a Source