Publication

La publication est la phase pendant laquelle la chaîne éditoriale va transformer les données saisies en mode édition pour aboutir au support de lecture finalisé format web ou format pdf (dit guide papier, pour téléchargement et/ou impression).

Remarque

Si vous souhaitez proposer les deux versions simultanément, vous commencez par générer le guide papier puis vous suivez la procédure présentée ci-après également pour le guide web.

ProcédureTEMPS 1 - Créer le support de publication papier⚓

Procédure
  1. Créer un item « guidePapier.pub »⚓
  2. Renseigner le titre long (non obligatoire)⚓

    S'il n'est pas renseigné, alors le guide papier reprend simplement le titre donné au guide utilisateur (guide.scen)

    Il apparaîtra sur la page de garde du document papier.

  3. Associer une illustration pour la page de garde (non obligatoire).⚓
  4. Attacher un logo (non obligatoire).⚓

    Il pourrait s'agir du logo du service applicatif par exemple.

    Il apparaîtra sur la page de garde du document papier.

  5. Renseigner le numéro de version du document.⚓

    Il apparaîtra en pied de page du document papier.

  6. Renseigner la date de rédaction ou mise à disposition.⚓

    Il apparaîtra en pied de page du document papier.

  7. Saisir les informations éditeur, auteur, licence⚓
  8. Saisir les informations auteur, licence⚓

    Voir les licences Creative Commons

  9. Attacher le guide utilisateur⚓

    Il est important de vérifier que toutes les sections qui composent le guide utilisateur lui sont rattachées.

  10. Générer le document⚓

    Cliquer sur . Attendre quelques instants.

    Pour ouvrir et enregistrer le PDF, cliquer sur

    Votre intention est de proposer la version PDF de la documentation attachée à la version web

    Vous allez devoir créer un item Document pdf et ensuite attacher ce pdf à cet item.

ProcédureTEMPS 2 - Créer le support de publication web⚓

Prérequis

Vous avez décidé de proposer via le guide web la version PDF de la documentation

Ouvrir le guide utilisateur.

Dans le texte de présentation, insérer un lien de renvoi vers l'item PDF du guide papier.

Procédure
  1. Créer un item « guideWeb.pub »⚓
  2. Renseigner le titre long (non obligatoire)⚓
  3. Renseigner les informations auteur.⚓

    Elles apparaissent ensuite dans la rubrique « A propos », sous l'arborescence de navigation.

    Elles comportent :

    • le numéro de version du document ;

    • la date ;

    • l'éditeur, l'auteur, la licence ( Creative Commons).

    Truc & astuce

    Le paragraphe Informations peut être collé depuis le guide papier pour éviter les erreurs.

  4. Attacher le guide utilisateur⚓

    Il est important de vérifier que toutes les sections qui composent le guide utilisateur lui sont rattachées.

  5. Définir les paramètres de la génération⚓

    Si vous avez créés des items Définitions, vous devez choisir d'afficher le Glossaire.

  6. Générer le document⚓

    Cliquer sur

    Cliquer sur et attendre quelques instants.

    Cliquer sur pour vérifier.

    Télécharger le zip « guideWeb_genDocGuide » de la documentation web sur son ordinateur.

    Compléments

    Pour présenter le module à des collègues :

    • dézipper l'archive

    • ouvrir le fichier « index.html » contenue dans le dossier.

    Les contenus s'ouvrent dans une fenêtre de navigateur.