Safe Haskell	None
Language	Haskell2010

Web.Sitemap.Gen

Contents

Sitemaps
Sitemap Indexes
Utilities

Description

The Web.Sitemap.Gen module contains types & rendering functions to generate XML compliant with the sitemaps.org specification.

For more information see https://www.sitemaps.org/protocol.html

Synopsis

newtype Sitemap = Sitemap {
- sitemapUrls :: [SitemapUrl]
}
renderSitemap :: XmlOutput x => Sitemap -> x
data SitemapUrl = SitemapUrl {
- sitemapLocation :: Text
- sitemapLastModified :: Maybe UTCTime
- sitemapChangeFrequency :: Maybe ChangeFrequency
- sitemapPriority :: Maybe Double
}
renderSitemapUrl :: SitemapUrl -> Xml Elem
data ChangeFrequency
- = Always
- | Hourly
- | Daily
- | Weekly
- | Monthly
- | Yearly
- | Never
renderChangeFrequency :: ChangeFrequency -> Xml Elem
newtype SitemapIndex = SitemapIndex {
- indexEntries :: [IndexEntry]
}
renderSitemapIndex :: XmlOutput x => SitemapIndex -> x
data IndexEntry = IndexEntry {
- indexLocation :: Text
- indexLastModified :: Maybe UTCTime
}
renderIndexEntry :: IndexEntry -> Xml Elem
sitemapNamespace :: Namespace
formatSitemapTime :: UTCTime -> Text
renderLastModified :: UTCTime -> Xml Elem

Sitemaps

newtype Sitemap Source #

A Sitemap contains multiple SitemapUrl elements which describe crawlable locations for search engines.

Constructors

Sitemap
Fields sitemapUrls :: [SitemapUrl]

Instances

Eq Sitemap Source #
Instance details Defined in Web.Sitemap.Gen Methods (==) :: Sitemap -> Sitemap -> Bool # (/=) :: Sitemap -> Sitemap -> Bool #
Read Sitemap Source #
Instance details Defined in Web.Sitemap.Gen Methods readsPrec :: Int -> ReadS Sitemap # readList :: ReadS [Sitemap] # readPrec :: ReadPrec Sitemap # readListPrec :: ReadPrec [Sitemap] #
Show Sitemap Source #
Instance details Defined in Web.Sitemap.Gen Methods showsPrec :: Int -> Sitemap -> ShowS # show :: Sitemap -> String # showList :: [Sitemap] -> ShowS #
Generic Sitemap Source #
Instance details Defined in Web.Sitemap.Gen Associated Types type Rep Sitemap :: Type -> Type # Methods from :: Sitemap -> Rep Sitemap x # to :: Rep Sitemap x -> Sitemap #
type Rep Sitemap Source #
Instance details Defined in Web.Sitemap.Gen type Rep Sitemap = D1 (MetaData "Sitemap" "Web.Sitemap.Gen" "sitemap-gen-0.1.0.0-38twZSkxbtk4P5or3XePQL" True) (C1 (MetaCons "Sitemap" PrefixI True) (S1 (MetaSel (Just "sitemapUrls") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [SitemapUrl])))

renderSitemap :: XmlOutput x => Sitemap -> x Source #

Render a Sitemap into a output format supported by the xmlgen package.

In most cases you will want to generate a ByteString.

data SitemapUrl Source #

A SitemapUrl describes a single URL in a Sitemap.

Constructors

SitemapUrl
Fields sitemapLocation :: Text The full URL of the page, including the protocol and domain name. sitemapLastModified :: Maybe UTCTime The time the page's content was last changed. sitemapChangeFrequency :: Maybe ChangeFrequency How often does the content at the URL change? sitemapPriority :: Maybe Double The relative priority of this URL compared to other URLs in the sitemap.

Instances

