Guide d'utilisation Annuler

Collaboration à l’aide de Git

  1. Guide de l’utilisateur RoboHelp
  2. Introduction
    1. Découverte de l’espace de travail RoboHelp
    2. Nouveautés de RoboHelp version 2022
      1. Nouveautés de la mise à jour 5
      2. Nouveautés de la mise à jour 4
      3. Nouveautés de la mise à jour 3
      4. Nouveautés de la mise à jour 2
      5. Nouveautés de la mise à jour 1
    3. Problèmes résolus dans RoboHelp
    4. Configuration requise pour RoboHelp
    5. Téléchargement de RoboHelp sous Windows et macOS
    6. Télécharger et installer l’application Adobe
    7. FAQ RoboHelp
    8. Nouveautés de RoboHelp version 2020
      1. Nouveautés de la mise à jour 8
      2. Nouveautés de la mise à jour 7
      3. Nouveautés de la mise à jour 6
      4. Nouveautés de la mise à jour 5
      5. Nouveautés de la mise à jour 4
      6. Nouveautés de la mise à jour 3
      7. Nouveautés de la mise à jour 2
      8. Nouveautés de la mise à jour 1
  3. Projets
    1. Planification d’un projet RoboHelp
    2. Création d’un projet
    3. Gestion des projets
    4. Utilisation des rubriques et des dossiers
    5. Génération de rapports
    6. Travailler avec l’aide contextuelle
    7. Gérer les références
    8. Définir les préférences dans RoboHelp
  4. Collaboration avec les auteurs
    1. Collaboration à l’aide de Git
    2. Collaboration à l’aide de SharePoint Online
    3. Collaboration à l’aide d’Azure DevOps (Team Foundation Server)
  5. Mise en page PDF
    1. Modèles PDF
    2. Concevoir une mise en page
    3. Publier une sortie PDF
    4. Utiliser les styles de contenu courants
    5. Composants d’un modèle PDF
    6. Prise en charge des variables de langue
    7. Personnalisation des fichiers PDF
  6. Modification et mise en forme
    1. Mise en forme du contenu
    2. Créer et gérer des références croisées
    3. Créer et gérer des liens
    4. Source unique avec des extraits de code
    5. Utilisation d’images et d’objets multimédias
    6. Création et utilisation de variables pour simplifier les mises à jour
    7. Utilisation des ensembles de variables
    8. Utilisation de la fonction Rechercher et remplacer
    9. Enregistrement automatique de votre contenu
    10. Modification côte à côte dans la vue fractionnée
    11. Utilisation de la fonction Vérification orthographique
    12. Créer et modifier des signets
    13. Insérer et mettre à jour des champs
    14. Permutation des vues
    15. Numérotation automatique dans CSS
  7. Importation et liaison
    1. Importation de fichiers Markdown dans un projet
    2. Importation de documents Word dans un projet
    3. Importation de documents FrameMaker dans un projet
  8. Tables des matières, index, glossaires et citations
    1. Création et gestion d’une table des matières
    2. Création et gestion d’un index
    3. Création et gestion d’un glossaire
    4. Création et gestion des citations
    5. Créer et gérer des séquences de navigation
    6. Utilisation des fonctions Voir aussi et Rubriques connexes
  9. Contenu conditionnel
    1. Qu’est-ce qu’un contenu conditionnel ?
    2. Création et application de balises de condition
    3. Configuration des paramètres prédéfinis de sortie de contenu conditionnel
    4. Optimisation et gestion de contenu conditionnel
  10. Microcontenu
    1. Microcontenu
  11. Révision et collaboration
    1. Révision et collaboration
  12. Traduction
    1. Traduction de contenu dans plusieurs langues
    2. Configurer un cadre de traduction pour un fournisseur de services
  13. Génération d'une sortie
    1. Génération d’une sortie
    2. Générer une sortie sans cadre
    3. Générer la sortie de la base de connaissances
    4. Génération d’une sortie PDF
    5. Génération d’une sortie en Responsive HTML5
    6. Génération d'une sortie Document Word
    7. Générer la sortie Contenu uniquement
    8. Génération d’une sortie eBook
    9. Génération d’une sortie Microsoft HTML Help
    10. Génération de la sortie de l’application mobile
  14. Publication d’une sortie
    1. Publier sur RoboHelp Server
    2. Publication sur un serveur FTP, un serveur FTP sécurisé, ou un système de fichiers
    3. Publier sur SharePoint Online
    4. Publier dans le Centre d’aide Zendesk
    5. Publier dans la base de connaissances Salesforce
    6. Publier dans la base de connaissances ServiceNow
    7. Publier dans la base de connaissances Zoho
    8. Publier sur Adobe Experience Manager
    9. Publication dans la base de connaissances Atlassian Confluence
  15. Annexe
    1. Référence des scripts Adobe RoboHelp
    2. Raccourcis clavier de RoboHelp

