diff --git a/figures/class-diagram.svg b/figures/class-diagram.svg index 4ba6e62..1edd084 100644 --- a/figures/class-diagram.svg +++ b/figures/class-diagram.svg @@ -1,399 +1,390 @@ -DAPT ScriptWorkflow TypeScript TypePrimary LanguageScript EventScript Event Identifier(optional) Begin(optional) End(optional) Duration(optional) Script Event Type(optional) Script Event Description(optional) On ScreenTextText contentText Language Source(optional) LanguageAudioSynthesized AudioRate(optional) PitchAudio RecordingSource [ ]Type [ ](optional) Begin(optional) End(optional) Duration(optional) In Time(optional) Out TimeCharacterCharacter IdentifierName(optional) Talent NameStyleStyle Identifier(optional) Character IdentifierStyle AttributesMixing Instruction(optional) Gain(optional) Pan(optional) Begin(optional) End(optional) Duration(optional) Fillcontains0..*contains 0..*contains0..*CharacterStyle0..10..*CharacterStyle0..*0..*contains0..*CharacterStyle0..*0..*OtherStyle0..*0..*contains0..*contains0..*contains0..*0..*0..*contains0..*isis \ No newline at end of file + + + + + + + + DAPT Script + + Workflow Type + Script Type + Primary Language + + + + + Character + + Character Identifier + Name + (optional) Talent Name + + + + + Script Event + + Script Event Identifier + (optional) Begin + (optional) End + (optional) Duration + (optional) Script Event + Type + (optional) Script Event Description + (optional) On Screen + + + + + Script Event Description + + Description + (optional) Description + Type + (optional) Language + + + + + Text + + Text content + Text Language Source + (optional) Language + + + + + Audio + + + + + Synthesized Audio + + Rate + (optional) Pitch + + + + + Audio Recording + + Source [ ] + Type [ ] + (optional) Begin + (optional) End + (optional) Duration + (optional) In Time + (optional) Out Time + + + + + Mixing Instruction + + (optional) Gain + (optional) Pan + (optional) Begin + (optional) End + (optional) Duration + (optional) Fill + + + + + + contains + +   + 0..* + + + + + + + contains + 0..* + + + + + + contains + +   + 0..* + + + + + + contains + +   + 0..* + + + + + + contains + +   + 0..* + + + + + + 0..* + 0..* + + + + + + + + contains + +   + 0..* + + + + + + contains + +   + 0..* + + + + + + + contains + 0..* + + + + + + is + +   + + + + + + is + +   + + + + + + + diff --git a/figures/sources/class-diagram.puml b/figures/sources/class-diagram.puml index bd1ee61..84b297a 100644 --- a/figures/sources/class-diagram.puml +++ b/figures/sources/class-diagram.puml @@ -1,22 +1,28 @@ @startuml class-diagram !theme plain -!pragma ratio 1.3 -skinparam groupInheritance 2 +!pragma ratio 1 +' skinparam groupInheritance 2 skinparam linetype ortho skinparam DefaultFontName sans-serif skinparam DefaultFontSize 16 skinparam ArrowFontSize 13 skinparam ArrowMessageAlignment direction skinparam Padding 4 -skinparam Nodesep 15 -skinparam Ranksep 20 +skinparam Nodesep 70 +skinparam Ranksep 80 skinparam MinClassWidth 220 +Class DAPTScript as "**DAPT Script**" [[#dapt-script]] { + Workflow Type [[[#workflow-type]]] + Script Type [[[#script-type]]] + Primary Language [[[#primary-language]]] +} + together { - Class DAPTScript as "**DAPT Script**" [[#dapt-script]] { - Workflow Type [[[#workflow-type]]] - Script Type [[[#script-type]]] - Primary Language [[[#primary-language]]] + Class Character as "**Character**" [[#character]] { + Character Identifier [[[#dfn-character-identifier]]] + Name [[[#dfn-character-name]]] + {field} (optional) Talent Name [[[#dfn-character-talent-name]]] } Class ScriptEvent as "**Script Event**" [[#script-event]] { @@ -29,6 +35,12 @@ together { {field} (optional) On Screen [[[#on-screen]]] } + Class ScriptEventDescription as "**Script Event Description**" [[#dfn-script-event-description]] { + {field} Description + {field} (optional) Description Type [[[#dfn-description-type]]] + {field} (optional) Language + } + Class Text as "**Text**" [[#text]] { Text content [[[#dfn-text]]] Text Language Source [[[#text-language-source]]] @@ -37,18 +49,6 @@ together { } } -Class Character as "**Character**" [[#character]] { - Character Identifier [[[#dfn-character-identifier]]] - Name [[[#dfn-character-name]]] - {field} (optional) Talent Name [[[#dfn-character-talent-name]]] -} - -Class Style as "**Style**" { - Style Identifier - {field} (optional) Character Identifier [[[#dfn-character-identifier]]] - Style Attributes -} - together { abstract Class Audio as "**Audio**" [[#dfn-audio]] { } @@ -82,30 +82,25 @@ class MixingInstruction as "**Mixing Instruction**" [[#dfn-mixing-instruction]] ' MixingInstruction -[hidden]r-AudioRecording -DAPTScript *-down- "0..* " ScriptEvent : contains > -DAPTScript *-right- "0..*" Character : contains\r > -DAPTScript *-right- "0..* " Style : contains > -Character "0..1 " <.down. "0..*" Style [[#dfn-character-style]] : Character\rStyle -ScriptEvent "0..*" .right.> "0..*" Style [[#dfn-character-style]] : Character\rStyle -ScriptEvent *-left- "0..*" MixingInstruction : contains > -Text "0..*" .right.> "0..*" Style [[#dfn-character-style]] : Character\nStyle -Text "0..*" .right.> "0..*" Style : Other\nStyle -Text *-down- "0..* " Audio : contains > -Text *-left- "0..* " MixingInstruction : contains > -ScriptEvent *-down- "0..*" Text : contains > -ScriptEvent "0..*" .left.> "0..*" Character -AudioRecording *-left- "0..* " MixingInstruction : contains > -Audio <|-- SynthesizedAudio : is < -Audio <|-- AudioRecording : is < +DAPTScript *-down- "0..* " ScriptEvent : contains\n > +DAPTScript *-- "0..*" Character : contains > +ScriptEvent *-down- "0..*" MixingInstruction : contains\n > +Text *-left- "0..* " Audio : contains\n < +Text *-- "0..* " MixingInstruction : contains\n > +Character "0..*" <.right. "0..*" ScriptEvent +ScriptEvent *-left> "0..*" ScriptEventDescription : contains\n < +ScriptEvent *-down- "0..*" Text : contains\n > +AudioRecording *-- "0..* " MixingInstruction : contains > +Audio <|-down- SynthesizedAudio : is\n < +Audio <|-down- AudioRecording : is\n < SynthesizedAudio -[hidden]r- AudioRecording ' Hidden links to persuade the layout to look nicer -DAPTScript -[hidden]right- Style -Character -[hidden]down- Style ' MixingInstruction -[hidden]left- Text ' Text -[hidden]down- Audio -' AudioRecording -[hidden]right- SynthesizedAudio +AudioRecording -[hidden]left- SynthesizedAudio +Audio -[hidden]left- MixingInstruction hide empty members hide circle diff --git a/index.html b/index.html index c13ab26..684c07d 100755 --- a/index.html +++ b/index.html @@ -132,6 +132,9 @@ color: white; background-color: black; } + figure svg { + max-width: max-content !important; + } @@ -769,7 +772,7 @@

Script Event

Translations of the original language script in other languages.

Empty Text objects can be used to indicate explicitly that there is no text content. It is recommended that empty Text objects are not used as a workflow placeholder to indicate incomplete work.

-
  • an optional Script Event Description property, as a human-readable description of the Script Event.
    • +
  • zero or more Script Event Description objects, each being a human-readable description of the Script Event.
  • an optional On Screen property, which is an annotation indicating the position of the subject (e.g. a character) of the Script Event
  • Zero or more Mixing Instruction objects used to adjust playback of the programme audio during the Script Event.
    • @@ -951,16 +954,36 @@

    On Screen

    Script Event Description

    -

    The Script Event Description property is an annotation providing a human-readable description of a Script Event.

    -

    The Script Event Description property is represented in a DAPT Document by a <ttm:desc> element at the <div> level.

    -

    The Script Event Description does not need to be unique, i.e. it does not need to have a different value for each Script Event. - For example a particular value could be re-used to identify in a human-readable way one or more Script Events that are intended to be processed together, +

    The Script Event Description object is + an annotation providing a human-readable description of a Script Event. + Script Event Descriptions can themselves be classified with + a Description Type.

    +

    A Script Event Description object is represented in a DAPT Document by + a <ttm:desc> element at the <div> level.

    +

    Zero or more <ttm:desc> elements MAY be present.

    +

    The Script Event Description does not need to be unique, + i.e. it does not need to have a different value for each Script Event. + For example a particular value could be re-used to identify in a human-readable way + one or more Script Events that are intended to be processed together, e.g. in a batch recording.

    - 
    -
    -

    The <ttm:desc> element MAY have a daptm:descType attribute specified to indicate the type of description. The daptm:descType attribute is defined below. Its possible values are as indicated in the registry at YYY.

    +

    The <ttm:desc> element + MAY specify its language + using the xml:lang attribute.

    + + 
    +
    +

    Each Script Event Description can be annotated with + one or more Description Types + to categorise further the purpose of the Script Event Description.

    +

    Each Description Type is represented in a DAPT Document by + a daptm:descType attribute on the <ttm:desc> element.

    +

    The <ttm:desc> element MAY have zero or one daptm:descType attributes. + The daptm:descType attribute is defined below. + Its possible values are as indicated in the registry at YYY.

    Registry to be defined.

    @@ -971,7 +994,9 @@ 
    Script Event Description
    
             data-include="examples/event-desc-descType.xml"
             data-include-format="text">
    -

    Multiple <ttm:desc> elements MAY be present with different values of daptm:descType, as in the following example.

    +

    Amongst a sibling group of <ttm:desc> elements + there are no constraints on the uniqueness of daptm:descType, + however it may be useful as a distinguisher as shown in the following example.