1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
-- | A module that provides different ways to create a @Context@. These
-- functions all use the @HakyllAction@ arrow, so they produce values of the
-- type @HakyllAction () Context@.
module Text.Hakyll.CreateContext
( createPage
, createCustomPage
, createListing
, addField
, combine
, combineWithUrl
) where
import Prelude hiding (id)
import qualified Data.Map as M
import Control.Arrow (second, arr, (&&&), (***))
import Control.Monad (liftM2)
import Control.Applicative ((<$>))
import Control.Arrow ((>>>))
import Control.Category (id)
import Text.Hakyll.Context
import Text.Hakyll.HakyllAction
import Text.Hakyll.Render
import Text.Hakyll.Page
import Text.Hakyll.Pandoc
import Text.Hakyll.Internal.Cache
-- | Create a @Context@ from a page file stored on the disk. This is probably
-- the most common way to create a @Context@.
createPage :: FilePath -> HakyllAction () Context
createPage path = cacheAction "pages" $ readPageAction path >>> renderAction
-- | Create a custom page @Context@.
--
-- The association list given maps keys to values for substitution. Note
-- that as value, you can either give a @String@ or a
-- @HakyllAction () String@. The latter is preferred for more complex data,
-- since it allows dependency checking. A @String@ is obviously more simple
-- to use in some cases.
--
createCustomPage :: FilePath
-> [(String, Either String (HakyllAction () String))]
-> HakyllAction () Context
createCustomPage url association = HakyllAction
{ actionDependencies = dataDependencies
, actionUrl = Left $ return url
, actionFunction = \_ -> Context . M.fromList <$> assoc'
}
where
mtuple (a, b) = b >>= \b' -> return (a, b')
toHakyllString = second (either return runHakyllAction)
assoc' = mapM (mtuple . toHakyllString) $ ("url", Left url) : association
dataDependencies = map snd association >>= getDependencies
getDependencies (Left _) = []
getDependencies (Right x) = actionDependencies x
-- | A @createCustomPage@ function specialized in creating listings.
--
-- This function creates a listing of a certain list of @Context@s. Every
-- item in the list is created by applying the given template to every
-- renderable. You can also specify additional context to be included in the
-- @CustomPage@.
createListing :: FilePath -- ^ Destination of the page.
-> [FilePath] -- ^ Templates to render items with.
-> [HakyllAction () Context] -- ^ Renderables in the list.
-> [(String, Either String (HakyllAction () String))]
-> HakyllAction () Context
createListing url templates renderables additional =
createCustomPage url context
where
context = ("body", Right concatenation) : additional
concatenation = renderAndConcat templates renderables
-- | Add a field to a 'Context'.
--
addField :: String -- ^ Key
-> Either String (HakyllAction () String) -- ^ Value
-> HakyllAction Context Context -- ^ Result
addField key value = arr (const ()) &&& id
>>> value' *** id
>>> arr (uncurry insert)
where
value' = arr (const ()) >>> either (arr . const) id value
insert v = Context . M.insert key v . unContext
-- | Combine two @Context@s. The url will always be taken from the first
-- @Renderable@. Also, if a `$key` is present in both renderables, the
-- value from the first @Context@ will be taken as well.
--
-- You can see this as a this as a @union@ between two mappings.
combine :: HakyllAction () Context -> HakyllAction () Context
-> HakyllAction () Context
combine x y = HakyllAction
{ actionDependencies = actionDependencies x ++ actionDependencies y
, actionUrl = actionUrl x
, actionFunction = \_ ->
Context <$> liftM2 (M.union) (unContext <$> runHakyllAction x)
(unContext <$> runHakyllAction y)
}
-- | Combine two @Context@s and set a custom URL. This behaves like @combine@,
-- except that for the @url@ field, the given URL is always chosen.
combineWithUrl :: FilePath
-> HakyllAction () Context
-> HakyllAction () Context
-> HakyllAction () Context
combineWithUrl url x y = combine'
{ actionUrl = Left $ return url
, actionFunction = \_ ->
Context . M.insert "url" url . unContext <$> runHakyllAction combine'
}
where
combine' = combine x y
|