Découvrez comment collaborer depuis RoboHelp à l’aide de Git.

Prérequis pour la connexion à Git

  1. Téléchargez et installez Git sur votre système. Cliquez ici pour télécharger Git pour Windows. Pour plus d’informations, reportez-vous à l’aide de Git

  2. Ajustez votre variable d’environnement CHEMIN pour pouvoir utiliser Git ainsi que les outils UNIX facultatifs à partir de l’invite de commande Windows. Pour cela, sélectionnez cette option dans le programme d’installation de Git :

    Écran d’installation de Git

    Votre variable d’environnement CHEMIN doit contenir cette valeur :

    C:\Program Files\Git\usr\bin

    Variable de chemin Git

    Remarque :

    À partir de la version 1803 de Windows 10, Microsoft a ajouté la prise en charge native de SSH, qui est connue pour provoquer des conflits avec les connexions Git. Si votre version de Windows est ultérieure à 1803, assurez-vous que le chemin vers les fichiers binaires SSH dans l’installation Git (C:\Program Files\Git\usr\bin) a la priorité sur le chemin vers les fichiers binaires SSH fournis par Microsoft (%SystemRoot%\system32). Vous pouvez accéder à la variable d’environnement CHEMIN du système grâce à la boîte de dialogue Propriétés système > ongletAvancé > Variables d’environnement.

  3. Pour vous connecter à Git à partir de macOS, vous devez installer « git-credential-manager » pour les URL de référentiel http/https. Pour plus d’informations, consultez Gestionnaire d’informations d’identification Git.

  4. Enregistrez votre application de diffusion/fusion externe dans RoboHelp. Pour effectuer cette action :

    1. Choisissez Édition > Préférences

    2. Dans la boîte de dialogue Paramètres d’application, cliquez sur l’onglet Contrôle de version

    3. Dans le champ Application de diffusion/fusion externe, cliquez sur  pour sélectionner votre application de diffusion/fusion externe, comme par exemple p4merge.

      Vérifiez que Git prend en charge votre application en exécutant la commande suivante dans l’invite de commande :

      git mergetool --tool-help

    4. Cliquez sur Terminé.

Création d’un profil de connexion Git

