Safe Haskell	Safe-Inferred
Language	Haskell2010

Foundational.SettingsPage

Description

the defintion for a layout and a flags type which carry info from the command line and the siteHeader file the defaults for flags are set up for testing are overridden the defaults for layout must correspond to what is set in the test siteHeader file. layout defaults are used in testing

content dirs are those, which have *.md files

Synopsis

data SiteLayout = SiteLayout {
- themeDir :: Path Abs Dir
- doughDir :: Path Abs Dir
- bakedDir :: Path Abs Dir
- masterTemplateFile :: Path Rel File
- texTemplateFile :: Path Rel File
- doNotBake :: Text
- blogAuthorToSuppress :: [Text]
- defaultAuthor :: Text
- replaceErlaubtFile :: Path Abs File
}
data MenuItem = MenuItem {
- navlink :: FilePath
- navtext :: Text
}
newtype MenuItems = MenuItems {
- menuNav :: [MenuItem]
}
data SiteHeader = SiteHeader {
- sitename :: FilePath
- byline :: Text
- banner :: FilePath
- bannerCaption :: Text
}
data Settings = Settings {
- siteLayout :: SiteLayout
- localhostPort :: Int
- settingsAuthor :: Text
- settingsDate :: Text
- siteHeader :: SiteHeader
- menuitems :: MenuItems
}
progName :: Text
progTitle :: Text
settingsFileName :: Path Rel File
sourceDirTestDocs :: Path Abs Dir
sourceDirTestSite :: Path Abs Dir
layoutDefaults :: Path Abs Dir -> Path Abs Dir -> SiteLayout
resourcesName :: String
templatesName :: FilePath
themeName :: String
templatesDir :: SiteLayout -> Path Abs Dir
blankAuthorName :: [Text] -> Text -> Text
def :: Default a => a

Documentation

data SiteLayout Source #

Constructors

SiteLayout

Fields

themeDir :: Path Abs Dir
the place of the theme files (includes templates)
doughDir :: Path Abs Dir
where the content is originally (includes resources)
bakedDir :: Path Abs Dir
the webroot, the dir with all the produced files
masterTemplateFile :: Path Rel File
texTemplateFile :: Path Rel File
doNotBake :: Text
blogAuthorToSuppress :: [Text]
defaultAuthor :: Text
replaceErlaubtFile :: Path Abs File

Instances

Instances details

