Quel format pour les référentiels ?

Les documents de références sont jusqu’à présent essentiellement rédigés à l’aide d’outils bureautiques. Cette approche très classique ne permet pas de capitaliser sur le contenu en l’incluant d’en autres contextes.
Par exemple, les différents standards du RGI, la liste du SILL ou les critères du RG2A sont contenus dans des documents bureautiques. Il n’est donc pas possible d’inclure tout ou partie de ces référentiels dans un outil ou d’en faire un traitement.
Le RG2A propose une version html et une marldown dans le but de fournir un code source qui permette une utilisation dans d’autres contextes. Je cherche a optimiser ce travail en utilisant un format qui permette une gestion avancée du référentiel (avec des méta-données pour les versions, des compléments, des liens, un glossaire …). Il doit également offrir la possibilité de générer ce référentiels dans d’autres formats (html, off, docx, pdf …).

Pour le moment les pistes sont :

  • html avec des balise data-
  • xml avec une grammaire à définir
  • md mais pas de piste pour les méta-données
  • docbook sans plus d’avis aide retour d’expérience

Merci d’avance de votre aide.

4 Likes

J’ai trouvé MuliMardown (http://multimarkdown.com) pour la rédaction de document et surtout la génération dans différents formats.
Le problème est qu’il ne semble pas y avoir de possibilité pour ajouter des méta-données à des éléments du texte.
Des retours d’expérience sur ce format ?

Bonjour, lorsque vous parlez de documents rédigés à l’aide d’outils bureautiques, s’ils sont enregistrés au format ODF alors ces documents sont des fichiers .xml. Il suffit de décompresser le fichier (.odt par exemple) pour avoir accès à l’ensemble des fichiers .xml et pouvoir ensuite manipuler les données. Il existe plusieurs outils disponibles pour faire ces manipulations, voir http://www.opendocumentformat.org/developers/. Cordialement - Sophie

1 Like

Mais ça n’est pas nécessairement suffisant et un fichier xml avec une grammaire spécifique à l’information qui doit être stocké dans le référentiel en question n’est pas nécessairement inutile.

Merci pour vos retours. En effet, odf ne me semble pas suffisant pour définir des types d’informations.
Par exemple, dans mon document il peut y avoir des paragraphes de type règle ou de type principe ou encore sans type particulier.
Ces informations peuvent être utilisées par la suite pour mettre en forme le texte ou filtrer/extraire et pour générer un document dans des formats différents (html, pdf, doc).

L’avantage du md est de permettre de structurer l’information indépendamment du rendu mais je n’ai pas trouver le moyen de définir des méta-données. HTML permet de remplir l’objectif mais avec toute la verbosité du DOM. Un XML dédié pourrait également remplir le contrat mais du coup on rentre dans du propriétaire.
Cependant, en lisant vos retours je me dis que ce type d’information pourrait être définie directement avec de la rigueur dans la formulation (avoir un titre avec les mots règle ou principe par exemple).

Non, un XML et un style XSLT ne sont pas propriétaires.

1 Like

Tu peux regarder du côté de Asciidoc pour le format, et Asciidoctor pour convertir du Asciidoc dans différents formats. Le livre Pro Git utilise cette solution pour la génération dans différents formats.

Il existe aussi un éditeur http://asciidocfx.com/ (jamais testé).

2 Likes

Bonsoir,

Il me semble que Docbook ait toutes les qualités pour ça. Il sépare nettement le contenu de la présentation, possède une grammaire permettant donc de vérifier automatiquement qu’un document est bien formé, et de nombreuses moulinettes existent pour les conversions en html, pdf, tex, txt, rtf, etc.
Le texte est hiérarchisé (titre, section, paragraphe) sans notion de présentation, ce qui est réalisé ensuite en temps utile en appliquant une feuille de style.
Il autorise les metadata. (de mémoire) on peut référencer une partie d’un document, et l’inclure dans un autre.
Quand j’ai creusé le sujet il y a quelques années, il manquait un bon éditeur libre.

Amicalt
Jacquelin

Nous souhaitons également engager une réflexion sur les référentiels. L’aspect méta-données est très important pour nous car au-delà de l’idée de sortir sous différents formats il y a également celle de faire de l’affichage profilé (selon le profil du lecteur ou le niveau de lecture désiré ; exemple : asbtract), ainsi que de l’extraction sélective (choix de thèmes ou sujets spécifiques au sein du référentiel), voire de combiner les deux (exemple : asbtract thématique).

XML est une recommandation du W3C considérée comme un standard de structuration de données par le RGI. Il est d’ailleurs omniprésent dans les recommandations du RGI. Un format XML doté d’un schéma XSD et de feuilles de transformations XSLT publics et ouverts constitue un ensemble qui n’a rien de propriétaire.

En revanche, si on veut pouvoir factoriser et capitaliser, il faut un peu d’organisation et de gouvernance.

Docbook je n’ai pas regardé depuis très longtemps. Il fait également partie des recommandations du RGI. Je n’ai pas eu le temps de regarder s’il correspondait à nos besoins exprimés ci-dessus.

1 Like

Merci pour ce retour. Je vais creuser le sujet pour voir si il peut s’appliquer à mon contexte.

Quand je dis propriétaire, je pense plutôt spécifique. En gros si on défini sa propre grammaire on doit aussi prendre en charge l’outillage (et surtout maintenir tout ça dans le temps).
Tout est ouvert mais on ne profite pas de l’apport d’une communauté.

J’ai lancé un travail sur l’indexation des ressources pédagogiques avec des collègues du ministère de l’éducation nationale. Notre objectif est d’ajouter une information sur le fait qu’une ressource est accessible à une personne en situation de handicap.
Peut être pourrions-nous partager sur ce sujet si cela vous intéresse. Ou lancer un nouveau sujet.

1 Like

Lancer un nouveau sujet me semble plus pertinent !