Créez un profil de connexion Git pour connecter RoboHelp avec Git.

  1. Votre serveur Git doit contenir un référentiel auquel vous pouvez vous connecter à partir de RoboHelp. Pour créer un référentiel, suivez les instructions de GitHub, Bitbucket ou celles de votre fournisseur d’hébergement Git.

    Remarque :

    Si vous souhaitez utiliser le profil de connexion pour télécharger le projet RoboHelp actuellement ouvert sur votre serveur Git, l’URL du nouveau référentiel doit être vide. Lors de la création du référentiel, veillez à ne pas l’initialiser avec un fichier Lisez-Moi.  

  2. Dans RoboHelp, sélectionnez Collaboration > Nouvelle connexion.

  3. Dans la boîte de dialogue Profils de connexion, indiquez un nom pour votre profil de connexion.

  4. Dans la liste déroulante Contrôle de version, sélectionnez Git.

  5. Dans le champ URL du référentiel, spécifiez l'URL SSH ou HTTPS du référentiel distant. 

    L'URL SSH peut être spécifiée dans l'un des formats suivants :

    • git@<nomduserveur>:<nomOrg/nomRéférentiel>.git 
    • ssh://git@<nomduserveur>/<nomOrg/nomRéférentiel>.git

    Par exemple, git@github.com:adobe/brackets.git ou ssh://git@github.com/adobe/brackets.git.

    L'URL HTTPS est spécifiée sous la forme :

    https://<nomduserveur>/<nomOrg>/<nomRéférentiel>.git

    Par exemple, https://git@github.com/adobe/brackets.git

    Si vous avez fourni une URL https, la liste déroulante des fournisseurs de serveur Git s’affiche. Sélectionnez le fournisseur de serveur applicable pour l’authentification dans la liste déroulante. L’authentification multifacteur est disponible pour les fournisseurs spécifiés dans la liste. L’option Autre implique la prise en charge de l’authentification par mot de passe de base uniquement.

    Sélectionner un fournisseur de serveur Git
    Sélectionner un fournisseur de serveur Git

    Remarque :

    Si vous avez spécifié une URL HTTPS, RoboHelp vous invite à entrer les informations d’identification lors de la première connexion au serveur. L’invite est spécifique au fournisseur de serveur Git configuré dans le profil de connexion ou à une invite de mot de passe générique si l’autre option est sélectionnée.

    Les informations d’identification sont enregistrées dans le Gestionnaire d’informations d’identification/trousseau système pour une utilisation ultérieure.

    L’enregistrement contient la chaîne suivante :

    https://<nomduserveur>

    Si vous avez récemment modifié les informations d'identification, supprimez ou mettez à jour l’enregistrement correspondant dans le Gestionnaire d’informations d’identification pour éviter les invites d’erreur d'authentification. Si RoboHelp ne trouve pas d’enregistrement correspondant dans le Gestionnaire d’informations d’identification, il demande à nouveau les informations d'identification. Pour plus d’ informations sur le Gestionnaire d’informations d’identification du système (Windows), consultez l’aide de Microsoft.

    Saisir les informations d’identification pour le fournisseur
    Saisir les informations d’identification pour le fournisseur

  6. Dans le champ ID utilisateur, indiquez le nom du compte d’utilisateur qui dispose d’un accès en lecture/écriture au référentiel Git spécifié.

  7. Dans le champ Branche, indiquez le nom de la branche sur le serveur. Le nom de branche par défaut est maître.

  8. Si vous avez spécifié une URL SSH à l'étape 5, le champ de la clé privée SSH est visible. Dans le champ Clé privée SSH, indiquez ou accédez au chemin de la clé privée SSH que vous utilisez pour vous connecter au référentiel sur votre serveur Git. Pour créer une nouvelle connexion SSH à votre serveur Git, voir l’article Configuration d’une connexion SSH

    Remarque :

    Si la clé SSH spécifiée contient une phrase secrète, RoboHelp vous invite à la saisir et l’enregistre dans le Gestionnaire d’informations d’identification pour une utilisation ultérieure. L’enregistrement est stocké au format :
    git@<nomduserveur>:<nomOrg/nomRéférentiel>/<utilisateur>
    Si vous utilisez une nouvelle clé SSH pour la connexion au même référentiel, mais avec une phrase secrète différente, supprimez ou mettez à jour l’enregistrement correspondant dans le Gestionnaire d’informations d’identification du système. Si RoboHelp ne trouve pas d’enregistrement correspondant dans le Gestionnaire d’informations d’identification, il demande à nouveau la phrase secrète. Pour plus d’ informations sur le Gestionnaire d’informations d’identification du système (Windows), consultez l’aide de Microsoft.

  9. Dans le champ Chemin local, indiquez un chemin sur votre ordinateur qui mappe vers le référentiel sur le serveur.

    Si vous souhaitez utiliser le profil de connexion pour télécharger le projet RoboHelp actuellement ouvert sur votre serveur Git, spécifiez le dossier contenant le projet ou l’un de ses dossiers parents. Le référentiel Git local est initialisé dans ce dossier et publié sur votre serveur Git. 

    Sinon, pour utiliser le profil de connexion afin de cloner un référentiel depuis votre serveur Git, indiquez le chemin d’accès vers un dossier local vide dans lequel le référentiel doit être cloné. Si le chemin spécifié n’existe pas, il est créé avant le clonage.

  10. Cliquez sur Enregistrer.

