summaryrefslogtreecommitdiff
path: root/src/Hakyll
diff options
context:
space:
mode:
authorJasper Van der Jeugt <m@jaspervdj.be>2012-12-17 00:46:23 +0100
committerJasper Van der Jeugt <m@jaspervdj.be>2012-12-17 00:46:23 +0100
commit21648b8388427003928782d2f1969ab2957b553b (patch)
tree3a671a7e392dc61ad30c208d0ce5dfe677178659 /src/Hakyll
parent918ed3c3fab736bb6b3b72724bdcb07e33d87a0b (diff)
downloadhakyll-21648b8388427003928782d2f1969ab2957b553b.tar.gz
Bit of template docs
Diffstat (limited to 'src/Hakyll')
-rw-r--r--src/Hakyll/Web/Template/Context.hs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/Hakyll/Web/Template/Context.hs b/src/Hakyll/Web/Template/Context.hs
index 084a42e..c2ec6bc 100644
--- a/src/Hakyll/Web/Template/Context.hs
+++ b/src/Hakyll/Web/Template/Context.hs
@@ -96,6 +96,7 @@ bodyField key = field key $ return . itemBody
--------------------------------------------------------------------------------
+-- | Map any field to its metadata value, if present
metadataField :: Context String
metadataField = Context $ \k i -> do
metadata <- getMetadata $ itemIdentifier i
@@ -103,17 +104,20 @@ metadataField = Context $ \k i -> do
--------------------------------------------------------------------------------
+-- | Absolute url to the resulting item
urlField :: String -> Context a
urlField key = field key $
fmap (maybe empty toUrl) . getRoute . itemIdentifier
--------------------------------------------------------------------------------
+-- | Filepath of the underlying file of the item
pathField :: String -> Context a
pathField key = field key $ return . toFilePath . itemIdentifier
--------------------------------------------------------------------------------
+-- | This title field takes the basename of the underlying file by default
titleField :: String -> Context a
titleField key = mapContext takeBaseName $ pathField key