FromJSON SiteLayout Source #
Instance details Defined in Foundational.SettingsPage Methods parseJSON :: Value -> Parser SiteLayout # parseJSONList :: Value -> Parser [SiteLayout] #
ToJSON SiteLayout Source #
Instance details Defined in Foundational.SettingsPage Methods toJSON :: SiteLayout -> Value # toEncoding :: SiteLayout -> Encoding # toJSONList :: [SiteLayout] -> Value # toEncodingList :: [SiteLayout] -> Encoding #
Generic SiteLayout Source #
Instance details Defined in Foundational.SettingsPage Associated Types type Rep SiteLayout :: Type -> Type # Methods from :: SiteLayout -> Rep SiteLayout x # to :: Rep SiteLayout x -> SiteLayout #
Read SiteLayout Source #
Instance details Defined in Foundational.SettingsPage Methods readsPrec :: Int -> ReadS SiteLayout # readList :: ReadS [SiteLayout] # readPrec :: ReadPrec SiteLayout # readListPrec :: ReadPrec [SiteLayout] #
Show SiteLayout Source #
Instance details Defined in Foundational.SettingsPage Methods showsPrec :: Int -> SiteLayout -> ShowS # show :: SiteLayout -> String # showList :: [SiteLayout] -> ShowS #
Eq SiteLayout Source #
Instance details Defined in Foundational.SettingsPage Methods (==) :: SiteLayout -> SiteLayout -> Bool # (/=) :: SiteLayout -> SiteLayout -> Bool #
Ord SiteLayout Source #
Instance details Defined in Foundational.SettingsPage Methods compare :: SiteLayout -> SiteLayout -> Ordering # (<) :: SiteLayout -> SiteLayout -> Bool # (<=) :: SiteLayout -> SiteLayout -> Bool # (>) :: SiteLayout -> SiteLayout -> Bool # (>=) :: SiteLayout -> SiteLayout -> Bool # max :: SiteLayout -> SiteLayout -> SiteLayout # min :: SiteLayout -> SiteLayout -> SiteLayout #
Zeros SiteLayout Source #
Instance details Defined in Foundational.SettingsPage Methods zero :: SiteLayout # isZero :: SiteLayout -> Bool # notZero :: SiteLayout -> Bool #
type Rep SiteLayout Source #
Instance details Defined in Foundational.SettingsPage type Rep SiteLayout = D1 ('MetaData "SiteLayout" "Foundational.SettingsPage" "daino-0.1.5.2-BGWuqXC897kITybImSdur4" 'False) (C1 ('MetaCons "SiteLayout" 'PrefixI 'True) (((S1 ('MetaSel ('Just "themeDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Abs Dir)) :: S1 ('MetaSel ('Just "doughDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Abs Dir))) :: (S1 ('MetaSel ('Just "bakedDir") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Abs Dir)) :: S1 ('MetaSel ('Just "masterTemplateFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Rel File)))) :: ((S1 ('MetaSel ('Just "texTemplateFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Rel File)) :: S1 ('MetaSel ('Just "doNotBake") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "blogAuthorToSuppress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :: (S1 ('MetaSel ('Just "defaultAuthor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "replaceErlaubtFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Path Abs File)))))))

data MenuItem Source #

Constructors

MenuItem
Fields navlink :: FilePath navtext :: Text

Instances

Instances details

FromJSON MenuItem Source #
Instance details Defined in Foundational.SettingsPage Methods parseJSON :: Value -> Parser MenuItem # parseJSONList :: Value -> Parser [MenuItem] #
ToJSON MenuItem Source #
Instance details Defined in Foundational.SettingsPage Methods toJSON :: MenuItem -> Value # toEncoding :: MenuItem -> Encoding # toJSONList :: [MenuItem] -> Value # toEncodingList :: [MenuItem] -> Encoding #
Generic MenuItem Source #
Instance details Defined in Foundational.SettingsPage Associated Types type Rep MenuItem :: Type -> Type # Methods from :: MenuItem -> Rep MenuItem x # to :: Rep MenuItem x -> MenuItem #
Read MenuItem Source #
Instance details Defined in Foundational.SettingsPage Methods readsPrec :: Int -> ReadS MenuItem # readList :: ReadS [MenuItem] # readPrec :: ReadPrec MenuItem # readListPrec :: ReadPrec [MenuItem] #
Show MenuItem Source #
Instance details Defined in Foundational.SettingsPage Methods showsPrec :: Int -> MenuItem -> ShowS # show :: MenuItem -> String # showList :: [MenuItem] -> ShowS #
Eq MenuItem Source #
Instance details Defined in Foundational.SettingsPage Methods (==) :: MenuItem -> MenuItem -> Bool # (/=) :: MenuItem -> MenuItem -> Bool #
Ord MenuItem Source #
Instance details Defined in Foundational.SettingsPage Methods compare :: MenuItem -> MenuItem -> Ordering # (<) :: MenuItem -> MenuItem -> Bool # (<=) :: MenuItem -> MenuItem -> Bool # (>) :: MenuItem -> MenuItem -> Bool # (>=) :: MenuItem -> MenuItem -> Bool # max :: MenuItem -> MenuItem -> MenuItem # min :: MenuItem -> MenuItem -> MenuItem #
Zeros MenuItem Source #
Instance details Defined in Foundational.SettingsPage Methods zero :: MenuItem # isZero :: MenuItem -> Bool # notZero :: MenuItem -> Bool #
type Rep MenuItem Source #
Instance details Defined in Foundational.SettingsPage type Rep MenuItem = D1 ('MetaData "MenuItem" "Foundational.SettingsPage" "daino-0.1.5.2-BGWuqXC897kITybImSdur4" 'False) (C1 ('MetaCons "MenuItem" 'PrefixI 'True) (S1 ('MetaSel ('Just "navlink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "navtext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype MenuItems Source #

Constructors

MenuItems
Fields menuNav :: [MenuItem]

Instances

Instances details

FromJSON MenuItems Source #
Instance details Defined in Foundational.SettingsPage Methods parseJSON :: Value -> Parser MenuItems # parseJSONList :: Value -> Parser [MenuItems] #
ToJSON MenuItems Source #
Instance details Defined in Foundational.SettingsPage Methods toJSON :: MenuItems -> Value # toEncoding :: MenuItems -> Encoding # toJSONList :: [MenuItems] -> Value # toEncodingList :: [MenuItems] -> Encoding #
Generic MenuItems Source #
Instance details Defined in Foundational.SettingsPage Associated Types type Rep MenuItems :: Type -> Type # Methods from :: MenuItems -> Rep MenuItems x # to :: Rep MenuItems x -> MenuItems #
Read MenuItems Source #
Instance details Defined in Foundational.SettingsPage Methods readsPrec :: Int -> ReadS MenuItems # readList :: ReadS [MenuItems] # readPrec :: ReadPrec MenuItems # readListPrec :: ReadPrec [MenuItems] #
Show MenuItems Source #
Instance details Defined in Foundational.SettingsPage Methods showsPrec :: Int -> MenuItems -> ShowS # show :: MenuItems -> String # showList :: [MenuItems] -> ShowS #
Eq MenuItems Source #
Instance details Defined in Foundational.SettingsPage Methods (==) :: MenuItems -> MenuItems -> Bool # (/=) :: MenuItems -> MenuItems -> Bool #
Ord MenuItems Source #
Instance details Defined in Foundational.SettingsPage Methods compare :: MenuItems -> MenuItems -> Ordering # (<) :: MenuItems -> MenuItems -> Bool # (<=) :: MenuItems -> MenuItems -> Bool # (>) :: MenuItems -> MenuItems -> Bool # (>=) :: MenuItems -> MenuItems -> Bool # max :: MenuItems -> MenuItems -> MenuItems # min :: MenuItems -> MenuItems -> MenuItems #
Zeros MenuItems Source #
Instance details Defined in Foundational.SettingsPage Methods zero :: MenuItems # isZero :: MenuItems -> Bool # notZero :: MenuItems -> Bool #
type Rep MenuItems Source #
Instance details Defined in Foundational.SettingsPage type Rep MenuItems = D1 ('MetaData "MenuItems" "Foundational.SettingsPage" "daino-0.1.5.2-BGWuqXC897kITybImSdur4" 'True) (C1 ('MetaCons "MenuItems" 'PrefixI 'True) (S1 ('MetaSel ('Just "menuNav") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [MenuItem])))

data SiteHeader Source #

Constructors

SiteHeader
Fields sitename :: FilePath byline :: Text banner :: FilePath bannerCaption :: Text

Instances

Instances details

FromJSON SiteHeader Source #
Instance details Defined in Foundational.SettingsPage Methods parseJSON :: Value -> Parser SiteHeader # parseJSONList :: Value -> Parser [SiteHeader] #
ToJSON SiteHeader Source #
Instance details Defined in Foundational.SettingsPage Methods toJSON :: SiteHeader -> Value # toEncoding :: SiteHeader -> Encoding # toJSONList :: [SiteHeader] -> Value # toEncodingList :: [SiteHeader] -> Encoding #
Generic SiteHeader Source #
Instance details Defined in Foundational.SettingsPage Associated Types type Rep SiteHeader :: Type -> Type # Methods from :: SiteHeader -> Rep SiteHeader x # to :: Rep SiteHeader x -> SiteHeader #
Read SiteHeader Source #
Instance details Defined in Foundational.SettingsPage Methods readsPrec :: Int -> ReadS SiteHeader # readList :: ReadS [SiteHeader] # readPrec :: ReadPrec SiteHeader # readListPrec :: ReadPrec [SiteHeader] #
Show SiteHeader Source #
Instance details Defined in Foundational.SettingsPage Methods showsPrec :: Int -> SiteHeader -> ShowS # show :: SiteHeader -> String # showList :: [SiteHeader] -> ShowS #
Eq SiteHeader Source #
Instance details Defined in Foundational.SettingsPage Methods (==) :: SiteHeader -> SiteHeader -> Bool # (/=) :: SiteHeader -> SiteHeader -> Bool #
Ord SiteHeader Source #
Instance details Defined in Foundational.SettingsPage Methods compare :: SiteHeader -> SiteHeader -> Ordering # (<) :: SiteHeader -> SiteHeader -> Bool # (<=) :: SiteHeader -> SiteHeader -> Bool # (>) :: SiteHeader -> SiteHeader -> Bool # (>=) :: SiteHeader -> SiteHeader -> Bool # max :: SiteHeader -> SiteHeader -> SiteHeader # min :: SiteHeader -> SiteHeader -> SiteHeader #
Zeros SiteHeader Source #
Instance details Defined in Foundational.SettingsPage Methods zero :: SiteHeader # isZero :: SiteHeader -> Bool # notZero :: SiteHeader -> Bool #
type Rep SiteHeader Source #
Instance details Defined in Foundational.SettingsPage type Rep SiteHeader = D1 ('MetaData "SiteHeader" "Foundational.SettingsPage" "daino-0.1.5.2-BGWuqXC897kITybImSdur4" 'False) (C1 ('MetaCons "SiteHeader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sitename") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :: S1 ('MetaSel ('Just "byline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "banner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: S1 ('MetaSel ('Just "bannerCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data Settings Source #

the siteHeader file with all fields

Constructors

Settings
Fields siteLayout :: SiteLayout localhostPort :: Int settingsAuthor :: Text settingsDate :: Text siteHeader :: SiteHeader menuitems :: MenuItems

Instances

Instances details

FromJSON Settings Source #
Instance details Defined in Foundational.SettingsPage Methods parseJSON :: Value -> Parser Settings # parseJSONList :: Value -> Parser [Settings] #
ToJSON Settings Source #
Instance details Defined in Foundational.SettingsPage Methods toJSON :: Settings -> Value # toEncoding :: Settings -> Encoding # toJSONList :: [Settings] -> Value # toEncodingList :: [Settings] -> Encoding #
Generic Settings Source #
Instance details Defined in Foundational.SettingsPage Associated Types type Rep Settings :: Type -> Type # Methods from :: Settings -> Rep Settings x # to :: Rep Settings x -> Settings #
Read Settings Source #
Instance details Defined in Foundational.SettingsPage Methods readsPrec :: Int -> ReadS Settings # readList :: ReadS [Settings] # readPrec :: ReadPrec Settings # readListPrec :: ReadPrec [Settings] #
Show Settings Source #
Instance details Defined in Foundational.SettingsPage Methods showsPrec :: Int -> Settings -> ShowS # show :: Settings -> String # showList :: [Settings] -> ShowS #
Eq Settings Source #
Instance details Defined in Foundational.SettingsPage Methods (==) :: Settings -> Settings -> Bool # (/=) :: Settings -> Settings -> Bool #
Ord Settings Source #
Instance details Defined in Foundational.SettingsPage Methods compare :: Settings -> Settings -> Ordering # (<) :: Settings -> Settings -> Bool # (<=) :: Settings -> Settings -> Bool # (>) :: Settings -> Settings -> Bool # (>=) :: Settings -> Settings -> Bool # max :: Settings -> Settings -> Settings # min :: Settings -> Settings -> Settings #
Zeros Settings Source #
Instance details Defined in Foundational.SettingsPage Methods zero :: Settings # isZero :: Settings -> Bool # notZero :: Settings -> Bool #
type Rep Settings Source #
Instance details Defined in Foundational.SettingsPage type Rep Settings = D1 ('MetaData "Settings" "Foundational.SettingsPage" "daino-0.1.5.2-BGWuqXC897kITybImSdur4" 'False) (C1 ('MetaCons "Settings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "siteLayout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SiteLayout) :: (S1 ('MetaSel ('Just "localhostPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "settingsAuthor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :: (S1 ('MetaSel ('Just "settingsDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "siteHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SiteHeader) :*: S1 ('MetaSel ('Just "menuitems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MenuItems)))))

progName :: Text Source #

progTitle :: Text Source #

settingsFileName :: Path Rel File Source #

the yaml file in which the siteHeader are fixec

sourceDirTestDocs :: Path Abs Dir Source #

sourceDirTestSite :: Path Abs Dir Source #

the dir with the source for the test site

layoutDefaults :: Path Abs Dir -> Path Abs Dir -> SiteLayout Source #

resourcesName :: String Source #

templatesName :: FilePath Source #

themeName :: String Source #

templatesDir :: SiteLayout -> Path Abs Dir Source #

blankAuthorName :: [Text] -> Text -> Text Source #

def :: Default a => a #

The default value for this type.