Migrer une documentation existante au format docbook-esup vers le wiki

Ce document est une aide à l'importation de fichiers en format docbook-esup vers le wiki confluence. On s'aperçoit que l'importation par un simple copier/coller d'un document html issu d'un source docbook-esup fait perdre certaines d'informations de formatage.

Afin de faciliter ce type d'importation, Julien Marchal a développé une interface web permettant d'améliorer le résultat. Cette interface web est disponible sur http://ext.univ-nancy2.fr/docbook2wiki/, elle prend en entrée un fichier source docbook xml, et génère du code wiki.

Une procédure d'importation peut être celle détaillée ci-dessous.

formatage préalable du document

Le source xml issu par exemple de l'outil xmleditor n'est pas toujours dans le meilleur état pour être traité par cet interface web  avec le maximum d'efficacité.

Nous vous conseillons donc d'ouvrir le document dans cooktop (http://www.xmlcooktop.com/update/http://www.xmlcooktop.com/update/), puis de le formater (menu "XML", puis "format XML"), et le sauvegarder. 

Importation dans l'interface web

 Choisir ce fichier xml, et l'importer (bouton "Envoyer le fichier") ; le code est alors transformé en format "balise wiki confluence". Copier ce code dans le presse papier.

Importation dans le wiki

Faire "Ajouter" - "Page" dans le point d'arborescence désiré du wiki. Donner un titre à la page.
Cliquer sur "Balise Wiki", et faire un coller du presse papier.

Cliquer sur "Aperçu" pour avoir une idée du résultat de l'importation.

Finalisation du document

Cliquer sur "Texte enrichi" ; il est alors possible d'éditer de manière conviviale le document dans le wiki.

Certaines choses seront à reprendre, éventuellement :

- Les liens

Les liens http externes sont biens récupérés ; ce n'est pas le cas des liens internes, ou vers des fichiers joints . Ces derniers liens sont donc à reprendre.

- Les images

Si jamais votre document sources contient des images (<img ...) le parsing va garder le lien de telle manière que vous n'ayez qu'a attacher au document l'image.

Par exemple dans le document sources <img src="../images/test.gif" />

Après importation il faut que vous uploadiez (en haut a droite Ajouter > Pièces Jointes ) votre image avec le nom test.gif

 - Des caractères spéciaux

 Confluence gère en interne certains caractères spéciaux, comme "[", "]","{" .

L'interface d'importation n'est pas capable de les traiter. Ainsi, le texte suivant : "tab[$ind]" sera restitué comme ceci : "tab[$ind]" ; on s'aperçoit au passage que confluence marque d'une couleur les codes mal interprètés.

On peut rectifier de 2 manières :

  • en mode "Texte enrichi" ; supprimer le code incriminé, et ressaisir.
  • en mode "Balise Wiki" ; faire précéder le caractère spécial du caractère "\".

- du code de type "programlisting"

Ce code est récupéré, mais en une seule ligne ; par exemple :

LoadModule cas_module modules/mod_cas.so ... <IfModule mod_cas.c> CASLocalCacheInsecure On CASLocalCacheFile /tmp/CAScache CASTrustedCACert /Cert/ac-racine.pem CASLoginURL [https://auth.univ.fr] CASHost auth.univ.fr CASPort 443 CASValidate /validate # CASDebug on </IfModule> ... Directory /home/essai> <IfModule mod_cas.c> AuthType CAS AuthName "bases en ligne" Require valid-user </IfModule> </Directory> Directory /home/essai/toto> Require user toto </Directory>

Alors que le code intial était celui-ci :

LoadModule cas_module modules/mod_cas.so
...

<IfModule mod_cas.c>
   CASLocalCacheInsecure On
   CASLocalCacheFile /tmp/CAScache
   CASTrustedCACert /Cert/ac-racine.pem
   CASLoginURL https://auth.univ.fr
 ....

On peut rectifier de différentes manières

  •  En mode "Texte enrichi"
    • si le code est très court (3 ou 4 lignes) : insérer les retour chariot la ou c'est nécessaire
    • Supprimer le code. Recréer un paragraphe de format 'code'.
      Copier le code depuis le document html source ; le copier dans le paragraphe de type 'code'
  • En mode "Balise Wiki".
    supprimer ce qui se trouve entre les 2 balises "{code}"
    coller le code entre ces 2 balises.
Saisissez les étiquettes à ajouter à cette page:
Please wait 
Vous recherchez une étiquette ? Commencez à taper.