Ajout description publication PDF

Bonjour,

Sur mon projet de migration de notre documentation utilisateur sous Dokiel, je souhaite (lors de la publication), ajouter un tableau en première page, qui fait office d’infos sur les modifications apportées par version.

J’ai trouvé ce qu’il faut pour la publication web, avec le bloc « Description » où j’y mets mon tableau de version :

Malheureusement, je n’ai pas trouvé comment faire de même sur la génération PDF.
Oui car j’ai oublié de préciser le plus important : pour nos utilisateurs, nous avons comme contrainte de proposer la version WEB mais aussi toujours une version PDF (comme c’est le cas actuellement).

Je n’arrive pas à trouver une méthode qui me permettrait de le faire. Dans le « Guide » ce n’est pas bon car il est utilisé pour générer des publications différentes, et du coup mon tableau de modifications peut changer entre ces multiples publications.

Quelqu’un aurait-il eu ce genre de cas et aurait une astuce à me proposer ? :slight_smile:

Un grand merci par avance !

Corentin

Bonjour,

J’utiliserais une Section à la fin (ou au début) du Guide pour y mettre ce tableau. Il faudra filtrer cette Section (ou utiliser les conditions) pour qu’elle ne soit publiée que dans le PDF (ou alors la conserver pour le web aussi, à la place de la balise Description sur la page d’accueil du site).
Si vous choisissez de conserver le tableau dans la Description du site (pour avoir le tableau sur la homepage), alors, je mettrais le tableau dans un Fragment que je lierais à la fois dans la Section (pour le PDF) et dans la balise Description, afin de m’assurer que le même tableau est utilisé partout et mis à jour en une fois.
En espérant avoir été assez clair, n’hésitez pas dans le cas contraire,
Julien

Bonjour @julien_robert ,

Merci pour ta réponse rapide.

Si j’ai bien compris, cela veut dire qu’il faut que :

  • Je crée une condition PDF
  • Je publie ma version WEB en mettant la condition PDF à Faux
  • Je change ma condition à PDF à Vrai, et je lance cette fois la publication PDF puis que je modifie la condition en PDF

Est-ce bien cela ?
C’est vrai que c’est une solution (j’avais effectivement pensé à une condition sur WEB ou PDF). Mais ce qui m’inquiète c’est le risque d’erreur à manipuler les conditions (pour moi comme pour mes collègues car nous allons travailler à plusieurs).
Dans les publications que j’ai préparé pour le moment, j’essaie de ne jamais toucher les conditions (c’est pour ça que je n’avais pas fait ce type de condition). Je les positionne au départ (conditions et variables), et après je n’y touche plus.

Dans cette optique, je duplique déjà pas mal les .pub relatifs à mes guides, et je ne voulais pas rajouter en plus un .pub pour le WEB et un autre pour le PDF.

Merci encore pour ta réponse, si tu as une idée complémentaire, dans le même style mais sans que je sois obligé de modifier les conditions à chaque édition, ça m’irait (l’idée du fragment est bien, je n’y avais pas pensé sur ce coup là et ça permet de centraliser les modif oui).

Corentin

C’est bien cela !

Pour éviter de modifier le paramétrage, il y l’astuce de dupliquer la racine de publication (l’item guide.pub) et d’avoir qqch comme :

  • Guide-pdf.pub (où la condition PDF est à vrai),
  • Guide-web.pub (où la condition PDF est à faux).

Et lors de chaque mise à jour, il y a juste à vérifier que les métas (date, version…) sont ok ; mais pas de paramétrage touchy à modifier.

Edit : Ah, je viens de voir que j’avais oublié de lire le paragraphe où tu disais que tu n’étais pas chaud pour dupliquer les racines de publication :slight_smile: Malheureusement, je ne vois pas d’autre solution comme ça. Sinon, ne pas utiliser la balise Description et juste le tableau dans la Section « mise à jour » utilisé pour le web et le pdf dans ce cas.

Eh oui, j’suis chiant :sweat_smile:

Après, je m’y prends peut-être mal à essayer de transposer ce que l’on a actuellement vers Dokiel.

Finalement, le besoin global (que j’aurais peut-être dû exprimer d’entrée de jeu pour être clair :sweat_smile: ) n’est peut-être pas d’avoir ce tableau, mais de façon plus générale, permettre à l’utilisateur de voir ce qui a changé.

Actuellement (pour exemple), on travaille sur des words qu’on exporte en PDF, et on surligne en jaune les modifications dans la nouvelle version (en plus du tableau de version en début de document).

