API Chaine

Modules chaine d'information

Le module Chaine d'information vous permet de diffuser des informations sous forme de bloc html personnalisable à souhait.

Vous pouvez créer un nombre illimité de chaine contenant chacun quatre canaux qui défileront dans le bloc html.

L'apparence de ce bloc est entièrement personnalisable car l'API d'intégration de la chaine permet d'importer des feuilles de styles.

Créer une chaine

Apercu 1 du menu chaine (pas de chaine sélectionnée).

Après avoir installé le programme sur votre serveur et créer un compte utilisateur sur votre exemplaire du programme, allez dans le menu "Chaine d'information" (Le menu est le panneau latéral gauche).

Vous êtes maintenant dans le module "Chaine d'information". Vous devriez voir des boutons qui donnent accès à vos chaines par defaut (News, Sport, Jeux) ainsi que le visionneur de chaine vous demandant de sélectionner une chaine.

En survolant les boutons, la description de la chaine correspondante s'affiche sur la droite. ainsi, vous verrez que le bouton "Chaine +" sert à créer une nouvelle chaine. Ce bouton se trouve toujours en en dernière position (dans la version v 0.0.1 du programme).

Cliquez sur le bouton "chaine+", remplissez correctement et valider le formulaire qui s'affiche alors.

Pour la version 0.0.1, seuls le nom de la chaine et la description de la chaine sont requis et obligatoires.

Éditer une chaine

Après avoir créer votre chaine, vous pouvez l'éditer. Pour ce faire, cliquer sur le bouton correspondant à votre chaine. Le nuage du visionneur de chaine disparaitra pour afficher le contenu de la chaine.

Plus bas, les formulaires suivants sont est apparus:

• Gestion des couleurs de la chaine
• Description de la chaine
• Bloc d'infos n°1
• Bloc d'infos n°2
• Bloc d'infos n°3
• Bloc d'infos n°4

Chacun de ces formulaire est unique. Il fond donc les valider séparément.

Le gestionnaire de couleur vous permettra de modifier le style de votre chaine sans pour autant importer de nouvelles feuille de style.

Notez qu'en exportant une chaine sur un site, "l’exporteur" pourra lui aussi modifier la feuille de style pour que la chaine s'adapte au mieux à son site web.

Logiquement, seuls ne seraient jamais modifiés d'un point de vue graphique (propriété display du css) le contenu de votre chaine (Image de fond, description et contenu des blocs d'infos...).

Exporter une chaine

Le visionneur de chaine vous offre un apercu de ce que votre chaine si on l'exporte telle qu'elle.

en survolant le nom de votre chaine des un sous menu contenant des liens apparait.

• Description de la chaine
  Affiche la description de votre chaine
• Flux RSS de la chaine
  Affiche le lien vers le flux RSS de votre chaine
• Exporter la chaine
  Affiche le code d'exportation de votre chaine

Le code d'exportation de votre chaine est de la forme:

<object data="monsite/murelh/modules/chaine/API.php?chaine=MaChaine#description" type="text/html" width="100%"><!-- Ce qu'il faut afficher en cas d'erreur (incompatibilités etc...) --></object>

L'adresse contenu dans le paramètre data mène directement à votre chaine. En y accédant directement avec votre navigateur, votre chaine apparaitra en grand écran.

Pour personnaliser l'affichage de la chaine, il faut modifier les variables passées par adresse qui mène à votre chaine (où plus précisément à  votre API chaine d'information).

Les variable passée par adresse sont toutes les données saisies en amont du point d’interrogation (?) et en aval du diez (#).

 Dans notre exemple  nous avons donc une seule variable passée par adresse qui est le variable chaine contenant le nom de la chaine qui doit être affichée par l'API. Cette variable est obligatoire pour que l'API fonctionne. si la chaine pointée n'existe pas l'API affichera un nuage et le message "veuillez sélectionner une chaine".

D'autres variables peuvent être envoyé à l'API tel que:

• background_color=100,100,100
• background_image=monimage.png
• text_color=100,100,100
• css=monfichier.css

La valeur de la variable background_color doit comme dans mon exemple etre une série de trois nombre séparés par une virgule. Chacun des nombre doit être compris entre 0 et 255.

Ils seront interprétés par l'API comme étant le profil couleur rouge,vert,bleu: rgb(#,#,#).

Idem pour la variable text_color

Il est aussi possible de modifier l'image de fond de la chaine via la variable background_image. Les format acceptés sont: jpeg, jpg, gif, png, tiff et bmp.

La variable css n'accepte que des liens pointant vers un fichier .css et ce fichier sera lu comme étant la feuille de style de la chaine.

Les modifications de la chaine par variables passées par adresse, n'affectent que les sites où ces variables sont éditée comme tel.

Exemple: Si sur le site de Toto on écrit background_image=voiturebleu.gif, la chaine aura comme image de fond une voiture bleu uniquement sur le site de Toto.

Notez que si l'image de fond d'une chaine est importante pour la chaine, alors, il sera peut être idiot de modifier l'image de fond.

Flux RSS d'une chaine

Lors de la création, se créer automatiquement un fichier de syndication au format xml.
Lorsque vous modifierez une une information dans votre chaine, l'action sera archivée dans le flux.
Pour avoir le lien du flux RSS d'une chaine, vous devez (via l'API) survoler le nom de la chaine, cliquez sur "Afficher le flux RSS" puis cliquer sur le lien qui vous sera proposé.
monsite/murelh/modules/chaine/channels/MaChaine/rss.xml

fin