metadataplayer: comparison doc/architecture.en.md

equal deleted inserted replaced

-:793b3727d433
+:4b9594182ffd
 Widgets are modules, visible or not, adding functionalities to the Metadataplayer.
 Located in the *src/widgets* directory, they’re composed of a mandatory JavaScript file, *WidgetName.js* and an optional stylesheet, *WidgetName.css*
-### Common video player Widget oOptions ###
+### Common video player Widget options ###
 - **video**, video file URL.
 - **height**, video player height (width is defined in the main *config* of IriSP.Metadataplayer(*config*) ).
 - **autostart**, as its name implies, *true* or *false*.
 - **url\_transform**, function to transform the video url, if a transformation is needed before integration.
+Ex: url\_transform: function(url) { return url + ".mp4"; }
 Here is the list of available video player widget with their options. No specific css used.
 #### HtmlPlayer ####
 - **annotation\_type**: (default: "chapitrage"), see *Common widget options*.
 - **show\_top\_border**: (default: false), show top widget border (useful depending on whether it is used in combination with the *Arrow* widget)
 - **site\_name**: "Lignes de Temps", site name to display when users click on "Share on social networks".
 - Uses a CSS stylesheet: yes
-### AnnotationsList ###
+#### AnnotationsList ####
 - **Role**: Show a list of annotations.
 - **Options**:
 - **ajax\_url**: (default: false), specifies an API template when annotations have to be loaded from an external source. In the URL, {{media}} will be replaced by the media ID, {{begin}} by the start *timecode* in milliseconds, {{end}} by the end *timecode* in milliseconds. If set to *false*, displayed annotations will be the ones loaded from the default metadata source. On the *Lignes de Temps*, the URL of the segments API is http://ldt.iri.centrepompidou.fr/ldtplatform/api/ldt/segments/{{media}}/{{begin}}/{{end}}?callback=?
 - **ajax\_granularity**: (default: 300000 ms = 5 minutes), specifies the timespan to be loaded from the segment API, around the current timecode.
 #### CreateAnnotation ####
 - **Role**: Displays a form to create a new annotation
 - **Options**:
+- **after\_send\_timeout**: (default: 0), add annotation request timeout.
+- **always\_visible**: (default: false), widget always visible or not.
+- **annotation\_type**: (default: "Contributions"), see *Common widget options*.
+- **api\_endpoint\_template**: API Endpoint URL, with {{id\}\} as a placeholder for project ID, e.g.: "http://ldt.iri.centrepompidou.fr/ldtplatform/api/ldt/annotations/{{id}}.json".
+- **api\_method**: (default: "POST"), HTTP method used to send annotations.
+- **api\_serializer**: (default: "ldt\_annotate"), serializer to use when sending annotations.
+- **close\_after\_send**: (default: false), closes the widget after adding annotation.
+- **close\_widget\_timeout**: (default: 0), duration in milliseconds before widget is closed after send. If value is set to 0, the widget stays open.
+- **creator\_avatar**: Creator profile thumbnail URL.
+- **creator\_name**: Default annotation creator name.
+- **max\_tags**: (default: 8), maximum number of tags to display.
+- **pause\_on\_write**: (default: true), pauses video when we start to write.
+- **polemics**: polemic buttons to display, as an array of objects, e.g.: [ { keyword: "++", background\_color: "#00a000", text\_color: "#ffffff" } ]
 - **show\_title\_field**: (default: true), shows or hides the annotation title field.
-- **creator\_name**: Default annotation creator name.
+- **show\_creator\_field**: (default: true), shows or hides the annotation author field.
-- **creator\_avatar**: Creator profile thumbnail URL.
+- **start\_visible**: (default: true), widget visible at start.
+- **tag\_prefix**: (default: "#"), as its name implies.
 - **tag\_titles**: (default: false), list of tags to display, as an array of strings: [ "#firstTag", "#secondTag" ]
 - **tags**: (default: false), list of tags to display, as an array of objects: [ { id: "tag-001", title: "#firstTag" } ]. Overrides *tag\_titles*. If both options are set to *false*, the most frequent tags in the project will be displayed.
-- **max\_tags**: (default: 8), maximum number of tags to display.
-- **polemics**: polemic buttons to display, as an array of objects, e.g.: [ { keyword: "++", background\_color: "#00a000", text\_color: "#ffffff" } ]
-- **annotation\_type**: (default: "Contributions"), see *Common widget options*.
-- **api\_serializer**: (default: "ldt\_annotate"), serializer to use when sending annotations.
-- **api\_endpoint\_template**: API Endpoint URL, with {{id\}\} as a placeholder for project ID, e.g.: "http://ldt.iri.centrepompidou.fr/ldtplatform/api/ldt/annotations/{{id}}.json".
-- **api\_method**: (default: "PUT"), HTTP method used to send annotations. *Lignes de temps* platform uses PUT.
-- **close\_widget\_timeout**: (default: 0), duration in milliseconds before widget is closed after send. If value is set to 0, the widget stays open.
 - Uses a CSS stylesheet: yes
 #### HelloWorld ####
 - **Role**: Example widget demonstration the API capabilities
 - **Options**:
 - **text**: (default: "world"), text to display after "Hello, "
 - Uses a CSS stylesheet: yes
-#### Media ####
+#### MediaList ####
 - **Role**: Shows current media, as well as other medias in the project. Mostly used for mashups
 - **Options**:
 - **default\_thumbnail**: thumbnail to display when a media doesn’t have one
 - **media\_url\_template**: Specifies an URL template for when a media doesn’t include URL information, e.g.: "http://ldt.iri.centrepompidou.fr/ldtplatform/ldt/front/player/{{media}}/"
 - **Role**: Handles *Media fragments*-compliant URIs (W3C Recommandation): Changing the playing position changes the URL and vice-versa.
 - An URL ending with #id=*annotation ID* points to an annotation, one with #t=*time in seconds* to a precise position.
 - No options
 - Uses a CSS stylesheet: no
+#### MultiSegments ####
+- **Rôle**: Displays horizontaly all the media's *annotation\_type* as Segments.
+- **Options**:
+- **visible_by_default**: true by default or false, as its name implies.
+- Utilise un fichier CSS: non
 #### Polemic ####
 - **Role**: Shows the *polemical timeline*, i.e. tweets colored according to the polemical syntax. Depending on the number of tweets, two visualization modes exist:
 - Below the threshold (low volume mode), tweets are represented as individual squares.

changeset 1023	4b9594182ffd
parent 1022	793b3727d433