cbaatz / atom-basic Goto Github PK

• "Strongly recommended that this module is imported qualified as Atom."
• Shorten the examples in the beginning - separate the feed creation from the XMLGen definition. Link to the full example on GitHub instead of showing to full examples in the Haddock.
• Explain up-front in the Haddock why we use the XMLGen record. Link to Ollie Charles' blogpost.
• "non-required" -> "optional"
• Make description more high-level and don't refer to specific function names probably.

http://www.ietf.org/rfc/rfc4287.txt

I created a feed using the xml example and it failed validation with this failure: https://validator.w3.org/feed/docs/error/MissingNamespace.html

It was pretty easy to fix:

atomNamespace :: Attr
atomNamespace = Attr
    { attrKey = QName
        { qName   = "xmlns"
        , qURI    = Nothing
        , qPrefix = Nothing
        }
    , attrVal = "http://www.w3.org/2005/Atom"
    }

And then having already created my feed as feedElement :: Element:

feedElement { elAttribs = atomNamespace:elAttribs feedElement }

But it might be good to change the library so it doesn't happen by default.

atomCommonAttributes =
attribute xml:base { atomUri }?,
attribute xml:lang { atomLanguageTag }?,