Safe Haskell	None
Language	GHC2024

MathiasSM.Content

Description

Typed views of the content files: posts (front matter) and projects (YAML)

Synopsis

data Language
- = En
- | Es
- | Jp
languageCode :: Language -> String
data Status
- = Alpha
- | Finished
- | Ongoing
- | Unmaintained
statusName :: Status -> String
data Post = Post {
- postTitle :: String
- postDate :: Day
- postPath :: FilePath
- postLanguage :: Language
- postLastModified :: Maybe Day
- postDraft :: Bool
}
data Project = Project {
- projectTitle :: String
- projectHref :: String
- projectStatus :: Status
- projectStart :: Day
- projectEnd :: Maybe Day
- projectShortDescription :: String
- projectLongDescription :: String
- projectTeam :: [String]
- projectPriority :: Maybe Int
}
data NavEntry = NavEntry {
- navLabel :: String
- navOrder :: Int
- navHref :: FilePath
- navLanguage :: Language
}
isDraft :: Metadata -> Bool
aliasesOf :: Metadata -> Either [String] [FilePath]
parseAliasesYaml :: String -> Either [String] [FilePath]
parsePost :: Metadata -> Either [String] Post
parsePostYaml :: String -> Either [String] Post
parseProject :: Object -> Either [String] Project
parseProjectYaml :: String -> Either [String] Project
parseNavEntry :: Metadata -> Either [String] (Maybe NavEntry)
parseNavYaml :: String -> Either [String] (Maybe NavEntry)
showcaseKey :: Project -> (Int, Down Day)
requirePost :: Compiler Post
requirePostOf :: Identifier -> Compiler Post
requireLanguage :: Identifier -> Compiler Language
requireNav :: Identifier -> Compiler (Maybe NavEntry)
requireProject :: Item String -> Compiler Project

Documentation

data Language #

Language a page is written in

Constructors

En
Es
Jp

Instances

Instances details

FromJSON Language #
Instance details Defined in MathiasSM.Content Methods parseJSON :: Value -> Parser Language parseJSONList :: Value -> Parser [Language] omittedField :: Maybe Language
Bounded Language #
Instance details Defined in MathiasSM.Content Methods minBound :: Language # maxBound :: Language #
Enum Language #
Instance details Defined in MathiasSM.Content Methods succ :: Language -> Language # pred :: Language -> Language # toEnum :: Int -> Language # fromEnum :: Language -> Int # enumFrom :: Language -> [Language] # enumFromThen :: Language -> Language -> [Language] # enumFromTo :: Language -> Language -> [Language] # enumFromThenTo :: Language -> Language -> Language -> [Language] #
Show Language #
Instance details Defined in MathiasSM.Content Methods showsPrec :: Int -> Language -> ShowS # show :: Language -> String # showList :: [Language] -> ShowS #
Eq Language #
Instance details Defined in MathiasSM.Content Methods (==) :: Language -> Language -> Bool # (/=) :: Language -> Language -> Bool #

languageCode :: Language -> String #

The code used in front matter and in lang attributes

data Status #

How far along a project is

Constructors

Alpha
Finished
Ongoing
Unmaintained

Instances

Instances details

FromJSON Status #
Instance details Defined in MathiasSM.Content Methods parseJSON :: Value -> Parser Status parseJSONList :: Value -> Parser [Status] omittedField :: Maybe Status
Bounded Status #
Instance details Defined in MathiasSM.Content Methods minBound :: Status # maxBound :: Status #
Enum Status #
Instance details Defined in MathiasSM.Content Methods succ :: Status -> Status # pred :: Status -> Status # toEnum :: Int -> Status # fromEnum :: Status -> Int # enumFrom :: Status -> [Status] # enumFromThen :: Status -> Status -> [Status] # enumFromTo :: Status -> Status -> [Status] # enumFromThenTo :: Status -> Status -> Status -> [Status] #
Show Status #
Instance details Defined in MathiasSM.Content Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #
Eq Status #
Instance details Defined in MathiasSM.Content Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #

