Publication de blogs DITA via iiRDS vers c-rex.net IDS

DITA comme source de données

Nous avons décrit dans les articles précédents que nous misons sur DITA comme format de création dans notre rédaction.

Nous répondons maintenant à la question de savoir comment alimenter le blog c-rex.net à partir de nos contenus enrichis de métadonnées.

Comme nous nous basons sur DITA, il est logique d'utiliser le DITA Open Tool Kit pour la publication. Nous convertissons d'abord les contenus en iiRDS et les publions ensuite sur c-rex.net IDS.

À cette fin, nous avons développé un ensemble de plug-ins. Plugins qui nous permettent de publier en appuyant sur un bouton.

DITA-OT Plugins

Le graphique suivant montre les plugins pour le DITA Open Tool Kit qui sont utilisés dans notre environnement éditorial.

Pour le cas d'utilisation Content Delivery, 3+1 plugins sont pertinents :

• com.c-rex.net.dita.dts

  Ce plugin met à disposition des fonctionnalités de base pour communiquer avec le service cloud c-rex.net DTS. Il met à disposition des paramètres de base pour l'authentification au système ainsi que pour les conversions.

• com.c-rex.net.dita.packager

  Le Packager est un plugin d'utilisation générale qui emballe le contenu d'une DITA-Map dans un paquet ZIP afin de transmettre le contenu, comme nécessaire dans ce cas d'application, à c-rex.net DTS pour la conversion.

• com.crex.net.dita.conversion

  Le plugin fournit des paramètres pour la conversion de contenus DITA dans d'autres formats. Le plugin implémente les deux scénarios de transformation DITA 2 iiRDS et DITA 2 c-rex.net IDS.

• com.crex.net.dita.td.content

  Il s'agit ici d'un plugin spécial pour les types de topics spécialisés de c-rex.net et la mise en œuvre d'exigences particulières.

  Nous y transposons les métadonnées spécifiques de nos articles de blog, de sorte que ceux-ci puissent être reconnus en conséquence lors de la conversion vers iiRDS par c-rex.net DTS et transférés dans le format iiRDS.

  Ce plugin ou une modification de celui-ci peut être utilisé dans différents scénarios pour adapter de manière automatisée les exigences spécifiques du client au HTML ou à l'ensemble de métadonnées à générer en conséquence.

Le DITA-OT Conversion Plugin

Le DITA-OT Conversion Plugin met à disposition deux fonctions :

• Cas 1 Génération d'un paquet iiRDS à utiliser dans d'autres scénarios

• Cas 2 Publication des contenus via iiRDS sur c-rex.net IDS dans différents scénarios de livraison de contenus

Comme nous voulons publier directement nos articles de blog, nous nous concentrons sur le deuxième cas d'utilisation, la seule différence étant de savoir si l'iiRDS est renvoyé au client ou publié directement.

Configuration et paramètres

Pour pouvoir utiliser les services de conversion de c-rex.net DTS et les options de publication de c-rex.net IDS, un compte d'utilisateur et les autorisations correspondantes sont nécessaires. L'inscription des données d'accès permet de configurer l'appel du scénario de transformation dans le plugin. Dans la boîte de dialogue suivante, vous voyez le jeu de paramètres nécessaire pour cela.

Pour exécuter le scénario de transformation, les paramètres suivants doivent être définis.

• Le scénario DTS avec lequel DTS doit effectuer la conversion est indiqué via le conversionType.param. Dans ce cas, la DITA-Map doit être publiée selon c-rex.net IDS, ce pour quoi le scénario ditaot2crexIDS est configuré.

• Le organization.param permet d'indiquer l'organisation sous laquelle le paquet iiRDS doit être publié.

  L'organisation permettrait de contrôler les droits d'accès aux contenus.

• Le point final du service DTS par lequel la conversion doit être effectuée est indiqué via le dts.url.param. Conçu comme un service cloud, plusieurs instances sont par nature disponibles sur Internet ou sur l'intranet.

• Enfin, les trois identity permettent d'indiquer les données de l'utilisateur, comme le nom d'utilisateur et le mot de passe, ainsi que la Scope requise par le service d'authentification.

  Toutes ces informations sont disponibles dans le profil de chaque utilisateur après l'enregistrement dans le système.

Une fois l'accès au système configuré et ce paramétrage effectué, chaque DITA-Map peut être publiée sur le portail c-rex.net IDS en un seul clic sur "Exécuter la transformation".

Préparation des données

Le DITA-OT-Plugin prépare les données pour la conversion côté serveur. Tous les DITA-Topics sont transformés au choix en HTML5 ou XHTML5 via la fonctionnalité de DITA-OT.

Comme nos plugins s'intègrent parfaitement dans un environnement avec DITA-OT, cela présente le grand avantage de pouvoir utiliser automatiquement les extensions existantes pour la génération de contenus HTML directement et sans autres adaptations.

C'est le cas dans l'environnement de notre blog et cela sera facile à réaliser dans le vôtre !

Enfin, nous utilisons également ce mécanisme en utilisant notre propre plugin spécifique com.crex.net.dita.td.content pour la préparation des pages HTML.

En plus de la génération HTML, les métadonnées de base sont automatiquement ajoutées à la DITA-Map et les références aux DITA-Topics sont modifiées pour correspondre au nouveau nom de fichier de la sortie HTML. Ce générateur est alors transmis à c-rex.net DTSc-rex.net DTS compile à son tour les informations en un iiRDS valide et le publie automatiquement.

Les métadonnées étendues automatiquement aux références des topics dans la DITA-Map peuvent être complétées de manière automatisée à l'aide d'un DITA-OT-Plugin spécifique comme le com.crex.net.dita.td.content. Il est également possible de transmettre une configuration permettant au service DTS d'effectuer un mappage d'un ensemble de métadonnées spécifique.

Transformation selon iiRDS

Grâce au mapping transmis ou aux métadonnées iiRDS déjà générées dans le domaine metadata, c-rex.net DTS crée un paquet iiRDS valide. Les conditions imposées par la norme sont alors vérifiées, si possible corrigées automatiquement et publiées. Les éventuels problèmes sont renvoyés via un rapport détaillé.

En plus du rapport, le paquet iiRDS est également retourné. Ce paquet peut être archivé via les mécanismes d'archivage existants dans l'entreprise.

Nous garantissons ainsi que les données générées par le système sont disponibles à tout moment et indépendamment du système.

Pour les entreprises pour lesquelles nous réalisons des projets avec iiRDS, cela signifie que Nous brisons les silos et rendons à clientsclientesclients et clientesclient·e·s clientes la maîtrise de leurs données.

Publication sur le portail

Le paquet iiRDS terminé est mis à la disposition de c-rex.net IDS pour publication via l'API de contenu.

Le contenu du paquet est importé dans le référentiel de l'organisation indiquée dans le paramètre. Le contenu est ainsi disponible sur le portail en quelques minutes, voire en quelques secondes.

Conclusion

Grâce à l'intégration de nos plug-ins et à une configuration minimale, nos contenus créés avec DITA sont disponibles sur notre site en un rien de temps.

Il n'est guère possible de mettre à disposition sur le web des contenus basés sur la technologie Linked Data plus rapidement et avec moins d'efforts.

Et ce qui est bien, c'est que cela ne fonctionne pas seulement pour notre blog, qui est basé sur DITA, mais de manière analogue avec vos documents créés dans Word, FrameMaker ou InDesign. En plus de vos documents, fournissez une configuration pour le mappage des métadonnées et c-rex.net DTS se charge du reste.