| License | AGPL-3 |
|---|---|
| Maintainer | stu235271@mail.uni-kiel.de stu236925@mail.uni-kiel.de |
| Safe Haskell | None |
| Language | Haskell2010 |
Docs.TextRevision
Description
This module contains definitions for revisions of TextElements.
Synopsis
- newtype TextRevisionID = TextRevisionID {}
- data TextRevisionSelector
- data TextRevision = TextRevision {
- header :: TextRevisionHeader
- content :: Text
- commentAnchors :: Vector CommentAnchor
- data TextRevisionHeader = TextRevisionHeader {}
- data TextElementRevision = TextElementRevision {}
- data ConflictStatus
- data TextRevisionHistory = TextRevisionHistory TextElementRef [TextRevisionHeader]
- data NewTextRevision = NewTextRevision {}
- data TextRevisionRef = TextRevisionRef TextElementRef TextRevisionSelector
- newtype DraftRevisionID = DraftRevisionID {}
- data DraftRevision = DraftRevision {}
- data DraftRevisionHeader = DraftRevisionHeader {}
- data Rendered a = Rendered {}
- contentsNotChanged :: TextRevision -> NewTextRevision -> Bool
- prettyPrintTextRevisionRef :: TextRevisionRef -> String
- textRevisionRef :: DocumentID -> TextElementID -> TextRevisionSelector -> TextRevisionRef
- specificTextRevision :: TextRevisionSelector -> Maybe TextRevisionID
- latestTextRevisionAsOf :: TextRevisionSelector -> Maybe UTCTime
Documentation
newtype TextRevisionID Source #
ID for a text revision
Constructors
| TextRevisionID | |
Fields | |
Instances
data TextRevisionSelector Source #
Selector for a text revision
Constructors
| Latest | |
| LatestAsOf UTCTime | |
| Specific TextRevisionID |
Instances
| FromJSON TextRevisionSelector Source # | |
Defined in Docs.TextRevision Methods parseJSON :: Value -> Parser TextRevisionSelector parseJSONList :: Value -> Parser [TextRevisionSelector] | |
| ToJSON TextRevisionSelector Source # | |
Defined in Docs.TextRevision Methods toJSON :: TextRevisionSelector -> Value toEncoding :: TextRevisionSelector -> Encoding toJSONList :: [TextRevisionSelector] -> Value toEncodingList :: [TextRevisionSelector] -> Encoding | |
| FromHttpApiData TextRevisionSelector Source # | |
Defined in Docs.TextRevision Methods parseUrlPiece :: Text -> Either Text TextRevisionSelector parseHeader :: ByteString -> Either Text TextRevisionSelector | |
| ToParamSchema TextRevisionSelector Source # | |
Defined in Docs.TextRevision Methods toParamSchema :: Proxy TextRevisionSelector -> Schema | |
| ToSchema TextRevisionSelector Source # | |
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy TextRevisionSelector -> Declare (Definitions Schema) NamedSchema | |
data TextRevision Source #
A text revision.
Constructors
| TextRevision | |
Fields
| |
Instances
data TextRevisionHeader Source #
Header of a text revision. Contains metadata for a text revision.
Constructors
| TextRevisionHeader | |
Fields
| |
Instances
| FromJSON TextRevisionHeader Source # | |||||
Defined in Docs.TextRevision Methods parseJSON :: Value -> Parser TextRevisionHeader parseJSONList :: Value -> Parser [TextRevisionHeader] | |||||
| ToJSON TextRevisionHeader Source # | |||||
Defined in Docs.TextRevision Methods toJSON :: TextRevisionHeader -> Value toEncoding :: TextRevisionHeader -> Encoding toJSONList :: [TextRevisionHeader] -> Value toEncodingList :: [TextRevisionHeader] -> Encoding omitField :: TextRevisionHeader -> Bool | |||||
| Generic TextRevisionHeader Source # | |||||
Defined in Docs.TextRevision Associated Types
Methods from :: TextRevisionHeader -> Rep TextRevisionHeader x # to :: Rep TextRevisionHeader x -> TextRevisionHeader # | |||||
| Show TextRevisionHeader Source # | |||||
Defined in Docs.TextRevision Methods showsPrec :: Int -> TextRevisionHeader -> ShowS # show :: TextRevisionHeader -> String # showList :: [TextRevisionHeader] -> ShowS # | |||||
| ToSchema TextRevisionHeader Source # | |||||
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy TextRevisionHeader -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep TextRevisionHeader Source # | |||||
Defined in Docs.TextRevision type Rep TextRevisionHeader = D1 ('MetaData "TextRevisionHeader" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextRevisionHeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionID) :*: (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "author") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserRef)))) | |||||
data TextElementRevision Source #
A text revision with the text element it belongs to.
Constructors
| TextElementRevision | |
Fields | |
Instances
| FromJSON TextElementRevision Source # | |||||
Defined in Docs.TextRevision Methods parseJSON :: Value -> Parser TextElementRevision parseJSONList :: Value -> Parser [TextElementRevision] | |||||
| ToJSON TextElementRevision Source # | |||||
Defined in Docs.TextRevision Methods toJSON :: TextElementRevision -> Value toEncoding :: TextElementRevision -> Encoding toJSONList :: [TextElementRevision] -> Value toEncodingList :: [TextElementRevision] -> Encoding omitField :: TextElementRevision -> Bool | |||||
| Renderable TextElementRevision Source # | |||||
Defined in Docs.Renderable Methods kindOf :: TextElementRevision -> KindName Source # typeOf :: TextElementRevision -> TypeName Source # contentOf :: TextElementRevision -> Text Source # | |||||
| Generic TextElementRevision Source # | |||||
Defined in Docs.TextRevision Associated Types
Methods from :: TextElementRevision -> Rep TextElementRevision x # to :: Rep TextElementRevision x -> TextElementRevision # | |||||
| ToSchema TextElementRevision Source # | |||||
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy TextElementRevision -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep TextElementRevision Source # | |||||
Defined in Docs.TextRevision type Rep TextElementRevision = D1 ('MetaData "TextElementRevision" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextElementRevision" 'PrefixI 'True) (S1 ('MetaSel ('Just "textElement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElement) :*: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe TextRevision)))) | |||||
data ConflictStatus Source #
A conflict with another text revision.
Constructors
| Conflict TextRevisionID | |
| NoConflict TextRevision | |
| DraftCreated DraftRevision TextRevisionID | created draft and conflicting revision ID |
Instances
| FromJSON ConflictStatus Source # | |
Defined in Docs.TextRevision | |
| ToJSON ConflictStatus Source # | |
Defined in Docs.TextRevision Methods toJSON :: ConflictStatus -> Value toEncoding :: ConflictStatus -> Encoding toJSONList :: [ConflictStatus] -> Value toEncodingList :: [ConflictStatus] -> Encoding omitField :: ConflictStatus -> Bool | |
| ToSchema ConflictStatus Source # | |
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy ConflictStatus -> Declare (Definitions Schema) NamedSchema | |
data TextRevisionHistory Source #
A sequence of revisions for a text element
Constructors
| TextRevisionHistory TextElementRef [TextRevisionHeader] |
Instances
| FromJSON TextRevisionHistory Source # | |
Defined in Docs.TextRevision Methods parseJSON :: Value -> Parser TextRevisionHistory parseJSONList :: Value -> Parser [TextRevisionHistory] | |
| ToJSON TextRevisionHistory Source # | |
Defined in Docs.TextRevision Methods toJSON :: TextRevisionHistory -> Value toEncoding :: TextRevisionHistory -> Encoding toJSONList :: [TextRevisionHistory] -> Value toEncodingList :: [TextRevisionHistory] -> Encoding omitField :: TextRevisionHistory -> Bool | |
| ToSchema TextRevisionHistory Source # | |
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy TextRevisionHistory -> Declare (Definitions Schema) NamedSchema | |
data NewTextRevision Source #
Information required to create a new text revision.
Constructors
| NewTextRevision | |
data TextRevisionRef Source #
A reference to a TextRevision
Constructors
| TextRevisionRef TextElementRef TextRevisionSelector |
Instances
| FromJSON TextRevisionRef Source # | |||||
Defined in Docs.TextRevision Methods parseJSON :: Value -> Parser TextRevisionRef parseJSONList :: Value -> Parser [TextRevisionRef] | |||||
| ToJSON TextRevisionRef Source # | |||||
Defined in Docs.TextRevision Methods toJSON :: TextRevisionRef -> Value toEncoding :: TextRevisionRef -> Encoding toJSONList :: [TextRevisionRef] -> Value toEncodingList :: [TextRevisionRef] -> Encoding omitField :: TextRevisionRef -> Bool | |||||
| Generic TextRevisionRef Source # | |||||
Defined in Docs.TextRevision Associated Types
Methods from :: TextRevisionRef -> Rep TextRevisionRef x # to :: Rep TextRevisionRef x -> TextRevisionRef # | |||||
| ToSchema TextRevisionRef Source # | |||||
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy TextRevisionRef -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep TextRevisionRef Source # | |||||
Defined in Docs.TextRevision type Rep TextRevisionRef = D1 ('MetaData "TextRevisionRef" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "TextRevisionRef" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextElementRef) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionSelector))) | |||||
newtype DraftRevisionID Source #
ID for a draft text revision
Constructors
| DraftRevisionID | |
Fields | |
Instances
| FromJSON DraftRevisionID Source # | |
Defined in Docs.TextRevision Methods parseJSON :: Value -> Parser DraftRevisionID parseJSONList :: Value -> Parser [DraftRevisionID] | |
| ToJSON DraftRevisionID Source # | |
Defined in Docs.TextRevision Methods toJSON :: DraftRevisionID -> Value toEncoding :: DraftRevisionID -> Encoding toJSONList :: [DraftRevisionID] -> Value toEncodingList :: [DraftRevisionID] -> Encoding omitField :: DraftRevisionID -> Bool | |
| Show DraftRevisionID Source # | |
Defined in Docs.TextRevision Methods showsPrec :: Int -> DraftRevisionID -> ShowS # show :: DraftRevisionID -> String # showList :: [DraftRevisionID] -> ShowS # | |
| Eq DraftRevisionID Source # | |
Defined in Docs.TextRevision Methods (==) :: DraftRevisionID -> DraftRevisionID -> Bool # (/=) :: DraftRevisionID -> DraftRevisionID -> Bool # | |
| Ord DraftRevisionID Source # | |
Defined in Docs.TextRevision Methods compare :: DraftRevisionID -> DraftRevisionID -> Ordering # (<) :: DraftRevisionID -> DraftRevisionID -> Bool # (<=) :: DraftRevisionID -> DraftRevisionID -> Bool # (>) :: DraftRevisionID -> DraftRevisionID -> Bool # (>=) :: DraftRevisionID -> DraftRevisionID -> Bool # max :: DraftRevisionID -> DraftRevisionID -> DraftRevisionID # min :: DraftRevisionID -> DraftRevisionID -> DraftRevisionID # | |
| ToSchema DraftRevisionID Source # | |
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy DraftRevisionID -> Declare (Definitions Schema) NamedSchema | |
data DraftRevision Source #
A draft text revision.
Constructors
| DraftRevision | |
Fields
| |
Instances
| FromJSON DraftRevision Source # | |||||
Defined in Docs.TextRevision | |||||
| ToJSON DraftRevision Source # | |||||
Defined in Docs.TextRevision Methods toJSON :: DraftRevision -> Value toEncoding :: DraftRevision -> Encoding toJSONList :: [DraftRevision] -> Value toEncodingList :: [DraftRevision] -> Encoding omitField :: DraftRevision -> Bool | |||||
| Generic DraftRevision Source # | |||||
Defined in Docs.TextRevision Associated Types
| |||||
| ToSchema DraftRevision Source # | |||||
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy DraftRevision -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep DraftRevision Source # | |||||
Defined in Docs.TextRevision type Rep DraftRevision = D1 ('MetaData "DraftRevision" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "DraftRevision" 'PrefixI 'True) (S1 ('MetaSel ('Just "draftHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DraftRevisionHeader) :*: (S1 ('MetaSel ('Just "draftContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "draftCommentAnchors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector CommentAnchor))))) | |||||
data DraftRevisionHeader Source #
Header of a draft text revision.
Constructors
| DraftRevisionHeader | |
Instances
| FromJSON DraftRevisionHeader Source # | |||||
Defined in Docs.TextRevision Methods parseJSON :: Value -> Parser DraftRevisionHeader parseJSONList :: Value -> Parser [DraftRevisionHeader] | |||||
| ToJSON DraftRevisionHeader Source # | |||||
Defined in Docs.TextRevision Methods toJSON :: DraftRevisionHeader -> Value toEncoding :: DraftRevisionHeader -> Encoding toJSONList :: [DraftRevisionHeader] -> Value toEncodingList :: [DraftRevisionHeader] -> Encoding omitField :: DraftRevisionHeader -> Bool | |||||
| Generic DraftRevisionHeader Source # | |||||
Defined in Docs.TextRevision Associated Types
Methods from :: DraftRevisionHeader -> Rep DraftRevisionHeader x # to :: Rep DraftRevisionHeader x -> DraftRevisionHeader # | |||||
| Show DraftRevisionHeader Source # | |||||
Defined in Docs.TextRevision Methods showsPrec :: Int -> DraftRevisionHeader -> ShowS # show :: DraftRevisionHeader -> String # showList :: [DraftRevisionHeader] -> ShowS # | |||||
| ToSchema DraftRevisionHeader Source # | |||||
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy DraftRevisionHeader -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep DraftRevisionHeader Source # | |||||
Defined in Docs.TextRevision type Rep DraftRevisionHeader = D1 ('MetaData "DraftRevisionHeader" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "DraftRevisionHeader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "draftIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DraftRevisionID) :*: S1 ('MetaSel ('Just "basedOnRevision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TextRevisionID)) :*: (S1 ('MetaSel ('Just "creationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: (S1 ('MetaSel ('Just "lastUpdatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "draftAuthor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserRef))))) | |||||
A element together with its rendered html representation.
Constructors
| Rendered | |
Instances
| FromJSON a => FromJSON (Rendered a) Source # | |||||
Defined in Docs.TextRevision Methods parseJSON :: Value -> Parser (Rendered a) parseJSONList :: Value -> Parser [Rendered a] omittedField :: Maybe (Rendered a) | |||||
| ToJSON a => ToJSON (Rendered a) Source # | |||||
Defined in Docs.TextRevision Methods toEncoding :: Rendered a -> Encoding toJSONList :: [Rendered a] -> Value toEncodingList :: [Rendered a] -> Encoding | |||||
| Generic (Rendered a) Source # | |||||
Defined in Docs.TextRevision Associated Types
| |||||
| ToSchema a => ToSchema (Rendered a) Source # | |||||
Defined in Docs.TextRevision Methods declareNamedSchema :: Proxy (Rendered a) -> Declare (Definitions Schema) NamedSchema | |||||
| type Rep (Rendered a) Source # | |||||
Defined in Docs.TextRevision type Rep (Rendered a) = D1 ('MetaData "Rendered" "Docs.TextRevision" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "Rendered" 'PrefixI 'True) (S1 ('MetaSel ('Just "element") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: S1 ('MetaSel ('Just "html") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) | |||||
contentsNotChanged :: TextRevision -> NewTextRevision -> Bool Source #
Check if a new revisions contents changed from an existing one.
prettyPrintTextRevisionRef :: TextRevisionRef -> String Source #
Ein Schmackofatz für die Augen
textRevisionRef :: DocumentID -> TextElementID -> TextRevisionSelector -> TextRevisionRef Source #
Constructor for a TextRevisionRef