-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Generate XML sitemaps.
--   
--   API docs and the README are available at
--   <a>http://www.stackage.org/package/yesod-sitemap</a>
@package yesod-sitemap
@version 1.6.0


-- | Generates XML sitemap files.
--   
--   See <a>http://www.sitemaps.org/</a>.
module Yesod.Sitemap

-- | Serve a stream of <tt>SitemapUrl</tt>s as a sitemap.
--   
--   Since 1.2.0
sitemap :: ConduitT () (SitemapUrl (Route site)) (HandlerFor site) () -> HandlerFor site TypedContent

-- | Convenience wrapper for <tt>sitemap</tt> for the case when the input
--   is an in-memory list.
--   
--   Since 1.2.0
sitemapList :: [SitemapUrl (Route site)] -> HandlerFor site TypedContent

-- | Convert a stream of <tt>SitemapUrl</tt>s to XML <tt>Event</tt>s using
--   the given URL renderer.
--   
--   This function is fully general for usage outside of Yesod.
--   
--   Since 1.2.0
sitemapConduit :: Monad m => (a -> Text) -> ConduitT (SitemapUrl a) Event m ()

-- | A basic robots file which just lists the "Sitemap: " line.
robots :: MonadHandler m => Route (HandlerSite m) -> m Text
data SitemapUrl url
SitemapUrl :: url -> Maybe UTCTime -> Maybe SitemapChangeFreq -> Maybe Double -> SitemapUrl url
[sitemapLoc] :: SitemapUrl url -> url
[sitemapLastMod] :: SitemapUrl url -> Maybe UTCTime
[sitemapChangeFreq] :: SitemapUrl url -> Maybe SitemapChangeFreq
[sitemapPriority] :: SitemapUrl url -> Maybe Double
data SitemapChangeFreq
Always :: SitemapChangeFreq
Hourly :: SitemapChangeFreq
Daily :: SitemapChangeFreq
Weekly :: SitemapChangeFreq
Monthly :: SitemapChangeFreq
Yearly :: SitemapChangeFreq
Never :: SitemapChangeFreq
