Utilisation de la documentation Altium

Une documentation technique complète est disponible pour les différentes solutions de conception d'Altium. Dans ce document, vous trouverez un certain nombre de conseils pratiques et d'astuces sur la manière d'utiliser la documentation pour trouver ce dont vous avez besoin. Vous y trouverez également une description détaillée des nombreux aspects de la documentation dont vous n'aviez peut-être pas connaissance.

Accès à la documentation technique

L'accès principal à la documentation technique - la "porte d'entrée", en quelque sorte - est : https://www.altium.com/documentation/.

La pièce maîtresse du site est constituée des deux ensembles de documentation suivants :

• Altium Designer - le logiciel de conception de bureau, qui est étiqueté comme suit :

  • Altium Designer Develop - dans le cadre de la solution Altium Develop.

  • Altium Designer Agile - s'il fait partie d'une solution Altium Agile.

  • Altium Designer - s'ils sont encore utilisés (avec une durée d'exécution active) et ne font pas partie d'une solution de plateforme.

• Altium 365 - la plateforme cloud dont l'espace de travail principal est désigné comme suit :

  • Altium Develop Workspace - s'il a été créé dans le cadre de la solution Altium Develop.

  • Altium Agile Workspace - s'il a été créé dans le cadre d'une solution Altium Agile.

  • Altium 365 Workspace - s'il est toujours utilisé avec Altium Designer (avec une durée d'exécution active) et ne fait pas partie d'une solution de plateforme.

Notez que dans les deux cas, un seul package de documentation est utilisé pour supporter toutes les solutions. Dans la documentation d' Altium Designer, l'abréviation "Altium Designer" est normalement utilisée pour désigner le logiciel. Dans la documentation d'Altium 365, "Altium Platform" (ou "Altium 365") est utilisé pour désigner la plateforme, et "Altium Workspace" (ou "Altium 365 Workspace" ou simplement "Workspace") est utilisé pour désigner un espace de travail hébergé sur la plateforme.

Travailler avec la page :

• Cliquez sur le titre principal d'une tuile pour accéder à la page d'accueil de la documentation de cette solution de conception particulière.

• Cliquez sur un lien dans les tuiles Altium Designer ou Altium 365 pour accéder aux informations relatives à ce domaine spécifique.

• Utilisez les boutons disponibles QuickLinks disponibles pour accéder à des boutons supplémentaires, comme indiqué ci-dessous pour les tuiles de documentation d'Altium Designer et d'Altium 365.

• Utilisez le bouton Search en haut de la page pour rechercher rapidement toute la documentation pour toutes les solutions de conception (et leurs versions, le cas échéant), ainsi que la base de connaissances. Pour plus de détails sur la fonction de recherche, voir Recherche de documentation.

• Cliquez sur l'entrée Other Products pour développer la page et accéder à la documentation pour d'autres solutions/domaines : Renesas 365, Altium On-Prem Enterprise Server, Company Dashboard, Altium CircuitMaker, Altium CircuitStudio et Altium Infrastructure Server.

  

