Safe Haskell	None
Language	Haskell2010

Text.OPML.Types

Contents

Top-level OPML structure
OPML header
OPML outlines
- Generic outlines
- Subscription outlines

Description

OPML is an XML format for outlines.

Example:

<opml version="2.0">
  <head>
    <title>OPML title</title>
    <dateCreated>Mon, 31 Oct 2005 19:23:00 GMT</dateCreated>
  </head>
  <body>
    <outline text="Outline 1" created="Mon, 31 Oct 2005 18:21:33 GMT"/>
    <outline text="Outline 2" created="Mon, 31 Oct 2005 18:21:33 GMT"/>
  </body>
</opml>

Synopsis

Top-level OPML structure

data Opml Source

Constructors

Opml
Fields opmlVersion :: Version opmlHead :: OpmlHead opmlOutlines :: Forest OpmlOutline

Instances

Eq Opml Source
Show Opml Source
Generic Opml Source
type Rep Opml Source

mkOpml :: Opml Source

Bare Opml. Version is set to 2.0.

OPML header

data OpmlHead Source

Constructors

OpmlHead
Fields opmlTitle :: Text opmlCreated :: Maybe UTCTime modified :: Maybe UTCTime ownerName :: Text ownerEmail :: Text ownerId :: Maybe URI docs :: Maybe URI expansionState :: [Int] vertScrollState :: Maybe Int windowBottom :: Maybe Int windowLeft :: Maybe Int windowRight :: Maybe Int windowTop :: Maybe Int

Instances

Eq OpmlHead Source
Show OpmlHead Source
Generic OpmlHead Source
type Rep OpmlHead Source

mkOpmlHead :: OpmlHead Source

Bare OpmlHead, all fields are set to mempty.

OPML outlines

data OpmlOutline Source

Outlines are the main payload of an OPML document.

Constructors

OpmlOutlineGeneric OutlineBase Text
OpmlOutlineLink OutlineBase URI
OpmlOutlineSubscription OutlineBase OutlineSubscription

Instances

Eq OpmlOutline Source
Show OpmlOutline Source
Generic OpmlOutline Source
type Rep OpmlOutline Source

Generic outlines

data OutlineBase Source

Constructors

OutlineBase
Fields text :: NonNull Text isComment :: Maybe Bool isBreakpoint :: Maybe Bool outlineCreated :: Maybe UTCTime categories :: [NonEmpty (NonNull Text)]

Instances

Eq OutlineBase Source
Show OutlineBase Source
Generic OutlineBase Source
type Rep OutlineBase Source

mkOutlineBase :: NonNull Text -> OutlineBase Source

Smart constructor for OutlineBase.

Subscription outlines

data OutlineSubscription Source

Constructors

OutlineSubscription
Fields xmlUri :: URI htmlUri :: Maybe URI description :: Text language :: Text subscriptionTitle :: Text subscriptionVersion :: Text

Instances

Eq OutlineSubscription Source
Show OutlineSubscription Source
Generic OutlineSubscription Source
type Rep OutlineSubscription Source

mkOutlineSubscription :: URI -> OutlineSubscription Source

Smart constructor for OutlineSubscription