summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJasper Van der Jeugt <m@jaspervdj.be>2012-12-15 18:02:47 +0100
committerJasper Van der Jeugt <m@jaspervdj.be>2012-12-15 18:02:47 +0100
commite633df17dd72703a541c46d829096dfe40b75e50 (patch)
treec8514b0a05fed2e0e359d479c934cbd9ae504abf
parent3f42c9cd6f45bb306d622f3ffa175e2a8b0910e1 (diff)
downloadhakyll-e633df17dd72703a541c46d829096dfe40b75e50.tar.gz
Rename pageCompiler to pandocCompiler
-rw-r--r--data/example/site.hs4
-rw-r--r--hakyll.cabal1
-rw-r--r--src/Hakyll.hs2
-rw-r--r--src/Hakyll/Web/Page.hs92
-rw-r--r--src/Hakyll/Web/Pandoc.hs35
-rw-r--r--tests/Hakyll/Core/Rules/Tests.hs4
-rw-r--r--tests/Hakyll/Web/Template/Tests.hs4
-rw-r--r--web/tutorials/04-arrows.markdown (renamed from web/tutorials/03-arrows.markdown)0
-rw-r--r--web/tutorials/05-guide.markdown (renamed from web/tutorials/04-guide.markdown)0
9 files changed, 40 insertions, 102 deletions
diff --git a/data/example/site.hs b/data/example/site.hs
index 60369ed..82a9f3e 100644
--- a/data/example/site.hs
+++ b/data/example/site.hs
@@ -18,14 +18,14 @@ main = hakyll $ do
match (fromList ["about.rst", "contact.markdown"]) $ do
route $ setExtension "html"
- compile $ pageCompiler
+ compile $ pandocCompiler
>>= loadAndApplyTemplate "templates/default.html" defaultContext
>>= relativizeUrls
match "posts/*" $ do
route $ setExtension "html"
compile $ do
- post <- pageCompiler
+ post <- pandocCompiler
saveSnapshot "content" post
return post
>>= loadAndApplyTemplate "templates/post.html" postCtx
diff --git a/hakyll.cabal b/hakyll.cabal
index a4bbe18..055bb34 100644
--- a/hakyll.cabal
+++ b/hakyll.cabal
@@ -126,7 +126,6 @@ Library
Hakyll.Main
Hakyll.Web.CompressCss
Hakyll.Web.Feed
- Hakyll.Web.Page
Hakyll.Web.Pandoc
Hakyll.Web.Pandoc.Biblio
Hakyll.Web.Pandoc.FileType
diff --git a/src/Hakyll.hs b/src/Hakyll.hs
index 0deca0f..12f14bb 100644
--- a/src/Hakyll.hs
+++ b/src/Hakyll.hs
@@ -20,7 +20,6 @@ module Hakyll
, module Hakyll.Main
, module Hakyll.Web.CompressCss
, module Hakyll.Web.Feed
- , module Hakyll.Web.Page
, module Hakyll.Web.Pandoc
, module Hakyll.Web.Pandoc.Biblio
, module Hakyll.Web.Pandoc.FileType
@@ -52,7 +51,6 @@ import Hakyll.Core.Writable.CopyFile
import Hakyll.Main
import Hakyll.Web.CompressCss
import Hakyll.Web.Feed
-import Hakyll.Web.Page
import Hakyll.Web.Pandoc
import Hakyll.Web.Pandoc.Biblio
import Hakyll.Web.Pandoc.FileType
diff --git a/src/Hakyll/Web/Page.hs b/src/Hakyll/Web/Page.hs
deleted file mode 100644
index f58f948..0000000
--- a/src/Hakyll/Web/Page.hs
+++ /dev/null
@@ -1,92 +0,0 @@
---------------------------------------------------------------------------------
--- | A page is a key-value mapping, representing a page on your site
---
--- A page is an important concept in Hakyll. It is a key-value mapping, and has
--- one field with an arbitrary type. A 'Page' thus consists of
---
--- * metadata (of the type @Map String String@);
---
--- * the actual value (of the type @a@).
---
--- Usually, the value will be a 'String' as well, and the value will be the body
--- of the page.
---
--- However, this is certainly no restriction. For example, @Page ByteString@
--- could be used to represent a binary item (e.g. an image) and some metadata.
---
--- Pages can be constructed using Haskell, but they are usually parsed from a
--- file. The file format for pages is pretty straightforward.
---
--- > This is a simple page
--- > consisting of two lines.
---
--- This is a valid page with two lines. If we load this in Hakyll, there would
--- be no metadata, and the body would be the given text. Let's look at a page
--- with some metadata:
---
--- > ---
--- > title: Alice's Adventures in Wonderland
--- > author: Lewis Caroll
--- > year: 1865
--- > ---
--- >
--- > Chapter I
--- > =========
--- >
--- > Down the Rabbit-Hole
--- > --------------------
--- >
--- > Alice was beginning to get very tired of sitting by her sister on the bank,
--- > and of having nothing to do: once or twice she had peeped into the book her
--- > sister was reading, but it had no pictures or conversations in it, "and
--- > what is the use of a book," thought Alice "without pictures or
--- > conversation?"
--- >
--- > ...
---
--- As you can see, we construct a metadata header in Hakyll using @---@. Then,
--- we simply list all @key: value@ pairs, and end with @---@ again. This page
--- contains three metadata fields and a body. The body is given in markdown
--- format, which can be easily rendered to HTML by Hakyll, using pandoc.
-module Hakyll.Web.Page
- ( pageCompiler
- , pageCompilerWith
- , pageCompilerWithPandoc
- ) where
-
-
---------------------------------------------------------------------------------
-import Control.Applicative ((<$>))
-import Text.Pandoc (Pandoc, ParserState, WriterOptions)
-
-
---------------------------------------------------------------------------------
-import Hakyll.Core.Compiler
-import Hakyll.Core.Item
-import Hakyll.Web.Pandoc
-
-
---------------------------------------------------------------------------------
--- | Read a page render using pandoc
-pageCompiler :: Compiler (Item String)
-pageCompiler =
- pageCompilerWith defaultHakyllParserState defaultHakyllWriterOptions
-
-
---------------------------------------------------------------------------------
--- | A version of 'pageCompiler' which allows you to specify your own pandoc
--- options
-pageCompilerWith :: ParserState -> WriterOptions -> Compiler (Item String)
-pageCompilerWith state options = pageCompilerWithPandoc state options id
-
-
---------------------------------------------------------------------------------
--- | An extension of 'pageCompilerWith' which allows you to specify a custom
--- pandoc transformation for the content
-pageCompilerWithPandoc :: ParserState -> WriterOptions
- -> (Pandoc -> Pandoc)
- -> Compiler (Item String)
-pageCompilerWithPandoc state options f = cached cacheName $
- writePandocWith options . fmap f . readPandocWith state <$> getResourceBody
- where
- cacheName = "Hakyll.Web.Page.pageCompilerWithPandoc"
diff --git a/src/Hakyll/Web/Pandoc.hs b/src/Hakyll/Web/Pandoc.hs
index c2319dc..82784be 100644
--- a/src/Hakyll/Web/Pandoc.hs
+++ b/src/Hakyll/Web/Pandoc.hs
@@ -1,5 +1,5 @@
--------------------------------------------------------------------------------
--- | Module exporting convenientpandoc bindings
+-- | Module exporting convenient pandoc bindings
module Hakyll.Web.Pandoc
( -- * The basic building blocks
readPandoc
@@ -9,6 +9,11 @@ module Hakyll.Web.Pandoc
, renderPandoc
, renderPandocWith
+ -- * Derived compilers
+ , pandocCompiler
+ , pandocCompilerWith
+ , pandocCompilerWithTransform
+
-- * Default options
, defaultHakyllParserState
, defaultHakyllWriterOptions
@@ -16,10 +21,12 @@ module Hakyll.Web.Pandoc
--------------------------------------------------------------------------------
+import Control.Applicative ((<$>))
import Text.Pandoc
--------------------------------------------------------------------------------
+import Hakyll.Core.Compiler
import Hakyll.Core.Item
import Hakyll.Web.Pandoc.FileType
@@ -79,6 +86,32 @@ renderPandocWith state options = writePandocWith options . readPandocWith state
--------------------------------------------------------------------------------
+-- | Read a page render using pandoc
+pandocCompiler :: Compiler (Item String)
+pandocCompiler =
+ pandocCompilerWith defaultHakyllParserState defaultHakyllWriterOptions
+
+
+--------------------------------------------------------------------------------
+-- | A version of 'pandocCompiler' which allows you to specify your own pandoc
+-- options
+pandocCompilerWith :: ParserState -> WriterOptions -> Compiler (Item String)
+pandocCompilerWith state options = pandocCompilerWithTransform state options id
+
+
+--------------------------------------------------------------------------------
+-- | An extension of 'pandocCompilerWith' which allows you to specify a custom
+-- pandoc transformation for the content
+pandocCompilerWithTransform :: ParserState -> WriterOptions
+ -> (Pandoc -> Pandoc)
+ -> Compiler (Item String)
+pandocCompilerWithTransform state options f = cached cacheName $
+ writePandocWith options . fmap f . readPandocWith state <$> getResourceBody
+ where
+ cacheName = "Hakyll.Web.Page.pageCompilerWithPandoc"
+
+
+--------------------------------------------------------------------------------
-- | The default reader options for pandoc parsing in hakyll
defaultHakyllParserState :: ParserState
defaultHakyllParserState = defaultParserState
diff --git a/tests/Hakyll/Core/Rules/Tests.hs b/tests/Hakyll/Core/Rules/Tests.hs
index 4fcb19d..27440dc 100644
--- a/tests/Hakyll/Core/Rules/Tests.hs
+++ b/tests/Hakyll/Core/Rules/Tests.hs
@@ -20,7 +20,7 @@ import Hakyll.Core.Routes
import Hakyll.Core.Rules
import Hakyll.Core.Rules.Internal
import Hakyll.Core.Writable.CopyFile
-import Hakyll.Web.Page
+import Hakyll.Web.Pandoc
import TestSuite.Util
@@ -61,7 +61,7 @@ rules = do
-- Compile some posts
match "*.md" $ do
route $ setExtension "html"
- compile pageCompiler
+ compile pandocCompiler
-- Compile them, raw
match "*.md" $ version "raw" $ do
diff --git a/tests/Hakyll/Web/Template/Tests.hs b/tests/Hakyll/Web/Template/Tests.hs
index 4e49d1f..6c5c77a 100644
--- a/tests/Hakyll/Web/Template/Tests.hs
+++ b/tests/Hakyll/Web/Template/Tests.hs
@@ -15,7 +15,7 @@ import Test.HUnit (Assertion, (@=?))
--------------------------------------------------------------------------------
import Hakyll.Core.Item
import Hakyll.Core.Provider
-import Hakyll.Web.Page
+import Hakyll.Web.Pandoc
import Hakyll.Web.Template
import Hakyll.Web.Template.Context
import TestSuite.Util
@@ -36,7 +36,7 @@ case01 = withTestStore $ \store -> do
out <- resourceString provider "template.html.out"
tpl <- testCompilerDone store provider "template.html" $ templateCompiler
item <- testCompilerDone store provider "example.md" $
- pageCompiler >>= applyTemplate (itemBody tpl) testContext
+ pandocCompiler >>= applyTemplate (itemBody tpl) testContext
out @=? itemBody item
diff --git a/web/tutorials/03-arrows.markdown b/web/tutorials/04-arrows.markdown
index 3f2e244..3f2e244 100644
--- a/web/tutorials/03-arrows.markdown
+++ b/web/tutorials/04-arrows.markdown
diff --git a/web/tutorials/04-guide.markdown b/web/tutorials/05-guide.markdown
index e8c5800..e8c5800 100644
--- a/web/tutorials/04-guide.markdown
+++ b/web/tutorials/05-guide.markdown