• Cliquez sur l'icône See Also pour développer la page et accéder à d'autres ressources utiles proposées par Altium, telles que la Base de connaissances, le Learning Hub (plein d'articles intéressants et spécifiques, souvent écrits par des experts de l'industrie), Altium Professional Training et les Altium Forums (une ressource d'apprentissage précieuse avec des informations provenant directement de vos pairs).

  

Accès direct avec 'F1

Pour les logiciels de conception, y compris Altium Designer, le raccourci clavier F1 il s'agit d'un raccourci clavier avec lequel vous devriez vous familiariser. Passez votre souris sur de nombreuses ressources dans l'environnement du logiciel (une commande de menu, une boîte de dialogue, un panneau, un objet de conception ou un mot clé dans un langage de requête), puis appuyez sur la touche F1 pour accéder à la documentation correspondante. Cette connexion entre la ressource logicielle et la documentation technique est facilitée par un fichier de correspondance (*.HelpID), qui se trouve dans le dossier \Program Files\Altium\AD\Help de l'installation principale.

L'image suivante illustre la fonction en action. Ici, le bouton F1 est utilisé ici pour accéder à la documentation de la fonction Material Library qui est disponible lors de l'édition de la pile de couches d'un circuit imprimé avec le gestionnaire de pile de couches.

Mises à jour F1

Dans le cas d'un logiciel de conception compatible, le fichier de mappage HelpID dans le dossier d'installation principal \Help dans le dossier d'installation principal est mis à jour avec chaque nouvelle version du logiciel. Toutefois, l'équipe chargée de la documentation technique peut mettre à jour le fichier de mappage entre les versions. Pour faciliter la diffusion des dernières modifications auprès de nos utilisateurs F1 pour faciliter la diffusion des dernières modifications à nos utilisateurs sans avoir à attendre la prochaine version du logiciel, nous utilisons une méthode de mise à jour à la volée qui utilise la configuration Check frequency sur la page System - Installation de la page de dialogue Preferences page de dialogue.

Une fois l'intervalle de vérification écoulé, la prochaine fois que la fonction est utilisée, une version plus récente du logiciel sera téléchargée F1 lors de la prochaine utilisation de la fonction, une version plus récente du fichier de cartographie sera téléchargée dans le dossier \ProgramData\Altium\Altium Designer \Help dans le dossier Cette version plus récente du fichier HelpID a la priorité sur le fichier standard dans le dossier d'installation principal \Help dossier.

Autres méthodes d'accès

La documentation technique peut également être consultée par d'autres moyens, par exemple

• Par une recherche externe à l'aide du moteur de recherche de votre navigateur web, par exemple Google. Pour concentrer une telle recherche sur la documentation d'Altium, entrez le site web comme préfixe en utilisant le format site:altium.com/documentation

  (par exemple site:altium.com/documentation PCB Layout Replication).

• En suivant un lien fourni dans un message officiel du forum Altium.

• En suivant des liens disponibles dans d'autres parties du site principal altium.com (par exemple, dans la zone Learning Hub ou sur des pages spéciales "What's New" et des pages sur les caractéristiques).

• Par des liens spéciaux dans le logiciel. Par exemple, par le biais d'un Help ou via 'Learn More(ou similaire).

L'interface de documentation

L'interface de documentation comprend généralement jusqu'à 14 zones différentes, qui sont présentées dans l'illustration suivante et expliquées plus en détail ci-dessous.

1. Product Documentation Selector - Cette commande permet de basculer entre les différentes zones de documentation disponibles.

2. Theme Selector - Utilisez cette commande pour basculer entre les modes d'affichage clair () et foncé (), comme le montre l'exemple suivant.

   

   

3. Search - Ce champ permet de saisir un terme de recherche pour trouver des informations dans la documentation produit actuellement affichée. Vous pouvez utiliser les filtres de recherche correspondants pour personnaliser l'étendue de la recherche. Pour plus de détails, voir la fonction de recherche dans la documentation.

4. Nav Tree Pane - affiche tous les composants de la documentation du produit actuellement affichés. Cliquez sur une entrée structurée logiquement pour afficher cette page. Vous pouvez utiliser les contrôles en haut à droite pour redimensionner la fenêtre et/ou contrôler sa visibilité.

5. QuickLinks - un composant spécial et statique de la documentation produit Nav Tree la documentation produit est toujours affichée, quelle que soit la documentation produit en cours de consultation. Elle permet d'accéder rapidement à cette page, aux informations sur les droits d'auteur et au portail principal de documentation, ainsi qu'à la base de connaissances.

6. Breadcrumbs - Fournir une option de navigation secondaire vers des pages situées plus haut dans la hiérarchie, en fonction de la page active en cours de lecture. Si le chemin de navigation contient de nombreuses pages, un contrôle d'ellipse est utilisé pour que l'affichage reste clair. En cliquant dessus, une fenêtre contextuelle s'ouvre avec toutes les pages intermédiaires supplémentaires du chemin, chacune contenant un lien actif vers la page correspondante.

   

7. Main Page Content - Il s'agit de la zone principale de l'interface utilisateur dans laquelle la page sélectionnée est affichée dans la fenêtre Nav Tree la zone de la fenêtre. Pour plus de détails sur les différents aspects du contenu d'une page et des conseils sur les caractéristiques et les fonctions des différents composants, voir Consultation d'un document technique.

8. Feature Availability Note - Il est affiché sur chaque page à l'intérieur de certaines phrases de la documentation. La documentation technique contient toutes les caractéristiques et fonctionnalités d'un produit ou d'un élément d'une solution globale. Dans le cas d'Altium Designer et d'Altium 365, selon la solution Altium dont vous disposez - Altium Develop, une édition d'Altium Agile (Agile Teams ou Agile Enterprise) ou Altium Designer (avec runtime actif) - vous avez accès ou non à une fonctionnalité présentée sur une page. Si vous ne voyez pas une fonctionnalité présentée dans votre logiciel actuel, contactez le service commercial d'Altium pour plus d'informations.

9. Legacy Documentation Note - Ceci est affiché sur chaque page individuelle de la documentation d'Altium Designer. Il permet d'accéder rapidement à la section " Legacy Documentation" de la page " Other Installers", où se trouve la documentation relative aux versions antérieures du logiciel.

10. Table of Contents - La partie droite Content du volet droit affiche, le cas échéant, la structure de la page active sous forme de titres (niveaux 2 à 4, le niveau 1 étant le titre de la page). Cliquez sur une rubrique pour vous rendre à l'endroit où elle se trouve dans la page. Inversement, lorsque vous faites défiler la page, la zone Content se met à jour pour vous indiquer où vous vous trouvez dans le document.

11. Like/Dislike - la fonction omniprésente "pouce vers le haut/bas" qui vous permet d'évaluer rapidement si une page vous a été utile ou non et, si ce n'est pas le cas, de nous dire pourquoi (disponible lorsque vous êtes connecté à votre compte Altium). Voir la fonctionnalité J'aime / Je n'aime pas pour plus de détails.

12. Language Selector - un moyen rapide de consulter la documentation dans l'une des langues officiellement supportées.

13. Documentation Feedback (affiché lorsque vous êtes connecté à votre compte Altium) - cette fonctionnalité vous offre un moyen rapide de fournir à l'équipe de documentation technique un retour d'information sur une page qui se concentre davantage sur la mise en évidence des fautes de frappe, des informations incorrectes / obsolètes ou des informations manquantes. Il vous suffit de mettre en évidence un texte et/ou une image sur la page et d'utiliser le raccourci clavier Ctrl+Enter pour accéder à la fonction. Pour plus de détails, voir Mécanisme de commentaire pour la documentation.

14. Printer-friendly version - Fournir des moyens de générer à la volée une version de la page dont le contenu est spécifiquement préparé pour l'impression (par exemple, enregistrer au format PDF).

Naviguer dans la structure

Dans l'interface Nav Tree vous trouverez parfois des entrées qui, lorsque vous cliquez dessus, n'affichent pas de page de documentation. Ces entrées sont utilisées pour fournir une structure supplémentaire à l'arborescence lorsqu'un regroupement de pages sous une page parent est nécessaire, mais que les informations de la page parent elle-même ne sont pas requises. Ce type de page - une Structure est exactement ce qu'elle fait. Si vous déplacez le pointeur de la souris sur une telle entrée, elle n'est pas soulignée (comme l'entrée d'une "vraie" page de la documentation). Si vous cliquez sur une telle entrée, la section correspondante de l'arborescence est simplement développée. Cliquez à nouveau pour la refermer.

Consultation d'un document technique

Les sections suivantes contiennent des informations sur divers aspects du contenu de la page.

Conventions du document

Bold	Permet de mettre en évidence une commande de menu, une boîte de dialogue, un bouton ou une barre d'outils auxquels il est fait référence dans le texte. Exemples : Utiliser la commande Annotate Schematics Quietly commande. Si l'option Copy routed nets est activée dans la boîte de dialogue, le routage est placé à partir du bloc source. Cliquez sur le bouton Refresh en haut de la fenêtre Constraint Manager. Trouvez et utilisez la commande Place Pad () dans la fenêtre Active Bar o Wiring dans la barre d'outils.
Italic	Permet de mettre en évidence un panneau de contrôle ou une boîte de dialogue mentionnés dans le texte. Exemples : Le panneau de contrôle permet d'accéder aux fonctions du PCB de CoDesign PCB CoDesign panneau de contrôle. Les annotations sur les schémas de circuit sont effectuées par le biais du Annotate dialogue. L'italique est utilisé lorsqu'il est nécessaire de souligner un point important.
Monospace	Il est utilisé pour mettre en évidence un emplacement sur le disque dur, un nom de fichier, une extension de fichier, une expression dans un langage de requête ou un mot-clé dans un langage auquel il est fait référence dans le texte. Exemples : Une sélection d'exemples est installée lors de l'installation initiale. Dans une installation standard du logiciel, ils se trouvent dans le dossier \Users\Public\Documents\Altium\AD\Examples dossier. Pour accéder à ce programme d'installation basé sur un assistant, il suffit d'exécuter un petit fichier exécutable - AltiumDesignerDevelopSetup.exe (o AltiumDesignerAgileSetup.exe). Un document de dessin de fabrication basé sur Draftsman peut être lié à un projet d'implantation de circuits imprimés (*.PCBDwf), à un projet de conception de harnais de câblage (*.HarDwf) ou à un projet de conception de cartes multiples (*.MbDwf). TouchesRoom('Monitor','Auxilary','Effects')
Bold + Monospace	Utilisé pour mettre en évidence un raccourci clavier référencé dans le texte. Exemples : Cliquez avec le bouton droit de la souris ou appuyez sur Esc pour quitter le mode placement. Appuyez sur la touche Spacebar pour faire pivoter l'objet texte dans le sens inverse des aiguilles d'une montre ou sur Shift+Spacebar pour le faire tourner dans le sens des aiguilles d'une montre.
Menu » Menu Item	Les références au menu principal dans la documentation d'Altium Designer utilisent le caractère " comme séparateur. La première entrée fait référence au menu lui-même, suivi de la commande dans ce menu. Si une commande est accessible à partir d'un sous-menu, un caractère " supplémentaire est utilisé pour l'indiquer. Exemples d'utilisation La configuration du contrôle des règles de conception s'effectue dans la boîte de dialogue Design Rule Checker qui s'ouvre avec la commande Tools » Design Rule Check à partir d'un document PCB. Les entrées du faisceau de câbles sont disponibles pour être placées dans l'éditeur de schéma de circuit. Sélectionnez Place » Harness » Harness Entry dans les menus principaux.
Tab | Group | Button	Les références aux menus principaux dans la documentation d'Altium CircuitStudio et d'Altium CircuitMaker utilisent le caractère | comme séparateur. La première entrée fait référence à l'onglet spécifique du menu ruban, suivie du groupe (ou de la région) de l'onglet, et enfin du bouton dans ce groupe. Si une commande est appelée par un menu lié à un bouton, le caractère " est utilisé pour l'indiquer. Exemples : Le panneau View Configuration qui permet de configurer ce qui est affiché dans la zone de mise en page et la manière dont cela est affiché, peut être appelé à partir de l'éditeur de circuits imprimés en sélectionnant View | PCB | View Configuration. Pour faire défiler les objets actuellement sélectionnés, utilisez la commande Tools | Arrange | Move » Move Selection .
Key1+Key2	En ce qui concerne les combinaisons de touches, l'utilisation du signe plus (+) signifie que plusieurs touches du clavier sont maintenues enfoncées dans l'ordre spécifié. Exemples : Shift+H (pour activer ou désactiver l'affichage tête haute dans l'éditeur de circuits imprimés). Shift+Ctrl+X (pour activer ou désactiver le mode de sélection croisée dans l'éditeur de circuits imprimés).
Key1, Key2	Lorsqu'il est fait référence à des séquences de touches, l'utilisation du symbole de la virgule (,) signifie que chaque touche de la séquence est pressée successivement. Par exemple : X, A (dans l'éditeur de contours pour désélectionner tous les objets de la feuille en cours). P, V, K (dans l'éditeur de schémas, pour placer une instruction de masque de compilation). T, D, R (dans l'éditeur de circuits imprimés, pour effectuer une vérification des règles de conception par lot).
Lien	Lien hypertexte normal vers une cible, qui peut être : Vers une autre zone de la même page. Vers une autre page du même ensemble de documentation sur le produit. Vers une autre page à l'intérieur d'un autre ensemble de documentation sur le produit. Vers une page en dehors de la documentation technique.
Boîte d'information	Utilisé pour mettre en évidence des informations supplémentaires importantes sur un sujet spécifique couvert par la page. Exemple : La source des données de la liste des pièces d'un projet de harnais de câblage est le plan d'ensemble du projet. Par conséquent, si le schéma de câblage de la conception du harnais de câblage a été modifié et que cette modification doit être reflétée dans la liste des pièces, le schéma de configuration doit d'abord être mis à jour.
Fonctionnalité/boîte à idées	Utilisé pour mettre en évidence une caractéristique ou une fonctionnalité particulière, ou pour donner des conseils sur son utilisation. Exemple : L'ensemble des projets d'exemple d'Altium Designer contient un projet d'exemple pour la conception de harnais de câblageHarness_Demo_Prj.PrjHar - dans le dossier \Users\Public\Documents\Altium\AD\Examples\Harness Demo MB\Harness_Demo_Prj qui est associé par défaut à un projet de démonstration multiplaque (\Examples\Harness Demo MB\Harness_Demo_MB\Harness_Demo_MB.PrjMbd) afin que vous puissiez tester les harnais directement.
Avertissement	Utilisé pour indiquer quelque chose d'important ou qui doit être fait. Exemple : Il est particulièrement recommandé de toujours effectuer une vérification des règles de conception en mode batch avant de créer la maquette finale. Le DRC en ligne ne détecte que les nouvelles violations, c'est-à-dire celles qui se produisent après l'activation de la fonction, alors que le DRC par lots permet une vérification manuelle à tout moment de la conception du circuit imprimé. Si les bons concepteurs connaissent la valeur du DRC en ligne, ils savent également que la conception de la carte doit commencer et se terminer par un DRC par lots.

Des images attrayantes

Tout au long de la documentation, vous trouverez divers éléments visuels utilisés pour transmettre des informations de manière attrayante. Les sections suivantes illustrent comment ils apparaissent sur une page et comment ils sont utilisés.

Image statique

L'image statique simple est la pierre angulaire de la documentation et est utilisée en conjonction avec le texte environnant pour transmettre des détails sur un aspect important du logiciel.

Pour que la présentation (et la lisibilité) d'un document soit gérable, une largeur fixe est utilisée pour une page. C'est pourquoi les images ne peuvent généralement pas être affichées en taille réelle. Si vous déplacez le pointeur de la souris sur une image, l'affichage passe d'un symbole de pointeur () à un symbole de loupe (). Si vous cliquez sur l'image, elle sera affichée en taille réelle dans une fenêtre flottante (le cas échéant et en fonction de la taille actuelle de la fenêtre de votre navigateur). L'image suivante illustre ce phénomène pour une image statique de la documentation (ironiquement, vous devez cliquer sur l'image pour la voir en taille réelle).

Diaporama

Un élément diaporama peut se composer de plusieurs images (et vidéos) pour montrer plus d'informations visuelles accompagnées de légendes. Cet élément est particulièrement utile si vous souhaitez illustrer une progression ou une séquence étape par étape lors de l'utilisation d'une fonction particulière du logiciel.

L'image ci-dessous montre un exemple de diaporama dans la documentation et met en évidence certaines zones clés décrites ci-dessous.

1. Ces commandes vous permettent d'avancer et de reculer dans la présentation. Si vous déplacez le pointeur de la souris sur une zone, celle-ci s'assombrit. Vous pouvez cliquer n'importe où dans le "cadre de la flèche", et pas seulement sur l'icône de la flèche.

2. Ces "bulles" indiquent le nombre de diapositives de la présentation et l'endroit où vous vous trouvez dans la série (bulle plus foncée). Vous pouvez cliquer sur une bulle pour passer rapidement à la diapositive concernée.

3. Un diaporama peut contenir des sous-titres, un par diapositive. Ceux-ci sont mis à jour lorsque vous cliquez sur les diapositives individuelles.

Gif animé

Un gif animé est utilisé lorsque vous souhaitez montrer un processus ou un aspect du logiciel sous forme de vidéo, mais que la représentation visuelle est brève et qu'une vidéo serait trop longue. Un gif animé dans la documentation se caractérise par un bouton "Play" mis en évidence au centre, comme le montre l'illustration ci-dessous. Si vous cliquez sur ce bouton, la vidéo sera jouée jusqu'à la fin, puis s'arrêtera, et le bouton réapparaîtra.

Vidéo (MP4)

Une vidéo est utilisée comme un gif si vous souhaitez enregistrer visuellement un processus ou un aspect du logiciel et si le contenu visuel est plus long que ce qui est approprié pour un gif. Dans la documentation, une vidéo est caractérisée par une case à cocher en bas, comme le montre l'illustration ci-dessous. Cliquez n'importe où dans la vidéo pour la lire (il n'est pas nécessaire de cliquer sur la flèche de lecture en bas à gauche). Cliquez à nouveau (n'importe où dans la vidéo) pour interrompre la lecture. Utilisez les commandes vidéo disponibles, par exemple pour passer à la taille réelle et vice versa, pour sauter en avant et en arrière le long de la chronologie et pour modifier la vitesse de lecture.

HUD

Une image flottante est utilisée pour présenter un scénario avant et après ou une sorte de comparaison par rapport à une caractéristique ou une fonction du logiciel. Elle se compose de deux images seulement. Elle apparaît sur la page comme une image statique normale, la première image étant affichée par défaut. Si vous passez le pointeur de la souris dessus, la deuxième image apparaît.

Vous trouverez ci-dessous un exemple réel d'image survolée utilisée dans la documentation. Dans ce cas, elle est utilisée pour illustrer les vias de blindage (première image par défaut) et les vias d'assemblage (deuxième image qui apparaît au survol).

Image pop-up

Une image pop-up est utilisée pour montrer quelque chose dans le contexte du texte environnant sans ajouter explicitement l'image au flux de contenu. En ce sens, elle peut être considérée comme un "aparté" ou un exemple qui met en évidence un commentaire ou une déclaration dans le texte. Un tel élément apparaît avec l'une des deux icônes suivantes : (une image pop-up) ou (un gif pop-up ou une vidéo animée). L'image ci-dessous montre un élément pop-up lorsqu'on clique dessus, dans ce cas une fenêtre pop-up de type "image" montrant l'image en taille réelle.

Texte contextuel (info-bulle)

Une info-bulle est utilisée pour fournir des informations supplémentaires et utiles concernant un élément spécifique d'une page. Il peut s'agir, par exemple, d'une explication d'une entrée ou d'un glossaire de la terminologie utilisée. Une info-bulle peut apparaître de deux manières :

• Le symbole . Déplacez le pointeur de la souris sur le symbole pour afficher l'info-bulle.

  

• Le texte souligné. Déplacez le pointeur de la souris sur le texte pour accéder à l'info-bulle.

  

Sections déroulantes

Les sections déroulantes sont utilisées pour que le contenu de la page reste clair. Elles sont souvent utilisées pour des informations plus approfondies, mais qui ne sont pas nécessairement nécessaires pour comprendre le flux normal de la page (et qui n'ont donc pas besoin d'être affichées ouvertement). Il peut s'agir, par exemple, d'options disponibles dans un dialogue ou un panneau, ou de considérations spéciales concernant un aspect particulier d'une fonction couverte par le contenu principal. Pour développer ou réduire une telle section, cliquez n'importe où dans l'en-tête de la section.

Obtenir un lien vers la page ou une section spécifique

Si vous souhaitez partager une page avec d'autres personnes, vous devez pouvoir accéder rapidement à l'URL de la page. Cela peut se faire de plusieurs manières (en copiant dans le presse-papiers de Windows) :

1. Dans la barre d'adresse du navigateur lorsque vous ouvrez la page pour la première fois.

2. En cliquant avec le bouton droit de la souris sur l'entrée de la page dans la structure de navigation à gauche, puis en utilisant la commande Copy link address dans le menu contextuel.

En outre, vous pouvez également récupérer l'URL d'une section spécifique de la page que vous êtes en train de lire de la manière suivante :

1. Utilisez le volet droit pour accéder à la section souhaitée dans la structure du contenu de la page, puis copiez l'URL dans la barre d'adresse de votre navigateur.

2. Faites défiler la page jusqu'à la section souhaitée. Au fur et à mesure que vous faites défiler la page, la barre d'adresse de votre navigateur se met à jour et affiche la section que vous avez atteinte.

3. Cliquez avec le bouton droit de la souris sur l'entrée de la section souhaitée dans la structure du contenu de la page (sur le côté droit de la fenêtre), puis utilisez la commande Copy link address dans le menu contextuel.

Vous pouvez également "attraper" rapidement un lien dans les endroits suivants :

• Main Section Header - cliquez sur la commande "Copier le lien" à gauche du titre d'une section principale.

  

• Collapsible Section - cliquez sur le contrôle "Copier le lien" à droite d'un titre de section déroulant.

  

Documentation versionnée

Pour Altium On-Prem Enterprise Server, la documentation associée est versionnée. Cela vous permet de sélectionner la version de la documentation correspondant à la version du logiciel que vous utilisez. La version peut être sélectionnée soit à partir du portail principal de documentation (via le menu des onglets de produits QuickLinks ) ou à tout moment dans la documentation via le sélecteur de version situé en haut de la bannière, comme illustré ci-dessous.

Le système de gestion des versions vous avertit si vous lisez une page qui n'est pas la dernière version de cette page. Il le fait de deux manières :

• Le numéro de version dans le sélecteur de version est affiché dans une couleur différente et est marqué d'un symbole d'avertissement.
• Un avis contenant un lien vers la dernière version apparaît en haut de la page. Si vous suivez le lien, l'entrée dans le sélecteur de version est automatiquement remplacée par la dernière version disponible.

Versions applicables

Comme le logiciel évolue d'une version à l'autre, en ajoutant de nouvelles caractéristiques et en améliorant les fonctionnalités, la documentation versionnée associée à Altium On-Prem Enterprise Server peut n'être affectée que dans certains domaines. De nombreuses pages ne seront pas affectées par la prochaine version du logiciel, de sorte que le même contenu qui s'appliquait précédemment s'applique désormais à cette dernière version. Par conséquent, chaque page indique pour quelles versions du logiciel le contenu de la page peut être utilisé.

L'illustration suivante montre une telle note. Ceci ouvre la version 8.0 de la page décrivant la fonction Historique du projet. Ce contenu s'applique également aux versions 7.0, 7.1 et 7.2 du logiciel. En d'autres termes, il n'y a pas de différence dans le contenu de la page si vous réglez le sélecteur de version de la documentation sur 7.0, 7.1, 7.2 ou 8.0.

Fonction de recherche dans la documentation

Une fonction de recherche puissante vous aide à trouver des informations dans la documentation technique d'Altium Design Solutions Search d'Altium. Avec l'aide de Google, il existe une fonction de recherche unique pour l'ensemble du site altium.com. La façon dont vous accédez à la recherche et l'endroit où vous y accédez déterminent le degré de "filtrage" de vos premiers résultats :

• Via la bannière située en haut du site, accessible et utilisée comme le montre le diaporama ci-dessous. La recherche est effectuée sur l'ensemble du site web et les résultats sont affichés dans un onglet distinct du navigateur.

• Par la "porte d'entrée" de la documentation technique(altium.com/documentation) - accessible et utilisée comme indiqué dans le diaporama ci-dessous. La recherche est effectuée sur toute la documentation disponible pour les différentes solutions de conception Altium, ainsi que dans la base de connaissances. Les résultats sont affichés dans le même onglet du navigateur.

• A partir d'une page de la documentation technique - accès et utilisation comme indiqué dans le diaporama ci-dessous. La recherche n'est effectuée que dans l'ensemble actif de la documentation actuellement affichée. Les résultats sont affichés dans le même onglet du navigateur.

Pagination QuickNav (Documentation Altium Designer)

Les informations sur les objets de mise en page et les panneaux dans Altium Designer sont dispersées sur de nombreuses pages de la documentation d'Altium Designer. Afin de fournir un moyen de naviguer facilement vers ces informations, le concept de QuickNav pagination. Comme un plan dans un centre commercial, une page QuickNav fournit des informations de référence rapide sur les éléments de conception disponibles pour une zone de conception particulière et vous donne la possibilité de naviguer rapidement vers des informations plus détaillées sur chaque élément.

Dans la plupart des cas, une page QuickNav présente les informations dans trois sections différentes :

• Graphical Overview - par exemple, une image collationnée des éléments les plus fréquemment utilisés.
• Slideshow - des informations plus générales sur certains des éléments que vous utiliserez fréquemment.
• A-Z Listing - une liste alphabétique pratique. Pas de fioritures, pas de chichis. Juste des liens directs vers les détails d'un article particulier.

La pagination QuickNav est disponible pour les éléments suivants :

• Objets de conception schématique

• Objets de mise en page de PCB

• Objets de conception schématique

• Objets de conception schématique multi-cartes

• Objets de conception de harnais de câblage

• Cartes de distribution

QuickStart Paging (Documentation Altium Designer)

La documentation d'Altium Designer (qui supporte les solutions de la plate-forme Altium) contient des pages clés de haut niveau qui, lorsqu'elles sont consultées ensemble, fournissent un ensemble précieux d'informations "QuickStart". Ces pages vous guideront dans un domaine spécifique de la conception et vous donneront juste ce qu'il faut de détails pour commencer à comprendre ce domaine sans aller trop loin. Ces pages sont les suivantes

• Se familiariser avec l'environnement de conception Altium

• Saisir votre idée de conception sous forme d'esquisse

• Analyse de la conception par la simulation de circuits

• Gestion des nomenclatures avec ActiveBOM

• Gérer les modifications de conception entre le schéma et le circuit imprimé

• Mise en page de votre circuit imprimé

• Rationaliser la documentation de la conception de la carte avec Draftsman

• Préparer votre conception pour la fabrication

• Concevoir avec plusieurs PCB

• Concevoir des harnais de câblage

Fonctionnalité "J'aime / Je n'aime pas

Pour obtenir une analyse approximative de la navigation dans la documentation technique, la fonction omniprésente "pouce vers le haut/bas" est utilisée. Elle nous permet de déterminer l'utilité d'une page et, si ce n'est pas le cas, de la marquer pour révision. Les commandes de cette fonction se trouvent dans la section Content (ToC) de la page dans le volet de droite. Cliquez une fois sur l'icône du pouce pour enregistrer votre "vote", cliquez à nouveau pour le retirer. Si vous cliquez sur l'icône Thumbs Down icône AND lorsque vous êtes connecté à votre compte Altium, vous aurez la possibilité de donner votre avis sur la raison pour laquelle la page ne vous a pas été utile. Cela enverra un rapport directement à l'équipe de la documentation technique.

Mécanisme de retour d'information sur la documentation

Il peut arriver que vous rencontriez un problème dans un document, tel qu'une erreur typographique, un problème d'accessibilité, une information incorrecte ou peu claire, ou une information obsolète. L'erreur est humaine et nous espérons que vous, nos lecteurs, nous aiderez à corriger ces problèmes. À cette fin, la documentation technique contient un mécanisme de retour d'information qui peut être consulté à partir de n'importe quelle page et qui envoie un rapport directement à l'équipe chargée de la documentation technique.

Ce mécanisme de retour d'information est accessible en utilisant les raccourcis clavier suivants Ctrl+Enter pour accéder à ce mécanisme de retour d'information. Si vous souhaitez vous référer à une partie spécifique du texte et/ou de l'image, sélectionnez-la (200 caractères maximum) avant d'appuyer sur la touche Ctrl+Enter.

Après avoir accédé à la fonction, vous verrez apparaître la fenêtre Report Document Issue la fenêtre de référence apparaît avec le texte/l'image de référence (le cas échéant) ajouté(e). Utilisez le Issue (500 caractères maximum) pour fournir autant de détails que possible - cela nous aide vraiment à enquêter sur un problème valide et à le résoudre plus rapidement. Lorsque vous avez terminé, cliquez sur le bouton Send Feedback pour soumettre le rapport. Un message de confirmation vous informera que le rapport a été envoyé et reçu avec succès. Nous ne saurions trop insister sur l'importance de votre retour d'information et sur la façon dont nous l'apprécions

Prise en charge de la visualisation sur n'importe quel appareil

L'époque où tous les concepteurs étaient assis devant un ordinateur de bureau équipé d'un seul moniteur 1280x1024 est révolue. Aujourd'hui, nos ordinateurs de bureau sont équipés de plusieurs moniteurs de tailles et de résolutions différentes. Nous devons également pouvoir travailler à partir d'un ordinateur portable lorsque nous sommes sur le terrain ou dans le bureau du client. Et comme nous avons soif de connaissances, nous voulons aussi pouvoir utiliser notre tablette ou notre téléphone pour absorber davantage d'informations pendant que nous attendons notre vol ou que nous prenons le bus pour nous rendre au bureau.

Pour présenter le contenu d'une manière qui fonctionne sur tous ces différents appareils, la documentation technique (qui fait partie du site web altium.com ) utilise responsive web design. Un site web réactif communique avec l'appareil cible et adapte la présentation et la taille du contenu à l'appareil spécifique, à la résolution de l'écran et à la taille du navigateur. Si la largeur du navigateur est réduite, les éléments de la page sont réorganisés et les polices de caractères et les images sont réduites. Même sur un écran de 5 pouces, le site web est fonctionnel, car l'arbre de navigation, par exemple, est également disponible sous forme de liste déroulante sur votre tablette ou votre téléphone.

Documentation imprimable

vous souhaitez imprimer une partie de la documentation technique ? Comme nous utilisons des fonctionnalités en ligne et de nombreux effets visuels sophistiqués pour transmettre les informations, vous devez d'abord vous assurer qu'une page est préparée pour que vous puissiez l'envoyer à votre imprimante de confiance (ou l'enregistrer au format PDF). Sur le côté droit de la zone inférieure de la bannière, vous trouverez la commande correspondante qui vous fournira une version imprimable de la page.

Documentation localisée

Une partie de notre contenu est également disponible dans d'autres langues que l'anglais. Utilisez le sélecteur de langue situé à gauche du bandeau inférieur pour choisir la langue souhaitée parmi les langues actuellement prises en charge.

Le contenu dans la langue alternative pour une version particulière d'une page sera affiché automatiquement s'il est disponible ; dans le cas contraire, le contenu en anglais sera affiché. La présentation suivante illustre la localisation d'une page disponible en anglais, japonais, chinois, coréen et polonais.

Traduction du navigateur (non officielle)

En fonction de votre navigateur préféré, vous pouvez accéder à une traduction temporaire à la volée de la page active que vous êtes en train de lire. La présentation suivante illustre l'utilisation de la fonction de traduction de Google Chrome pour afficher rapidement la page dans l'une des nombreuses langues prises en charge, en l'occurrence l'allemand. Notez que la traduction n'est que temporaire - si vous cliquez sur une autre page et que vous revenez en arrière ou que vous actualisez la page, la langue affichée sera rétablie.

La base de connaissances

De nombreuses personnes trouvent le chemin de la base de connaissances d' Altium et pensent qu'il s'agit d'une extension de notre documentation technique. En réalité, il s'agit d'une ressource distincte. En fait, les deux forment une relation symbiotique où la base de connaissances et la documentation technique sont liées et se complètent pour vous donner les informations que vous recherchez.

La base de connaissances est un centre en libre-service dont le contenu est géré par les membres de l'organisation de support d'Altium - des personnes qui ont une connaissance approfondie des solutions d'Altium. Ce contenu est créé directement à partir des problèmes rencontrés par d'autres utilisateurs. Le résultat est un référentiel organique d'articles qui fournissent des réponses/solutions spécifiques à des problèmes et à des cas particuliers. Des articles spécifiques et rapides à lire qui vous aideront à vous remettre sur la bonne voie.

L'interface de la base de connaissances est très simple. Vous pouvez parcourir tous les articles ou rechercher des articles spécifiques dans l'une des catégories de solutions de conception prises en charge. Pour commencer, saisissez un terme de recherche et des filtres seront appliqués. Lorsque vous avez trouvé un article qui vous intéresse, cliquez sur l'entrée correspondante pour l'ouvrir.

Copyright de la documentation

Les informations sur les droits d'auteur de la documentation technique sont illustrées dans la figure ci-dessous et sont accessibles via la section QuickLinks du panneau de navigation(Documentation Copyright Information), disponible lors de la consultation de n'importe quelle page de la documentation technique. La page contient un lien vers la page Copyrights & Trademarks du site web principal altium.com.

Une citation d'adieu...

C'est un mantra auquel l'équipe de documentation technique adhère et qu'elle s'efforce d'appliquer. La documentation technique continuera à se développer à l'avenir, en particulier du point de vue de la convivialité. Après tout, beaucoup d'informations ne sont utiles que si nos utilisateurs peuvent les trouver. Au fur et à mesure que de nouveaux développements, améliorations et fonctionnalités seront disponibles, cette page sera mise à jour pour refléter et mettre en évidence ces éléments supplémentaires et la meilleure façon de les utiliser pour accéder à l'information dont vous avez besoin.