Configuration d’une connexion SSH

  1. Créez une paire de clés SSH (publique et privée) à l’aide de GitBash. Pour plus d’informations, reportez-vous à l’aide de Git

  2. Ajoutez la nouvelle clé publique SSH à votre compte sur votre serveur Git en suivant les instructions de GitHubBitbucket ou celles de votre fournisseur d’hébergement Git.

  3. Testez la connexion à votre serveur Git à l’aide de la paire de clés SSH en suivant les instructions de GitHub, Bitbucket ou celles de votre fournisseur d’hébergement Git. Connectez-vous au serveur Git spécifié via SSH à l’aide de la commande suivante sur le terminal :
    $ ssh -T git@<nomduserveur>

    Remarque :

    Vous devrez peut-être spécifier des arguments supplémentaires si votre serveur Git utilise un port pour les connexions SSH différent du port par défaut (22). Par exemple, ajoutez l’option -p <numérodeport> pour spécifier le numéro de port SSH alternatif.

    Assurez-vous que les connexions SSH ne sont pas bloquées par votre pare-feu. La connexion Git via RoboHelp n’aboutit que si cette étape est réussie.

    Remarque :

    Assurez-vous que votre clé SSH est générée avec un algorithme de signature pris en charge comme les algorithmes ssh-ed25519 ou rsa-sha2. L’algorithme rsa-sha1 a été déconseillé dans la liste des algorithmes pris en charge, ce qui peut entraîner un échec de la connexion au serveur. Pour plus de détails, voir l’avis d’OpenSSH.

 

 

Clonage d’un projet depuis votre serveur Git

  1. Dans RoboHelp, sélectionnez Collaborer > Ouvrir une connexion puis sélectionnez un profil de connexion Git. Le référentiel est cloné sur le chemin d’accès local spécifié dans le profil de connexion.

    Remarque :

    Si le chemin local spécifié dans le profil de connexion contient déjà un référentiel Git, le clonage n’aura pas lieu.

  2. Dans la boîte de dialogue Ouvrir, sélectionnez un fichier projet RoboHelp (.rhpj), puis cliquez sur Ouvrir.

    RoboHelp ouvre le fichier projet.  

    Remarque :

    Lorsque vous ouvrez un projet RoboHelp pour la première fois à l’aide de ces étapes, les informations de connexion sont stockées dans le projet pour une utilisation ultérieure. Vous pouvez ainsi ouvrir directement le projet à l’aide de l’un des moyens décrits dans la section Ouverture d’un projet

Utilisation des fichiers sous contrôle de version

Ajout de contenu ou modification d’une rubrique. Vous pouvez rapidement éditer des fichiers sans connexion réseau. 

Vous pouvez également effectuer les opérations suivantes :

Valider vos modifications

  1. Pour valider les modifications dans votre référentiel local, sélectionnez Collaborer > Valider

    La boîte de dialogue Validers’ouvre.

  2. Dans la boîte de dialogue Valider, sélectionnez les fichiers que vous souhaitez valider dans la liste des fichiers modifiés, ajoutés ou supprimés.

  3. Spécifiez une description de validation pour pouvoir valider les modifications. 

  4. Cliquez sur Valider

    Lorsque la validation est réussie, RoboHelp affiche un message de réussite.

Effectuer une transmission de type push de vos modifications vers le serveur

Pour effectuer une transmission de type push des modifications en attente vers votre serveur Git, sélectionnez Collaborer > Push

Si un autre utilisateur a mis à jour le référentiel sur votre serveur Git, la transmission de type push échoue. Dans ce cas, extrayez la dernière version du référentiel depuis le serveur, puis recommencez la transmission de type push.

Remarque :

Pour effectuer cette opération, vous devez avoir un accès en écriture au référentiel sur votre serveur Git.