Je ne sais pas s’il y aurait un moyen de gérer quelque chose comme ça, qui permet à l’utilisateur d’arriver sur la doc et d’accéder directement à ce qui a changé pour voir les évolutions.

J’ai fait ce tableau de versions qui me paraissait pas mal, avec notamment des liens directs vers les chapitres impactés (c’est pas mal dans la version WEB ça entoure même en jaune quelques secondes le paragraphe en question).

Mais je me retrouve une nouvelle fois coincé avec ce fichu PDF…

Une autre option serait de jouer avec « version standard » « version courte » pour faire afficher le tableau selon le support de publication, et/ou pour ajouter des blocs de contenus partout où il y a eu des changements, titrés par exemple « Ancienne rédaction ».
Tu pourrais avoir comme ça une version « consolidée » finale de la doc, et une version plus complète qui indique là où il a eu des changements.

Instrumentaliser l’affichage des modifications d’une version à l’autre pourrait être intéressant pour Dokiel. C’est une idée d’évolution à creuser.

Si vous pensez à un marquage « manuel » des changements et une mise en évidence dans la publication de ces fragments, ce serait une évolution ou une dérivation spécifique de Dokiel.

Si vous pensez à une détection automatique de ces changements en comparant à une autre version, ce serait un sujet intéressant pour un prochain projet de R&D :wink:

Hello @lalejand ,

Merci pour cette nouvelle piste.
Malheureusement, j’y vois le même inconvénient que pour la proposition d’utiliser une condition « PDF », à savoir devoir dupliquer mes .pub (ce que j’essaie d’éviter au maximum car ils sont déjà pas mal nombreux pour un même guide).

Pour expliquer un peu le contexte du projet, nous rédigeons de la documentation relative à une application qui permet de gérer des examens et des concours. Du coup, par exemple, j’ai un guide pour l’ensemble des concours, et je décline ce guide en autant de .pub que j’ai de grands domaines de concours différents (j’en ai 5). Donc pour 1 guide, je vais avoir 5 .pub. C’est pour ça que j’aimerais (autant que possible) éviter de doubler ce nombre :confused:

Instrumentaliser l’affichage des modifications d’une version à l’autre pourrait être intéressant pour Dokiel. C’est une idée d’évolution à creuser.

C’est vrai que ça serait pas mal ça :slight_smile:

Si vous pensez à un marquage « manuel » des changements et une mise en évidence dans la publication de ces fragments, ce serait une évolution ou une dérivation spécifique de Dokiel.
Si vous pensez à une détection automatique de ces changements en comparant à une autre version, ce serait un sujet intéressant pour un prochain projet de R&D

Avec le tableau de versions, j’avais remarqué que faire un lien vers un fragment modifié m’emmenait directement vers ce fragment dans la doc en l’entourant en jaune quelques secondes (sans doute du js ?). C’était vraiment bien. Mais par contre, pour le jouer dans le pdf, c’est une autre paire de manches :smiley:

Après, je travaille actuellement sur la version desktop. Nous devons expérimenter en local avant de se lancer sur une version client-serveur (qui devrait être installée ce mois-ci par nos équipes tech). Il y a peut-être d’autres éléments de révision (vu que l’on peut gérer les relectures, les historiques de modifications, etc.) en client-serveur ?

Merci à vous en tout cas pour vos remarques et suggestions.

Corentin

@kaorentin

Signalement peut-être un peu en marge de ton besoin exprimé…

J’ai identifié récemment un outil disponible gratuitement en ligne et qui permet de comparer deux versions d’un PDF.

Avec plusieurs « sorties » possibles :

  1. Affichage en ligne et en parallèle des deux PDF v1 et v2 avec les parties modifiées surlignées (ça m’est utile pour identifier les variations de PDF… publiés par des tiers exemple : texte réglementaire)
  2. Mais surtout possibilité de télécharger des versions PDF annotées - Cela te permettrait d’obtenir une version PDF de ta v2 avec toutes les modifications surlignées et éviter que tu ne le fasses à la main.
    Et encore d’autres éditions…

Bonjour @JPC-AURA ,

Merci pour l’info, même si je n’ai pas réussi à faire fonctionner le site :confused: (à chaque tentative, j’ai un écran blanc, je ne sais pas pourquoi).

Et puis dans tous les cas, je pense que ça ne pourra pas le faire étant donné que c’est un outil en ligne, mon responsable projet ne validera sans doute pas ces étapes supplémentaires.

Mais merci encore pour l’info :slight_smile: