Mercurial Mercurial > metadataplayer / diff
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/architecture.fr.md
changeset 1023 4b9594182ffd
parent 1022 793b3727d433 
--- a/doc/architecture.fr.md	Tue Jan 07 12:00:04 2014 +0100
+++ b/doc/architecture.fr.md	Tue Jan 07 12:46:58 2014 +0100
@@ -142,6 +142,7 @@
 - **height**, hauteur du lecteur vidéo (la largeur est défini dans la *config* générale du IriSP.Metadataplayer(*config*) ).
 - **autostart**, comme son nom l'indique, *true* ou *false*.
 - **url\_transform**, fonction pour traiter l'url s'il y a besoin de la transformer avant de l'intégrer.
+    Ex: url\_transform: function(url) { return url + ".mp4"; }
 
 Voici la liste des widgets player actuellement disponibles avec leurs options. Aucun player n'utilise de fichier css spécifique.
 
@@ -252,17 +253,25 @@
 
 - **Rôle**: Permet de créer une annotation en affichant un formulaire
 - **Options**:
-    - **show\_title\_field**: (défaut: true), affiche un champ permettant de saisir le titre de l’annotation.
-    - **creator\_name**: nom d’utilisateur du créateur de l’annotation.
+    - **after\_send\_timeout**: (défaut: 0), timeout de la requête d'ajout d'annotation.
+    - **always\_visible**: (défaut: false), widget toujours visible ou non.
+    - **annotation\_type**: (défaut: "Contributions"), cf. *Options courantes*, plus haut.
+    - **api\_endpoint\_template**: URL de l’API, où {{id\}\} est remplacé par l’ID du projet, ex: "http://ldt.iri.centrepompidou.fr/ldtplatform/api/ldt/annotations/{{id}}.json".
+    - **api\_method**: (défaut: "POST"), méthode HTTP utilisée pour envoyer les annotations.
+    - **api\_serializer**: (défaut: "ldt\_annotate"), sérialiseur à utiliser pour l’envoi des annotations.
+    - **close\_after\_send**: (défaut: false), ferme le widget après avoir créé une annotation.
+    - **close\_widget\_timeout**: (défaut: 0), durée en millisecondes avant que le widget ne soit refermé après l’envoi d’une annotation. Si la valeur est 0, le widget ne se referme pas.
     - **creator\_avatar**: URL de l’image de profil du créateur de l’annotation.
-    - **tags**: (défaut: false), liste des tags à afficher, sous la forme d’un tableau d’objets type [ { id: "tag-001", title: "" } ]. Si la valeur est false, affiche les tags les plus utilisés du projet.
+    - **creator\_name**: nom d’utilisateur du créateur de l’annotation.
     - **max\_tags**: (défaut: 8), nombre de tags à afficher.
+    - **pause\_on\_write**: (défaut: true), arrête la lecture quand on commence à écrire.
     - **polemics**: boutons polémiques à afficher, sous la forme d’un tableau d’objets indiquant mot-clé à ajouter, couleur du fond du bouton, couleur du bouton, ex: [ { keyword: "++", background\_color: "#00a000", text\_color: "#ffffff" } ]
-    - **annotation\_type**: (défaut: "Contributions"), cf. *Options courantes*, plus haut.
-    - **api\_serializer**: (défaut: "ldt\_annotate"), sérialiseur à utiliser pour l’envoi des annotations.
-    - **api\_endpoint\_template**: URL de l’API, où {{id\}\} est remplacé par l’ID du projet, ex: "http://ldt.iri.centrepompidou.fr/ldtplatform/api/ldt/annotations/{{id}}.json".
-    - **api\_method**: (défaut: "PUT"), méthode HTTP utilisée pour envoyer les annotations. La plateforme *Lignes de temps* utilise PUT, mais cette méthode devrait être réservée pour la création d’une ressource dont l’URL est connue à l’avance.
-    - **close\_widget\_timeout**: (défaut: 0), durée en millisecondes avant que le widget ne soit refermé après l’envoi d’une annotation. Si la valeur est 0, le widget ne se referme pas.
+    - **show\_title\_field**: (défaut: true), affiche un champ permettant de saisir le titre de l’annotation.
+    - **show\_creator\_field**: (défaut: true), affiche un champ permettant de saisir l'auteur de l’annotation.
+    - **start\_visible**: (défaut: true), widget visible au démarrage.
+    - **tag\_prefix**: (défaut: "#"), comme son nom l'indique.
+    - **tag\_titles**: (default: false), liste des tags à afficher, sous la forme d’un tableau de strings: [ "#premierTag", "#secondTag" ]
+    - **tags**: (défaut: false), liste des tags à afficher, sous la forme d’un tableau d’objets type [ { id: "tag-001", title: "" } ]. Si la valeur est false, affiche les tags les plus utilisés du projet.
 - Utilise un fichier CSS: oui
 
 #### HelloWorld ####
@@ -272,7 +281,7 @@
     - **text**: (défaut: "world"), texte à afficher après "Hello, "
 - Utilise un fichier CSS: oui
 
-#### Media ####
+#### MediaList ####
 
 - **Rôle**: Affiche le média en cours, ainsi que la liste des autres médias du projet. Utilisé principalement pour les mashups
 - **Options**:
@@ -287,6 +296,13 @@
 - Pas d’options
 - Utilise un fichier CSS: non.
 
+#### MultiSegments ####
+
+- **Rôle**: Affiche tous les *annotation\_type* du média sous forme de Segments, en horizontal.
+- **Options**:
+    - **visible_by_default**: true ou false, comme son nom l'indique.
+- Utilise un fichier CSS: non
+
 #### Polemic ####
 
 - **Rôle**: Affiche la *timeline polémique*, c’est à dire les tweets colorés en fonction de la syntaxe polémique. Selon le volume de tweets, deux modes de représentation existent:
@@ -316,13 +332,6 @@
     - **height**: hauteur du widget
 - Utilise un fichier CSS: oui
 
-#### MultiSegments ####
-
-- **Rôle**: Affiche tous les *annotation\_type* du média sous forme de Segment, en horizontal.
-- **Options**:
-    - **visible_by_default**: true ou false, comme son nom l'indique.
-- Utilise un fichier CSS: non
-
 #### Slider ####
 
 - **Rôle**: Barre de progression et *Slider* indiquant la position de la tête de lecture vidéo et permettant de la déplacer.
metadataplayer