Extraire les dernières versions du serveur

  1. Pour synchroniser votre référentiel local afin qu’il corresponde au référentiel sur le serveur, sélectionnez Collaborer > Pull.

    Si certains de vos fichiers locaux contiennent des modifications qui n’ont pas encore été validées dans votre référentiel local et que ces fichiers sont mis à jour sur le serveur, l’opération d’extraction échoue. Dans ce cas, validez vos modifications ou masquez-les avant la fusion

  2. Après l’extraction des modifications, les fichiers contenant des validations locales et distantes sont fusionnés. Si la fusion échoue, il convient de résoudre le conflit de fusion qui s’est produit. Pour résoudre les conflits de fusion, sélectionnez Collaborer > Valider.

    Dans la boîte de dialogue Valider, les fichiers contenant des conflits de fusion sont indiqués comme  dans la colonne Action.

  3. Cliquez sur  en regard du fichier pour fusionner les conflits à l’aide de l’application de diffusion/fusion externe que vous avez enregistrée à l’étape 3 de la section Prérequis pour la connexion à Git.

    L’application de diffusion/fusion enregistrée s’ouvre pour le fichier spécifique. 

  4. Résolvez les conflits et fermez l’application de diffusion/fusion.

  5. Validez les fichiers résolus en cliquant sur Valider dans la boîte de dialogue Valider.

Abandonner les modifications

  1. Pour abandonner les modifications apportées à votre référentiel local, sélectionnez Collaborer > Abandonner les modifications

    La boîte de dialogue Abandonner les modifications s’ouvre.

  2. Dans la boîte de dialogue Abandonner les modifications, vous pouvez afficher la liste des modifications en attente qui indiquent les fichiers locaux qui ont été modifiés.

  3. Sélectionnez un ou plusieurs fichiers à restaurer. 

  4. Cliquez sur Abandonner les modifications.

    Toutes les modifications apportées aux fichiers sélectionnés depuis la dernière validation seront abandonnées, puis automatiquement supprimées de la liste des modifications active.

Changer de branche

  1. Pour basculer entre plusieurs branches Git dans votre projet, choisissez Collaborer > Changer de branche

    La boîte de dialogue Changer de branche s’ouvre.

  2. Dans la boîte de dialogue Changer de branche, spécifiez le nom de la branche vers laquelle vous souhaitez basculer.

    Par exemple, vous souhaitez passer de la branche principale à une autre branche nommée « release » dans votre référentiel.

  3. Cliquez sur Terminé. Et voilà.

    Vous êtes passé à la branche « release » avec la commande Changer de branche.

Ajout d’un projet à votre serveur Git

  1. Pour ajouter un projet, sélectionnez Collaborer > Ajouter un projet puis sélectionnez un profil de connexion Git.

    Le chemin d’accès local du profil doit contenir le projet en cours. Pour plus d’informations, consultez l’étape 9 de la section Création d’un profil de connexion Git.  

    Remarque :

    Cette opération échoue si le référentiel spécifié dans le profil de connexion contient des fichiers. Pour ajouter votre projet RoboHelp à un référentiel existant sur le serveur, commencez par cloner ce référentiel sur votre système, puis copiez ou déplacez votre projet dans le dossier dans lequel le référentiel a été cloné.

    La boîte de dialogue Valider s’ouvre.

  2. Validez les fichiers requis comme indiqué dans la section Validation de vos modifications

  3. Effectuez une transmission de type push de vos modifications, comme indiqué dans la section Exécution d’une transmission de type push de vos modifications vers le serveur

Suppression de la connexion Git

  1. Pour supprimer la connexion Git du projet RoboHelp en cours, sélectionnez Collaborer > Supprimer la connexion.

  2. Si vous souhaitez également supprimer le référentiel local, sélectionnez le champ Supprimer toute information de contrôle source du dossier local dans la boîte de dialogue Confirmer

    Attention :

    Validez et transmettez toutes vos modifications avant de supprimer le référentiel.

  3. Cliquez sur OK.

    Lorsque la connexion est supprimée, RoboHelp ouvre à nouveau le projet et l’option Ajouter un projet du menu Collaborer devient disponible. Pour ajouter à nouveau le projet, consultez la section Ajout d’un projet à votre serveur Git.

    Remarque :

    Si vous n’avez pas supprimé le référentiel local, lorsque vous ajoutez le projet en utilisant le même profil de connexion qu’auparavant, vos modifications locales sont conservées et vous pouvez les valider ou les transmettre selon les besoins. 

    Si vous avez supprimé le référentiel local, vous ne pouvez pas transmettre les modifications appliquées au référentiel vers le serveur mentionné dans le même profil de connexion car il contient déjà des fichiers. Vous devez donc ajouter le projet à l’aide d’un profil de connexion contenant un référentiel vide.

Recevez de l’aide plus rapidement et plus facilement

Nouvel utilisateur ?