From 592845985828f3ee135c309257e9bbcb305be1fa Mon Sep 17 00:00:00 2001
From: Jasper Van der Jeugt <jaspervdj@gmail.com>
Date: Wed, 27 Jan 2010 18:02:43 +0100
Subject: Added createListing, createListingWith functions.

These functions were added to have a simpler and more high-level way to do the
common createCustomPage/renderAndConcat combination to create post lists, rss
feeds, ...
---
 src/Text/Hakyll/Renderables.hs | 44 +++++++++++++++++++++++++++++++++++++++---
 1 file changed, 41 insertions(+), 3 deletions(-)

(limited to 'src/Text/Hakyll/Renderables.hs')

diff --git a/src/Text/Hakyll/Renderables.hs b/src/Text/Hakyll/Renderables.hs
index c7183a8..85b6fdd 100644
--- a/src/Text/Hakyll/Renderables.hs
+++ b/src/Text/Hakyll/Renderables.hs
@@ -1,6 +1,8 @@
 module Text.Hakyll.Renderables
     ( CustomPage
     , createCustomPage
+    , createListing
+    , createListingWith
     , PagePath
     , createPagePath
     , CombinedRenderable
@@ -9,11 +11,14 @@ module Text.Hakyll.Renderables
     ) where
 
 import qualified Data.Map as M
+import Control.Arrow (second)
 
 import Text.Hakyll.Hakyll (Hakyll)
 import Text.Hakyll.Page
 import Text.Hakyll.Renderable
 import Text.Hakyll.File
+import Text.Hakyll.Context
+import Text.Hakyll.Render
 
 -- | A custom page.
 data CustomPage = CustomPage 
@@ -35,6 +40,39 @@ createCustomPage :: String -- ^ Destination of the page, relative to _site.
                  -> CustomPage
 createCustomPage = CustomPage
 
+-- | A @createCustomPage@ function specialized in creating listings.
+--
+--   This function creates a listing of a certain list of @Renderable@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 :: (Renderable a)
+              => String -- ^ Destination of the page.
+              -> FilePath -- ^ Template to render all items with.
+              -> [a] -- ^ Renderables in the list.
+              -> [(String, String)] -- ^ Additional context.
+              -> CustomPage
+createListing = createListingWith id
+
+-- | A @createCustomPage@ function specialized in creating listings.
+--
+--   In addition to @createListing@, this function allows you to specify an
+--   extra @ContextManipulation@ for all @Renderable@s given.
+createListingWith :: (Renderable a)
+                  => ContextManipulation -- ^ Manipulation for the renderables.
+                  -> String -- ^ Destination of the page.
+                  -> FilePath -- ^ Template to render all items with.
+                  -> [a] -- ^ Renderables in the list.
+                  -> [(String, String)] -- ^ Additional context.
+                  -> CustomPage
+createListingWith manipulation url template renderables additional =
+    createCustomPage url dependencies context
+  where
+    dependencies = template : concatMap getDependencies renderables
+    context = ("body", Right concatenation) : additional'
+    concatenation = renderAndConcatWith manipulation [template] renderables
+    additional' = map (second Left) additional
+
 instance Renderable CustomPage where
     getDependencies = customPageDependencies
     getURL = customPageURL
@@ -62,15 +100,15 @@ data CombinedRenderable a b = CombinedRenderable a b
                             | CombinedRenderableWithURL FilePath a b
 
 -- | Combine two renderables. The url will always be taken from the first
---   "Renderable". Also, if a `$key` is present in both renderables, the
---   value from the first "Renderable" will be taken as well.
+--   @Renderable@. Also, if a `$key` is present in both renderables, the
+--   value from the first @Renderable@ will be taken as well.
 --
 --   Since renderables are always more or less key-value maps, you can see
 --   this as a @union@ between two maps.
 combine :: (Renderable a, Renderable b) => a -> b -> CombinedRenderable a b
 combine = CombinedRenderable
 
--- | Combine two renderables and set a custom URL. This behaves like "combine",
+-- | Combine two renderables and set a custom URL. This behaves like @combine@,
 --   except that for the @url@ field, the given URL is always chosen.
 combineWithURL :: (Renderable a, Renderable b)
                => FilePath
-- 
cgit v1.2.3