diff options
| author | Jasper Van der Jeugt <m@jaspervdj.be> | 2012-11-25 10:45:55 +0100 |
|---|---|---|
| committer | Jasper Van der Jeugt <m@jaspervdj.be> | 2012-11-25 10:45:55 +0100 |
| commit | 25b8c8b199082ebbc41d1af03fc19202b798f156 (patch) | |
| tree | 93fe71723ce3f7288b465037fb6c9a1198514e22 /src/Hakyll/Core/Identifier.hs | |
| parent | cae87891543babe1a0ec989546cfabcb451bd890 (diff) | |
| download | hakyll-25b8c8b199082ebbc41d1af03fc19202b798f156.tar.gz | |
A bit of cleanup
Diffstat (limited to 'src/Hakyll/Core/Identifier.hs')
| -rw-r--r-- | src/Hakyll/Core/Identifier.hs | 27 |
1 files changed, 2 insertions, 25 deletions
diff --git a/src/Hakyll/Core/Identifier.hs b/src/Hakyll/Core/Identifier.hs index 876d0fe..7ac06d8 100644 --- a/src/Hakyll/Core/Identifier.hs +++ b/src/Hakyll/Core/Identifier.hs @@ -1,34 +1,12 @@ -------------------------------------------------------------------------------- --- | An identifier is a type used to uniquely identify a resource, target... --- --- One can think of an identifier as something similar to a file path. An --- identifier is a path as well, with the different elements in the path --- separated by @/@ characters. Examples of identifiers are: +-- | An identifier is a type used to uniquely identify an item. An identifier is +-- conceptually similar to a file path. Examples of identifiers are: -- -- * @posts/foo.markdown@ -- -- * @index@ -- -- * @error/404@ --- --- The most important difference between an 'Identifier' and a file path is that --- the identifier for an item is not necesserily the file path. --- --- For example, we could have an @index@ identifier, generated by Hakyll. The --- actual file path would be @index.html@, but we identify it using @index@. --- --- @posts/foo.markdown@ could be an identifier of an item that is rendered to --- @posts/foo.html@. In this case, the identifier is the name of the source --- file of the page. --- --- An `Identifier` carries the type of the value it identifies. This basically --- means that an @Identifier (Page String)@ refers to a page. --- --- It is a phantom type parameter, meaning you can safely change this if you --- know what you are doing. You can change the type using the 'castIdentifier' --- function. --- --- If the @a@ type is not known, Hakyll traditionally uses @Identifier ()@. {-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE GeneralizedNewtypeDeriving #-} module Hakyll.Core.Identifier @@ -54,7 +32,6 @@ import GHC.Exts (IsString, fromString) -------------------------------------------------------------------------------- --- | An identifier used to uniquely identify a value data Identifier = Identifier { identifierVersion :: Maybe String , identifierPath :: String |