Eq SitemapUrl Source #
Instance details Defined in Web.Sitemap.Gen Methods (==) :: SitemapUrl -> SitemapUrl -> Bool # (/=) :: SitemapUrl -> SitemapUrl -> Bool #
Read SitemapUrl Source #
Instance details Defined in Web.Sitemap.Gen Methods readsPrec :: Int -> ReadS SitemapUrl # readList :: ReadS [SitemapUrl] # readPrec :: ReadPrec SitemapUrl # readListPrec :: ReadPrec [SitemapUrl] #
Show SitemapUrl Source #
Instance details Defined in Web.Sitemap.Gen Methods showsPrec :: Int -> SitemapUrl -> ShowS # show :: SitemapUrl -> String # showList :: [SitemapUrl] -> ShowS #
Generic SitemapUrl Source #
Instance details Defined in Web.Sitemap.Gen Associated Types type Rep SitemapUrl :: Type -> Type # Methods from :: SitemapUrl -> Rep SitemapUrl x # to :: Rep SitemapUrl x -> SitemapUrl #
type Rep SitemapUrl Source #
Instance details Defined in Web.Sitemap.Gen type Rep SitemapUrl = D1 (MetaData "SitemapUrl" "Web.Sitemap.Gen" "sitemap-gen-0.1.0.0-38twZSkxbtk4P5or3XePQL" False) (C1 (MetaCons "SitemapUrl" PrefixI True) ((S1 (MetaSel (Just "sitemapLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :: S1 (MetaSel (Just "sitemapLastModified") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime))) :: (S1 (MetaSel (Just "sitemapChangeFrequency") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ChangeFrequency)) :*: S1 (MetaSel (Just "sitemapPriority") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Double)))))

renderSitemapUrl :: SitemapUrl -> Xml Elem Source #

Render a SitemapUrl as a url XML element.

data ChangeFrequency Source #

Describes how often a SitemapUrl' is updated. This is considered a hint for crawlers and may or may not be respected.

Constructors

Always	The page changes every time it is visited.
Hourly
Daily
Weekly
Monthly
Yearly
Never	The page is archived and will never change from now on.

Instances

Bounded ChangeFrequency Source #
Instance details Defined in Web.Sitemap.Gen Methods minBound :: ChangeFrequency # maxBound :: ChangeFrequency #
Enum ChangeFrequency Source #
Instance details Defined in Web.Sitemap.Gen Methods succ :: ChangeFrequency -> ChangeFrequency # pred :: ChangeFrequency -> ChangeFrequency # toEnum :: Int -> ChangeFrequency # fromEnum :: ChangeFrequency -> Int # enumFrom :: ChangeFrequency -> [ChangeFrequency] # enumFromThen :: ChangeFrequency -> ChangeFrequency -> [ChangeFrequency] # enumFromTo :: ChangeFrequency -> ChangeFrequency -> [ChangeFrequency] # enumFromThenTo :: ChangeFrequency -> ChangeFrequency -> ChangeFrequency -> [ChangeFrequency] #
Eq ChangeFrequency Source #
Instance details Defined in Web.Sitemap.Gen Methods (==) :: ChangeFrequency -> ChangeFrequency -> Bool # (/=) :: ChangeFrequency -> ChangeFrequency -> Bool #
Read ChangeFrequency Source #
Instance details Defined in Web.Sitemap.Gen Methods readsPrec :: Int -> ReadS ChangeFrequency # readList :: ReadS [ChangeFrequency] # readPrec :: ReadPrec ChangeFrequency # readListPrec :: ReadPrec [ChangeFrequency] #
Show ChangeFrequency Source #
Instance details Defined in Web.Sitemap.Gen Methods showsPrec :: Int -> ChangeFrequency -> ShowS # show :: ChangeFrequency -> String # showList :: [ChangeFrequency] -> ShowS #
Generic ChangeFrequency Source #
Instance details Defined in Web.Sitemap.Gen Associated Types type Rep ChangeFrequency :: Type -> Type # Methods from :: ChangeFrequency -> Rep ChangeFrequency x # to :: Rep ChangeFrequency x -> ChangeFrequency #
type Rep ChangeFrequency Source #
Instance details Defined in Web.Sitemap.Gen type Rep ChangeFrequency = D1 (MetaData "ChangeFrequency" "Web.Sitemap.Gen" "sitemap-gen-0.1.0.0-38twZSkxbtk4P5or3XePQL" False) ((C1 (MetaCons "Always" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "Hourly" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Daily" PrefixI False) (U1 :: Type -> Type))) :+: ((C1 (MetaCons "Weekly" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Monthly" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Yearly" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Never" PrefixI False) (U1 :: Type -> Type))))

renderChangeFrequency :: ChangeFrequency -> Xml Elem Source #

Build the XML text content for a ChangeFrequency.

Sitemap Indexes

newtype SitemapIndex Source #

A SitemapIndex allows informing crawlers of multiple sitemap files hosted on the same domain.

See https://www.sitemaps.org/protocol.html#index

Constructors

SitemapIndex
Fields indexEntries :: [IndexEntry]

Instances

Eq SitemapIndex Source #
Instance details Defined in Web.Sitemap.Gen Methods (==) :: SitemapIndex -> SitemapIndex -> Bool # (/=) :: SitemapIndex -> SitemapIndex -> Bool #
Read SitemapIndex Source #
Instance details Defined in Web.Sitemap.Gen Methods readsPrec :: Int -> ReadS SitemapIndex # readList :: ReadS [SitemapIndex] # readPrec :: ReadPrec SitemapIndex # readListPrec :: ReadPrec [SitemapIndex] #
Show SitemapIndex Source #
Instance details Defined in Web.Sitemap.Gen Methods showsPrec :: Int -> SitemapIndex -> ShowS # show :: SitemapIndex -> String # showList :: [SitemapIndex] -> ShowS #
Generic SitemapIndex Source #
Instance details Defined in Web.Sitemap.Gen Associated Types type Rep SitemapIndex :: Type -> Type # Methods from :: SitemapIndex -> Rep SitemapIndex x # to :: Rep SitemapIndex x -> SitemapIndex #
type Rep SitemapIndex Source #
Instance details Defined in Web.Sitemap.Gen type Rep SitemapIndex = D1 (MetaData "SitemapIndex" "Web.Sitemap.Gen" "sitemap-gen-0.1.0.0-38twZSkxbtk4P5or3XePQL" True) (C1 (MetaCons "SitemapIndex" PrefixI True) (S1 (MetaSel (Just "indexEntries") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [IndexEntry])))

renderSitemapIndex :: XmlOutput x => SitemapIndex -> x Source #

Render a SitemapIndex into an output format supported by the xmlgen package.

data IndexEntry Source #

A single sitemap entry for a sitemap index.

Constructors

IndexEntry
Fields indexLocation :: Text The Full URL of a Sitemap, including the protocol. E.g., `https://www.southernexposure.com/sitemap.xml` indexLastModified :: Maybe UTCTime The time the sitemap was last changed.

Instances

Eq IndexEntry Source #
Instance details Defined in Web.Sitemap.Gen Methods (==) :: IndexEntry -> IndexEntry -> Bool # (/=) :: IndexEntry -> IndexEntry -> Bool #
Read IndexEntry Source #
Instance details Defined in Web.Sitemap.Gen Methods readsPrec :: Int -> ReadS IndexEntry # readList :: ReadS [IndexEntry] # readPrec :: ReadPrec IndexEntry # readListPrec :: ReadPrec [IndexEntry] #
Show IndexEntry Source #
Instance details Defined in Web.Sitemap.Gen Methods showsPrec :: Int -> IndexEntry -> ShowS # show :: IndexEntry -> String # showList :: [IndexEntry] -> ShowS #
Generic IndexEntry Source #
Instance details Defined in Web.Sitemap.Gen Associated Types type Rep IndexEntry :: Type -> Type # Methods from :: IndexEntry -> Rep IndexEntry x # to :: Rep IndexEntry x -> IndexEntry #
type Rep IndexEntry Source #
Instance details Defined in Web.Sitemap.Gen type Rep IndexEntry = D1 (MetaData "IndexEntry" "Web.Sitemap.Gen" "sitemap-gen-0.1.0.0-38twZSkxbtk4P5or3XePQL" False) (C1 (MetaCons "IndexEntry" PrefixI True) (S1 (MetaSel (Just "indexLocation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "indexLastModified") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime))))

renderIndexEntry :: IndexEntry -> Xml Elem Source #

Render an IndexEntry as a sitemap element.

Utilities

sitemapNamespace :: Namespace Source #

An XML Namespace for the sitemaps.org v0.9 schema.

formatSitemapTime :: UTCTime -> Text Source #

Render the UTCTime in YYYY-MM-DDTHH:MM:SS+00:00 format.

renderLastModified :: UTCTime -> Xml Elem Source #

Render a UTCTime in a lastmod element.