Dépannage des problèmes courants liés à la génération de sortie

Beaucoup de gens rencontrent des problèmes avec DITA OT lors de l’exécution d’une compilation pour la première fois. Dans le fichier de log de DITA OT, un problème est généralement indiqué par le message « build failed ». Cependant, vous pouvez également avoir une compilation réussie, mais avoir des problèmes avec la sortie. Voici quelques problèmes communs et des conseils pour les résoudre :

  • Commandes mal saisies. Si votre compilation échoue, vérifiez que vos commandes ne contiennent pas d’espaces supplémentaires, de lettres transposées, de paramètres manquants ou d’autres erreurs typographiques.

  • Mauvaise version de Java. Si vous n’avez pas la bonne version de Java, le fichier de log montrera que la compilation a échoué ou a même refusé de s’exécuter. Suivez les instructions précédentes de cette leçon sur l’installation de Java pour résoudre ce problème.

  • Contenu source non valide. Si l’un des fichiers des rubriques de votre carte ou le fichier carte lui-même est invalide, DITA OT peut ne pas être en mesure de générer la sortie. Si vous rencontrez un échec de génération et que le journal affiche des erreurs relatives à un fichier source particulier, ouvrez ce fichier et vérifiez que sa structure est valide.

  • Sortie manquante. Si le journal indique que la compilation a réussi, mais que vous ne parvenez pas à trouver votre sortie, revérifiez votre paramètre -o pour vous assurer que vous avez spécifié un emplacement de sortie. Si ce n’est pas le cas, la sortie sera compilée dans le dossier DITA OT.

  • Sortie remplacée. Chaque fois que vous exécutez DITA OT avec le même ensemble de commandes sur les mêmes fichiers sources, votre génération la plus récente remplacera votre génération précédente. Si vous souhaitez conserver chaque itération de sortie que vous générez (par exemple, pour suivre les résultats de tests ou de dépannage), vous pouvez soit renommer la sortie précédente avant d’exécuter une nouvelle génération, soit définir un répertoire de sortie différent via le paramètre -o chaque fois que vous exécutez la génération.

  • Apparence incorrecte de la sortie. Parfois, votre sortie ne ressemble pas à ce que vous attendiez, même si elle se construit avec succès. Par exemple, les images d’un fichier PDF peuvent être si grandes qu’elles sortent de la page, ou les colonnes d’un tableau peuvent ne pas être optimales pour l’affichage de texte. Ces problèmes sont dus au fait que vous n’avez pas spécifié de mesures pour vos images et tableaux dans les fichiers sources.

    Pour contrôler la taille spécifique de vos images, vous pouvez utiliser l’attribut « width » de l’élément <image>.

    Figure 2. Image avec une largeur spécifiée vs. image sans largeur spécifiée en sortie PDF

    Pour les tableaux, vous pouvez utiliser l’élément <colspec> pour ajuster les largeurs des colonnes à partir de leur réglage par défaut de largeurs égales en largeurs qui fonctionnent mieux pour votre contenu.

    Note: Les éditeurs XML visuels (tels que oXygen) vous permettent de modifier la largeur des colonnes des tableaux grâce à une interface graphique qui gère les valeurs <colspec> pour vous.

    Figure 3. Tableau avec colspecs ajusté vs. tableau avec colspecs par défaut dans la sortie PDF

Les problèmes plus complexes nécessitent une résolution plus approfondi. Si vous rencontrez un échec de génération qui ne correspond pas à l’un de ces problèmes courants, utilisez le journal DITA OT de votre génération comme point de départ pour identifier le problème. Une fois que vous savez ce qui cause le problème, vous devrez peut-être exécuter plusieurs tests pour continuer à le dépanner jusqu’à ce que vous puissiez le résoudre. La documentation DITA OT sur les fichiers log (http://www.dita-ot.org/2.4/user-guide/log-files.html) est une ressource utile pour le dépannage.

Note: Malheureusement, nous ne pouvons pas offrir une assistance technique individuelle sur ce site gratuit.

Contributeurs