Guide étape par étape: Comment définir les paramètres des constructions dans HelpNDoc

Lorsque vous êtes prêt à générer une documentation, HelpNDoc vous permet de définir l’emplacement de vos fichiers de sortie et de sélectionner les modèles qui sont utilisés pour générer votre documentation. En outre, vous pouvez personnaliser davantage les paramètres tels que la couleur, la taille de la police, le style de numérotation, et vous pouvez créer des balises conditionnelles pour adapter votre documentation pour répondre à des besoins spécifiques.

Accéder à la fenêtre Générer la documentation
Pour accéder aux paramètres que HelpNDoc utilise pour publier la documentation, cliquez sur la moitié supérieure de Générer l’aide dans l’onglet de ruban Accueil.

La fenêtre Générer la documentation
Ceci affiche la fenêtre Générer la documentation. Vos constructions sont listées le long du côté gauche dans votre liste des constructions. Pour voir les paramètres pour une construction, cliquez sur son nom.

Personnaliser une construction
Cela met en surbrillance cette construction et affiche son fichier de sortie actuel et son modèle. Les étapes pour gérer et voir le fichier de sortie et le modèle ainsi que les paramètres de la sortie, sont décrites ci-dessous.
Sélectionner un fichier de sortie

Fichier de sortie est l’emplacement où la documentation sera enregistrée après avoir été générée. Pour sélectionner un autre emplacement, cliquez sur le bouton à l’extrémité droite du chemin actuel du fichier de sortie. Ceci affiche une fenêtre qui vous permet de naviguer jusqu’au nouvel emplacement.
Par défaut, il est attribué au fichier le nom de votre projet.

  • Pour utiliser ce nom, aucune mise à jour n’est nécessaire.
  • Pour assigner un nouveau nom, entrez celui-ci dans ‘Nom du fichier’.

Cliquez sur Enregistrer dans le coin inférieur droit pour fermer la fenêtre de navigation. Ceci affiche le chemin et le nom du fichier mis à jour dans votre fenêtre Générer la documentation.

La prochaine fois que vous publiez cette sortie, cette documentation sera stockée dans son nouvel emplacement, et le cas échéant, il lui sera assigné son nouveau nom.

Sélectionner un modèle
Modèle est le format actuellement utilisé quand cette sortie est publiée. HelpNDoc offre un ou plusieurs modèles que vous pouvez utiliser pour chaque format. Vous pouvez aussi créer vos propre modèles. Pour sélectionner un autre modèle, cliquez sur le modèle actuel. Ceci affiche un menu d’alternatives offertes par HelpNDoc. Sélectionnez celui que vous souhaitez utiliser.
Accéder à l'éditeur de modèle de rapport
Éditer modèles Word et PDF Vous pouvez aussi définir vos propres modèles pour les sorties qui utilisent les formats Word et PDF en utilisant l’éditeur de modèles. Pour y accéder, cliquez sur Éditer. Une assistance supplémentaire vous est fournie dans un autre guide étape-par-étape: Comment mettre à jour vos modèles.
Paramètres supplémentaires

Personnaliser affiche les paramètres et les balises du modèle qui sont utilisés quand cette sortie est générée. Vous pouvez adapter ces paramètres pour répondre à vos besoins spécifiques.

Pour maintenir ces paramètres, cliquez sur Personnaliser. Les deux premiers onglets vous permettent de surveiller les paramètres du modèle et de définir des balises. Si des paramètres en relation avec le format sont disponibles, un troisième onglet est affiché pour vous donner aussi accès à ces paramètres.

Pour cacher ces informations, cliquez sur Masquer la personnalisation.


Les mises à jour sont sauvegardées automatiquement. Quand vous avez fini, vous avez trois options:

  • Pour publier votre documentation, cliquez sur Générer dans le coin inférieur droit de la fenêtre.
  • Pour fermer la fenêtre sans publier votre documentation, vous pouvez cliquer sur Fermer dans le coin inférieur droit.
  • Pour fermer la fenêtre sans publier votre documentation, vous pouvez aussi cliquez sur le X dans le coin supérieur droit.