statusName :: Status -> String #

data Post #

What a post (blog, creative-writing) needs to be published

Constructors

Post
Fields postTitle :: String postDate :: Day postPath :: FilePath postLanguage :: Language postLastModified :: Maybe Day postDraft :: Bool

Instances

Instances details

Show Post #
Instance details Defined in MathiasSM.Content Methods showsPrec :: Int -> Post -> ShowS # show :: Post -> String # showList :: [Post] -> ShowS #
Eq Post #
Instance details Defined in MathiasSM.Content Methods (==) :: Post -> Post -> Bool # (/=) :: Post -> Post -> Bool #

data Project #

What a showcase project needs to be listed

Constructors

Project
Fields projectTitle :: String projectHref :: String projectStatus :: Status projectStart :: Day projectEnd :: Maybe Day projectShortDescription :: String projectLongDescription :: String projectTeam :: [String] projectPriority :: Maybe Int

Instances

Instances details

Show Project #
Instance details Defined in MathiasSM.Content Methods showsPrec :: Int -> Project -> ShowS # show :: Project -> String # showList :: [Project] -> ShowS #
Eq Project #
Instance details Defined in MathiasSM.Content Methods (==) :: Project -> Project -> Bool # (/=) :: Project -> Project -> Bool #

data NavEntry #

A page that appears in the site menu (`nav: label`, `navOrder: n` in its front matter)

Constructors

NavEntry
Fields navLabel :: String What the menu link says; may contain HTML navOrder :: Int navHref :: FilePath The page's `path` navLanguage :: Language

Instances

Instances details

Show NavEntry #
Instance details Defined in MathiasSM.Content Methods showsPrec :: Int -> NavEntry -> ShowS # show :: NavEntry -> String # showList :: [NavEntry] -> ShowS #
Eq NavEntry #
Instance details Defined in MathiasSM.Content Methods (==) :: NavEntry -> NavEntry -> Bool # (/=) :: NavEntry -> NavEntry -> Bool #

isDraft :: Metadata -> Bool #

Whether an item is marked `draft: true`, and so left out of the site

aliasesOf :: Metadata -> Either [String] [FilePath] #

Old paths an item should redirect from (`aliases: [old]`, or a single `aliases: old`)

Each must be an absolute path other than the home page.

parseAliasesYaml :: String -> Either [String] [FilePath] #

aliasesOf on YAML text (the same shape as front matter)

parsePost :: Metadata -> Either [String] Post #

Parses front matter, reporting every problem (not just the first)

parsePostYaml :: String -> Either [String] Post #

parsePost on YAML text (the same shape as front matter)

parseProject :: Object -> Either [String] Project #

Parses a project, reporting every problem (not just the first)

parseProjectYaml :: String -> Either [String] Project #

parseProject on the contents of a project file

parseNavEntry :: Metadata -> Either [String] (Maybe NavEntry) #

The menu entry a page asks for, if it has a `nav:` label (it then also needs navOrder and path)

parseNavYaml :: String -> Either [String] (Maybe NavEntry) #

parseNavEntry on YAML text (the same shape as front matter)

showcaseKey :: Project -> (Int, Down Day) #

Sort key for the showcase: projects with a priority first (lowest number first), then the rest, newest start first

requirePost :: Compiler Post #

Parses the current item's front matter, failing the build with the problems found

requirePostOf :: Identifier -> Compiler Post #

Parses the front matter of any item, failing the build (naming it) with the problems found

requireLanguage :: Identifier -> Compiler Language #

The language of an item, failing the build if it's not a known one

requireNav :: Identifier -> Compiler (Maybe NavEntry) #

The menu entry of any page, failing the build (naming the page) if it's invalid

requireProject :: Item String -> Compiler Project #

Parses a project item (its body is the YAML), failing the build with the problems found