Altium-Dokumentation verwenden

Für die verschiedenen Designlösungen von Altium steht eine umfangreiche technische Dokumentation zur Verfügung. Dieses Dokument bietet praktische Tipps und Tricks, mit denen Sie die gesuchten Informationen in der Dokumentation finden. Außerdem erläutert es die zahlreichen und vielfältigen Möglichkeiten der Dokumentation, die Ihnen vielleicht noch nicht bekannt sind.

Zugriff auf die technische Dokumentation

Der zentrale Einstiegspunkt zur technischen Dokumentation – sozusagen die „Eingangstür“ – ist: https://www.altium.com/documentation/. 

Im Mittelpunkt der Seite stehen die folgenden beiden Dokumentationsbereiche:

• Altium Designer – die Desktop-Designsoftware, die unter folgenden Bezeichnungen angeboten wird:

  • Altium Designer Develop – als Bestandteil der Lösung Altium Develop.

  • Altium Designer Agile – als Bestandteil der Lösungen Altium Agile Teams oder Altium Agile Enterprise.

  • Altium Designer – bei fortgesetzter Nutzung (mit aktiver Laufzeitlizenz) außerhalb einer Plattformlösung.

• Altium 365 – die Cloud-Plattform, deren zentraler Workspace folgende Bezeichnungen trägt:

  • Altium Develop Workspace – wenn er im Rahmen der Lösung Altium Develop erstellt wurde.

  • Altium Agile Teams Workspace – wenn er im Rahmen der Lösung Altium Agile Teams erstellt wurde.

  • Altium Agile Enterprise Workspace – wenn er im Rahmen der Lösung Altium Agile Enterprise erstellt wurde.

  • Altium 365 Workspace – bei fortgesetzter Nutzung mit Altium Designer (mit aktiver Laufzeitlizenz) außerhalb einer Plattformlösung.

Beachten Sie, dass in beiden Fällen jeweils eine gemeinsame Dokumentation für alle Lösungen verwendet wird. In der Dokumentation zu Altium Designer wird für die Software in der Regel die Kurzform „Altium Designer“ verwendet. In der Dokumentation zu Altium 365 wird die Plattform als „Altium Platform“ (oder „Altium 365“) bezeichnet. Ein auf der Plattform gehosteter Workspace wird als „Altium Workspace“ (oder „Altium 365 Workspace“ oder einfach „Workspace“) bezeichnet.

Verwendung der Seite:

• Klicken Sie auf die Hauptüberschrift einer Kachel, um die Startseite der Dokumentation zur jeweiligen Designlösung aufzurufen.

• Klicken Sie auf einen Link innerhalb der Kacheln für Altium Designer oder Altium 365, um Informationen zum jeweiligen Bereich aufzurufen.

• Verwenden Sie die verfügbaren QuickLinks-Menüs, um weitere wichtige Seiten aufzurufen, wie unten anhand der Dokumentationskacheln für Altium Designer und Altium 365 gezeigt.

• Verwenden Sie das Feld Search oben auf der Seite, um schnell die gesamte Dokumentation zu allen Designlösungen (und gegebenenfalls deren Versionen) sowie die Wissensdatenbank zu durchsuchen. Weitere Informationen zur Suchfunktion finden Sie unter Suchfunktion der Dokumentation.

• Klicken Sie auf den Eintrag Other Products, um die Seite zu erweitern und auf die Dokumentation zu weiteren Lösungen/Bereichen zuzugreifen: Renesas 365, Altium Developer Center, Altium On-Prem Enterprise Server, Unternehmens-Dashboard, Altium CircuitMaker, Altium CircuitStudio und Altium Infrastructure Server.

  

• Klicken Sie auf den Eintrag See Also, um die Seite zu erweitern und auf weitere nützliche Ressourcen von Altium zuzugreifen, beispielsweise die Wissensdatenbank, den Learning Hub (mit zahlreichen interessanten, themenspezifischen Artikeln, von denen viele von Branchenexperten verfasst wurden), Altium Professional Training und die Altium-Foren (eine wertvolle Lernressource mit Informationen direkt von anderen Anwendern).

  

Direktzugriff mit „F1“

Bei Designsoftware wie Altium Designer lohnt es sich auf jeden Fall, sich mit der Tastenkombination F1 vertraut zu machen. Bewegen Sie den Mauszeiger über eines der zahlreichen Elemente in der Softwareumgebung – etwa einen Menübefehl, einen Dialog, ein Panel, ein Designobjekt oder ein Schlüsselwort der Abfragesprache – und drücken Sie dann F1, um die zugehörige Dokumentation aufzurufen. Diese Verknüpfung zwischen Softwareelement und technischer Dokumentation wird durch eine Zuordnungsdatei (*.HelpID) ermöglicht, die sich im Ordner \Program Files\Altium\AD<Solution>\Help des Hauptinstallationsverzeichnisses befindet.

Die folgende Abbildung zeigt diese Funktion in Aktion. Hier wird die Tastenkombination F1 verwendet, um die Dokumentation zum Befehl Material Library aufzurufen, der beim Bearbeiten des Lagenaufbaus einer Leiterplatte im Layer Stack Manager verfügbar ist.

F1-Updates

Bei unterstützter Designsoftware wird die HelpID-Zuordnungsdatei im Hauptordner \Help der Installation mit jeder neuen Softwareversion aktualisiert. Gelegentlich aktualisiert das Team für technische Dokumentation die Zuordnungsdatei jedoch auch zwischen den Veröffentlichungen. Um unseren Anwendern die neuesten F1-Änderungen bereitzustellen, ohne dass sie auf die nächste Softwareversion warten müssen, nutzen wir ein dynamisches Aktualisierungsverfahren. Dieses verwendet die Einstellung Check frequency auf der Seite System - Installation des Dialogs Preferences.

Sofern das Prüfintervall abgelaufen ist, wird bei der nächsten Verwendung der Funktion F1 eine neuere Version der Zuordnungsdatei heruntergeladen und im \ProgramData\Altium\Altium Designer <Solution> <GUID>\Help Ordner. Diese neuere Version der HelpID-Datei hat Vorrang vor der Standarddatei im Ordner \Help der Hauptinstallation.

Alternative Zugriffsmöglichkeiten

Auf die technische Dokumentation können Sie auch auf verschiedene weitere Arten zugreifen, darunter:

• Über eine externe Suche mit der Suchmaschine Ihres Webbrowsers, beispielsweise Google. Um eine solche Suche auf die Altium-Dokumentation zu beschränken, geben Sie die Website als Präfix im Format site:altium.com/documentation <Search String> ein (z. B. site:altium.com/documentation PCB Layout Replication).

• Über einen Link in einem offiziellen Forenbeitrag von Altium.

• Über Links in anderen Bereichen der Hauptwebsite altium.com (z. B. im Bereich Learning Hub oder auf speziellen Seiten zu Neuerungen und einzelnen Funktionen).

• Über spezielle Links in der Software. Beispielsweise über ein Help Menü oder über Links mit der Bezeichnung „Learn More“ (oder ähnlichem Wortlaut).

Die Dokumentationsoberfläche

Die Dokumentationsoberfläche umfasst in der Regel bis zu 14 verschiedene Bereiche, die in der folgenden Abbildung dargestellt und anschließend ausführlich beschrieben werden.

1. Product Documentation Selector – Mit diesem Steuerelement wechseln Sie zwischen den verfügbaren Dokumentationssammlungen.

2. Theme Selector – Mit diesem Steuerelement wechseln Sie zwischen dem hellen () und dem dunklen () Darstellungsmodus, wie im folgenden Beispiel gezeigt.

   

    

   

    

    

3. Search – In dieses Feld geben Sie einen Suchbegriff ein, um Informationen in der aktuell angezeigten Produktdokumentation zu finden. Mit den zugehörigen Suchfiltern können Sie den Suchumfang anschließend anpassen. Weitere Einzelheiten finden Sie unter Suchfunktion der Dokumentation.

4. Nav Tree Pane – Hier werden alle Seiten der angezeigten Produktdokumentation in einer logischen Struktur aufgeführt. Klicken Sie auf einen Eintrag, um die entsprechende Seite anzuzeigen. Mit den Steuerelementen oben rechts im Fensterbereich können Sie dessen Größe und/oder Sichtbarkeit anpassen.

5. QuickLinks – Ein fester, statischer Bestandteil des Fensterbereichs Nav Tree, der unabhängig von der angezeigten Produktdokumentation immer eingeblendet wird. Er bietet direkten Zugriff auf diese Seite, Copyright-Informationen und das zentrale Dokumentationsportal sowie schnellen Zugriff auf die Wissensdatenbank.

6. Breadcrumbs – Bietet ausgehend von der aktuell angezeigten Seite eine zusätzliche Navigationsmöglichkeit zu übergeordneten Seiten in der Hierarchie. Wenn der Breadcrumb-Pfad viele Seiten umfasst, sorgt ein Steuerelement mit Auslassungspunkten für eine übersichtliche Darstellung. Klicken Sie darauf, um ein Pop-up mit allen weiteren Zwischenseiten des Pfads zu öffnen. Jeder Eintrag ist ein aktiver Link zur entsprechenden Seite.

   

7. Main Page Content – Dies ist der Hauptbereich der Oberfläche, in dem die im Fensterbereich Nav Tree ausgewählte Seite angezeigt wird. Weitere Einzelheiten zu verschiedenen Aspekten des Seiteninhalts sowie Tipps zu den enthaltenen Funktionen finden Sie unter Anzeigen eines technischen Dokuments.

8. Feature Availability Note – Dieser Bereich wird auf jeder Seite bestimmter Dokumentationssammlungen angezeigt. Die technische Dokumentation beschreibt sämtliche Funktionen eines Produkts oder einer Komponente einer Gesamtlösung. Bei Altium Designer und Altium 365 hängt der Zugriff auf eine auf einer Seite beschriebene Funktion davon ab, welche Altium-Lösung Sie verwenden – Altium Develop, Altium Agile Teams, Altium Agile Enterprise oder Altium Designer (mit aktiver Laufzeitlizenz). Wenn eine dokumentierte Funktion in Ihrer Software nicht verfügbar ist, wenden Sie sich an den Altium-Vertrieb, um mehr zu erfahren.

9. Legacy Documentation Note – Dieser Bereich wird auf jeder Seite der Altium Designer-Dokumentation angezeigt. Er bietet schnellen Zugriff auf den Abschnitt Dokumentation älterer Versionen der Seite Weitere Installationsprogramme, auf der Sie Dokumentation zu älteren Softwareversionen finden.

10. Table of Contents – Der Bereich Content im rechten Fensterbereich zeigt, sofern zutreffend, die Struktur der aktiven Seite anhand ihrer Überschriften (Ebenen 2–4, da Ebene 1 dem Seitentitel entspricht). Klicken Sie auf einen Eintrag, um zur entsprechenden Stelle auf der Seite zu springen. Umgekehrt wird der Bereich Content beim Scrollen der Seite aktualisiert, um Ihre aktuelle Position im Dokument anzuzeigen.

11. Like/Dislike – INZWISCHEN ENTFERNT. Die Seite wird zu gegebener Zeit aktualisiert, um diesen Bereich aus der obigen Abbildung zu entfernen.

12. Language Selector – Bietet eine schnelle Möglichkeit, die Dokumentation in einer der verschiedenen offiziell unterstützten Sprachen anzuzeigen.

13. Documentation Feedback (wird angezeigt, wenn Sie bei Ihrem Altium-Konto angemeldet sind) – Mit dieser Funktion können Sie dem Team für technische Dokumentation schnell Feedback zu einer Seite senden, insbesondere zu Tippfehlern, falschen oder veralteten Angaben sowie fehlenden Informationen. Wählen Sie einfach Text und/oder ein Bild auf der Seite aus und verwenden Sie die Tastenkombination Ctrl+Enter, um die Funktion aufzurufen. Weitere Einzelheiten finden Sie unter Feedback-Funktion der Dokumentation.

14. Printer-friendly version – Bietet die Möglichkeit, unmittelbar eine Version der Seite zu erzeugen, deren Inhalt speziell für den einfachen Ausdruck aufbereitet ist (z. B. zum Speichern als PDF).

Strukturseiten

Im Fensterbereich Nav Tree der Oberfläche stoßen Sie gelegentlich auf Einträge, bei denen durch Anklicken keine Dokumentationsseite angezeigt wird. Dies ist beabsichtigt: Diese Einträge dienen dazu, die Baumstruktur zusätzlich zu gliedern, wenn Seiten unter einem gemeinsamen übergeordneten Eintrag gruppiert werden sollen, auf der übergeordneten Seite selbst jedoch keine Informationen benötigt werden. Dieser Seitentyp – eine Structure Seite – erfüllt ausschließlich diesen Zweck. Wenn Sie den Mauszeiger über einen solchen Eintrag bewegen, wird dieser nicht unterstrichen (anders als der Eintrag einer „echten“ Dokumentationsseite). Wenn Sie auf einen solchen Eintrag klicken, wird lediglich der entsprechende Abschnitt der Baumstruktur aufgeklappt. Klicken Sie erneut darauf, um ihn wieder zuzuklappen.

Anzeigen eines technischen Dokuments

Die folgenden Abschnitte enthalten Informationen zu verschiedenen Aspekten des eigentlichen Seiteninhalts.

Konventionen im Dokument

Anschauliche visuelle Elemente

In der gesamten Dokumentation werden verschiedene visuelle Elemente eingesetzt, um Informationen anschaulicher zu vermitteln. Die folgenden Abschnitte zeigen, wie diese auf einer Seite aussehen und wie sie verwendet werden.

Statisches Bild

Das einfache statische Bild ist ein Grundbaustein der Dokumentation. Zusammen mit dem umgebenden Text vermittelt es präzise Details zu einem wichtigen Aspekt der Software.

Um die Darstellung und Lesbarkeit eines Dokuments übersichtlich zu halten, wird eine feste Seitenbreite verwendet. Daher können Bilder in der Regel standardmäßig nicht in voller Größe dargestellt werden. Wenn Sie den Mauszeiger über ein Bild bewegen, wechselt er von einem Zeigersymbol () zu einem Lupensymbol (). Dies zeigt an, dass durch Klicken auf das Bild dessen Version in voller Größe in einem schwebenden Fenster angezeigt wird (sofern zutreffend und abhängig von der aktuellen Größe Ihres Browserfensters). Das folgende Bild veranschaulicht dies anhand eines statischen Bildes in der Dokumentation (ironischerweise müssen Sie auf das Bild klicken, um es in voller Größe zu sehen).

Diashow

Ein Diashow-Element kann mehrere Bilder (und Videos) mit Bildunterschriften enthalten, um zusätzliche visuelle Informationen übersichtlich darzustellen. Dieses Element ist besonders nützlich, um bei der Verwendung einer bestimmten Softwarefunktion einen Ablauf oder eine schrittweise Vorgehensweise zu veranschaulichen.

Das folgende Bild zeigt eine beispielhafte Diashow in der Dokumentation und hebt einige wichtige Bereiche hervor, die anschließend beschrieben werden.

1. Verwenden Sie diese Steuerelemente, um in der Diashow vor- bzw. zurückzublättern. Wenn Sie den Mauszeiger über einen Bereich bewegen, wird dieser dunkler. Sie können an einer beliebigen Stelle innerhalb des „Pfeilrahmens“ klicken, nicht nur auf das Pfeilsymbol selbst.

2. Diese „Punkte“ zeigen an, wie viele Folien die Diashow enthält und an welcher Stelle Sie sich befinden (dunklerer Punkt). Klicken Sie auf einen Punkt, um direkt zur entsprechenden Folie zu springen.

3. Eine Diashow kann Bildunterschriften enthalten – eine pro Folie. Diese werden beim Wechseln zwischen den Folien entsprechend aktualisiert.

Animiertes GIF

Ein animiertes GIF wird verwendet, wenn ein Prozess oder ein Aspekt der Software ähnlich wie in einem Video dargestellt werden soll, die visuelle Darstellung jedoch so kurz ist, dass ein Video überdimensioniert wäre. Ein animiertes GIF in der Dokumentation erkennen Sie an einer auffälligen Wiedergabeschaltfläche in der Mitte, wie im folgenden Bild gezeigt. Nach einem Klick auf die Schaltfläche wird das GIF bis zum Ende abgespielt und angehalten. Anschließend wird die Wiedergabeschaltfläche erneut angezeigt.

Video (MP4)

Ein Video wird ebenso wie ein GIF verwendet, um einen Prozess oder einen Aspekt der Software visuell in Aktion darzustellen. Es kommt zum Einsatz, wenn der Inhalt länger ist, als es für ein GIF sinnvoll wäre. Ein Video in der Dokumentation erkennen Sie an einer Steuerleiste im unteren Bereich, wie im folgenden Bild gezeigt. Klicken Sie auf eine beliebige Stelle im Video, um die Wiedergabe zu starten (Sie müssen nicht auf den Wiedergabepfeil unten links klicken). Klicken Sie erneut auf eine beliebige Stelle im Video, um die Wiedergabe anzuhalten. Mit den verfügbaren Videosteuerelementen können Sie beispielsweise zur Vollbildansicht und zurück wechseln, auf der Zeitleiste vor- und zurückspringen und die Wiedergabegeschwindigkeit ändern.

Hover-Bild

Ein Hover-Bild wird verwendet, um einen Vorher-Nachher-Zustand oder einen Vergleich im Zusammenhang mit einem Merkmal oder einer Funktion der Software darzustellen. Es besteht aus genau zwei Bildern. Auf der Seite erscheint es wie ein gewöhnliches statisches Bild, wobei standardmäßig das erste Bild angezeigt wird. Wenn Sie den Mauszeiger darüber bewegen, erscheint das zweite Bild.

Im Folgenden sehen Sie ein konkretes Beispiel für ein Hover-Bild aus der Dokumentation. In diesem Fall veranschaulicht es Abschirmungs-Vias (standardmäßig angezeigtes erstes Bild) und Stitching-Vias (zweites Bild, das beim Bewegen des Mauszeigers über das Bild erscheint).

Pop-up-Bild

Ein Pop-up-Bild wird verwendet, um etwas im Kontext des umgebenden Textes zu zeigen, ohne das Bild direkt in den Inhaltsfluss einzufügen. In dieser Hinsicht lässt es sich eher als ergänzender Hinweis oder als Beispiel betrachten, das eine Anmerkung oder Aussage im Text verdeutlicht. Ein solches Element wird mit einem von zwei Symbolen angezeigt –  (ein Pop-up-Bild) oder  (ein animiertes Pop-up-GIF oder -Video). Das folgende Bild zeigt ein Pop-up-Element nach dem Anklicken, in diesem Fall ein Pop-up vom Typ „Bild“, das das Bild in voller Größe anzeigt.

Hover-Text (Tooltip)

Hover-Text (oder ein Tooltip) bietet zusätzliche hilfreiche Hinweise zu einem bestimmten Eintrag auf einer Seite. Dies kann beispielsweise eine Erläuterung zu einem Eintrag oder eine Erklärung verwendeter Begriffe im Stil eines Glossars sein. Ein Tooltip kann auf zwei Arten bereitgestellt werden:

• Über das Symbol . Bewegen Sie den Mauszeiger über das Symbol, um den Hinweis anzuzeigen.

  

• Über Text mit gepunkteter Unterstreichung. Bewegen Sie den Mauszeiger über den Text, um den Hinweis anzuzeigen.

  

Aufklappbare Abschnitte

Aufklappbare Abschnitte sorgen dafür, dass Seiteninhalte übersichtlich bleiben und nicht überladen wirken. Sie werden meist für weiterführende Informationen verwendet, die zum Verständnis des regulären Seiteninhalts nicht unbedingt erforderlich sind und daher nicht ständig sichtbar sein müssen. Dabei kann es sich beispielsweise um verfügbare Optionen in einem Dialog oder Panel handeln oder um besondere Hinweise zu einem bestimmten Aspekt einer Funktion, die im Hauptinhalt behandelt wird. Klicken Sie auf eine beliebige Stelle in der Kopfzeile eines solchen Abschnitts, um ihn auf- oder zuzuklappen.

Link zur Seite oder zu einem bestimmten Abschnitt abrufen

Wenn Sie eine Seite mit anderen teilen möchten, benötigen Sie schnellen Zugriff auf ihre URL. Diese lässt sich auf verschiedene Arten abrufen und in die Windows-Zwischenablage kopieren:

1. Aus der Adressleiste Ihres Browsers, wenn Sie die Seite erstmals aufrufen.

2. Indem Sie mit der rechten Maustaste auf den Eintrag der Seite im linken Navigationsbaum klicken und anschließend den Befehl Copy link address im Kontextmenü verwenden.

Darüber hinaus können Sie auch eine URL zu einem bestimmten Abschnitt der aktuell angezeigten Seite abrufen:

1. Rufen Sie im rechten Bereich den gewünschten Abschnitt über das Inhaltsverzeichnis der Seite auf und kopieren Sie anschließend die URL aus der Adressleiste Ihres Browsers.

2. Scrollen Sie auf der Seite zum gewünschten Abschnitt. Beim Scrollen wird die Adressleiste Ihres Browsers aktualisiert, sodass sie den jeweils erreichten Abschnitt widerspiegelt.

3. Klicken Sie mit der rechten Maustaste auf den Eintrag des gewünschten Abschnitts im Inhaltsverzeichnis der Seite (im rechten Bereich) und verwenden Sie anschließend den Befehl Copy link address aus dem Kontextmenü.

Auch an den folgenden Stellen können Sie schnell einen Link kopieren:

• Main Section Header – Klicken Sie links neben der Überschrift eines Hauptabschnitts auf das Steuerelement „Link kopieren“.

  

• Collapsible Section – Klicken Sie rechts neben dem Titel eines aufklappbaren Abschnitts auf das Steuerelement „Link kopieren“.

  

Versionierte Dokumentation

Die Dokumentation zu Altium On-Prem Enterprise Server ist versioniert. So können Sie die passende Dokumentationsversion für die von Ihnen verwendete Softwareversion auswählen. Die Version lässt sich entweder auf der zentralen Einstiegsseite der Dokumentation (über das Menü QuickLinks der Produktkachel) oder jederzeit innerhalb der Dokumentation über die Versionsauswahl im oberen Bannerbereich auswählen, wie unten gezeigt.

Das Versionierungssystem weist Sie darauf hin, wenn Sie eine Seite lesen, die nicht der neuesten Version dieser Seite entspricht. Dies geschieht auf zwei Arten:

• Die Versionsnummer in der Dropdown-Versionsauswahl wird in einer anderen Farbe und mit einem Warnsymbol angezeigt.
• Am oberen Seitenrand erscheint ein Warnhinweis mit einem Link zur neuesten Version. Wenn Sie diesem Link folgen, wird die Versionsauswahl automatisch auf die neueste verfügbare Version umgestellt.

Gültige Versionen

Während sich die Software von Version zu Version weiterentwickelt und neue Funktionen und Verbesserungen hinzukommen, sind möglicherweise nur bestimmte Bereiche der zugehörigen versionierten Dokumentation für Altium On-Prem Enterprise Server davon betroffen. Viele Seiten bleiben von der nächsten Softwareversion unberührt, sodass die bisher gültigen Inhalte auch für die neuere Version gelten. Daher wird auf jeder Seite angegeben, für welche Softwareversionen ihr Inhalt gilt.

Die folgende Abbildung zeigt eine solche Angabe. Hier ist Version 8.0 der Seite geöffnet, auf der die Funktion „Projektverlauf“ beschrieben wird. Dieser Inhalt gilt ebenso für die Softwareversionen 7.0, 7.1 und 7.2. Mit anderen Worten: Der Seiteninhalt ist identisch, unabhängig davon, ob Sie in der Versionsauswahl der Dokumentation 7.0, 7.1, 7.2 oder 8.0 einstellen.

Suchfunktion der Dokumentation

Eine leistungsstarke Search Suchfunktion hilft Ihnen dabei, Informationen in der technischen Dokumentation der Altium-Designlösungen zu finden. Tatsächlich gibt es eine einzige, von Google unterstützte Suchfunktion für die gesamte Website altium.com. Wie und wo Sie die Suche aufrufen, bestimmt, wie stark Ihre ersten Ergebnisse „gefiltert“ sind:

• Über die übergeordnete Kopfzeile der Website – Aufruf und Verwendung werden in der folgenden Diashow veranschaulicht. Die Suche erfolgt auf der gesamten Website; die Ergebnisse werden in einem separaten Browser-Tab angezeigt.

• Über die Einstiegsseite der technischen Dokumentation (altium.com/documentation) – Aufruf und Verwendung werden in der folgenden Diashow veranschaulicht. Die Suche erfolgt in allen verfügbaren Dokumentationen zu den verschiedenen Altium-Designlösungen sowie in der Wissensdatenbank. Die Ergebnisse werden im selben Browser-Tab angezeigt.

• Über eine Seite innerhalb der technischen Dokumentation – Aufruf und Verwendung werden in der folgenden Diashow veranschaulicht. Die Suche erfolgt nur innerhalb der aktuell angezeigten Dokumentation. Die Ergebnisse werden im selben Browser-Tab angezeigt.

QuickNav-Seiten (Altium Designer-Dokumentation)

Informationen zu Designobjekten und Panels in Altium Designer sind auf zahlreiche Seiten innerhalb der Altium Designer-Dokumentation verteilt. Um diese Informationen einfach zugänglich zu machen, wurde das Konzept der QuickNavSeiten eingeführt. Ähnlich wie ein Lageplan in einem Einkaufszentrum bietet eine QuickNav-Seite einen kompakten Überblick über die verfügbaren Designelemente eines bestimmten Designbereichs. Von dort aus gelangen Sie schnell zu detaillierteren Informationen über die einzelnen Elemente.

In den meisten Fällen enthält eine QuickNav-Seite drei klar voneinander abgegrenzte Abschnitte:

• Graphical Overview – beispielsweise eine grafische Zusammenstellung häufig verwendeter Objekte.
• Slideshow – mit weiterführenden Übersichtsinformationen zu einigen der Elemente, die Sie regelmäßig verwenden.
• A-Z Listing – eine praktische alphabetische Auflistung. Ohne Schnickschnack und Umwege. Einfach direkte Links zu den Details eines bestimmten Elements.

QuickNav-Seiten sind für folgende Bereiche verfügbar:

• Schaltplan-Designobjekte

• PCB-Designobjekte

• Draftsman-Designobjekte

• Multiboard-Schaltplan-Designobjekte

• Kabelbaum-Designobjekte

• Panels

QuickStart-Seiten (Altium Designer-Dokumentation)

Innerhalb der Altium Designer-Dokumentation, die als Grundlage und Unterstützung für die von Altium angebotenen Plattformlösungen dient, gibt es zentrale übergeordnete Seiten, die zusammen wertvolle Informationen für den Schnelleinstieg bieten. Diese Seiten führen Sie durch einen bestimmten Designbereich und vermitteln Ihnen genau das richtige Maß an Details, um sich darin zurechtzufinden und loszulegen, ohne zu tief in die Materie einzusteigen. Diese Seiten sind:

• Die Altium-Designumgebung kennenlernen

• Ihre Designidee als Schaltplan erfassen

• Ihr Design mithilfe der Schaltungssimulation analysieren

• Stücklistenverwaltung mit ActiveBOM

• Designänderungen zwischen Schaltplan & PCB verwalten

• Das Layout Ihrer Leiterplatte erstellen

• Die Leiterplatten-Designdokumentation mit Draftsman optimieren

• Ihr Design für die Fertigung vorbereiten

• Mit mehreren Leiterplatten entwerfen

• Kabelbaumentwurf

Feedbackfunktion für die Dokumentation

Gelegentlich stoßen Sie möglicherweise auf ein Problem mit einem Dokument, etwa einen Tippfehler, ein Zugriffsproblem, falsche oder unklare Angaben oder veraltete Informationen. Irren ist menschlich, und wir zählen auf Sie, unsere Leser, um solche Probleme zu beheben. Daher verfügt die technische Dokumentation über eine Feedbackfunktion, die von jeder Seite aus aufgerufen werden kann und einen Bericht direkt an das Team für technische Dokumentation sendet.

Diese Feedbackfunktion rufen Sie mit der Tastenkombination Ctrl+Enter auf. Wenn Sie sich auf einen bestimmten Textabschnitt und/oder eine Abbildung beziehen möchten, markieren Sie diesen bzw. diese (maximal 200 Zeichen), bevor Sie Ctrl+Enterdrücken.

Nach dem Aufrufen der Funktion wird das Fenster Report Document Issue angezeigt, in das der ausgewählte Text bzw. die ausgewählte Abbildung gegebenenfalls bereits eingefügt wurde. Geben Sie im Feld Issue (max. 500 Zeichen) möglichst viele Details an – das hilft uns sehr dabei, ein tatsächliches Problem schneller zu untersuchen und zu beheben. Klicken Sie anschließend zum Absenden auf die Schaltfläche Send Feedback . Eine Dankesmeldung bestätigt, dass Ihr Bericht erfolgreich übermittelt und empfangen wurde. Wir können gar nicht genug betonen, wie wichtig uns Ihr Feedback ist und wie sehr wir es schätzen!

Unterstützung für die Anzeige auf jedem Gerät

Die Zeiten, in denen jeder Entwickler vor einem Desktopcomputer mit einem einzelnen Monitor mit 1280 × 1024 Pixeln saß, sind vorbei. Heute verfügen unsere Desktop-PCs über mehrere Monitore unterschiedlicher Größe und Auflösung. Außerdem müssen wir unterwegs oder beim Kunden mit einem Laptop arbeiten können. Und weil wir wissbegierig sind, möchten wir auch auf dem Tablet oder Smartphone neue Informationen aufnehmen können, während wir auf unseren Flug warten oder mit dem Bus ins Büro fahren.

Damit die Inhalte auf all diesen unterschiedlichen Geräten gut dargestellt werden, nutzt die technische Dokumentation (als Teil der übergeordneten Website altium.com) responsive web design. Eine responsive Website kommuniziert mit dem jeweiligen Gerät und passt Layout und Größe der Inhalte an das Gerät, die Bildschirmauflösung und die Größe des Browserfensters an. Probieren Sie es aus, indem Sie die Größe Ihres Browserfensters ändern: Wenn Sie die Breite verringern, ordnen sich die Seitenelemente neu an und Schrift sowie Bilder werden kleiner. Selbst auf einem 5-Zoll-Bildschirm bleibt die Website nutzbar. So steht beispielsweise der Navigationsbaum auf Ihrem Tablet oder Smartphone weiterhin als Dropdown-Menü zur Verfügung.

Druckfreundliche Dokumentation

Möchten Sie Teile der technischen Dokumentation ausdrucken? Da wir auf Onlinefunktionen setzen und viele anschauliche visuelle Effekte zur Informationsvermittlung verwenden, müssen Sie die Seite zunächst für die Ausgabe auf Ihrem Drucker (oder zum Speichern als PDF) vorbereiten. Auf der rechten Seite des unteren Banners finden Sie ein Bedienelement, mit dem Sie eine druckfreundliche Version der Seite erstellen können.

Lokalisierte Dokumentation

Einige unserer Inhalte sind auch in anderen Sprachen als Englisch verfügbar. Über die Sprachauswahl auf der linken Seite des unteren Banners können Sie die gewünschte Sprache aus den derzeit unterstützten Sprachen auswählen.

Die anderssprachigen Inhalte für die jeweilige Version einer Seite werden automatisch angezeigt, sofern sie verfügbar sind. Andernfalls erscheinen die englischen Inhalte. Die folgende Diashow veranschaulicht die Lokalisierung einer Seite anhand der englischen Originalinhalte sowie einiger der weiteren verfügbaren Sprachen (Japanisch, Chinesisch, Koreanisch und Polnisch).

Browserübersetzung (inoffiziell)

Je nach verwendetem Webbrowser können Sie die gerade angezeigte Seite möglicherweise vorübergehend direkt übersetzen lassen. Die folgende Diashow zeigt, wie Sie mit der Übersetzungsfunktion von Google Chrome eine Seite schnell in einer der zahlreichen unterstützten Sprachen anzeigen können – in diesem Fall auf Deutsch. Beachten Sie, dass die Übersetzung nur vorübergehend ist: Wenn Sie zu einer anderen Seite und wieder zurück wechseln oder die Seite neu laden, wird sie wieder in der ursprünglichen Sprache angezeigt.

Die Wissensdatenbank

Viele Nutzer gelangen zu Altiums Wissensdatenbank und nehmen an, dass diese unsere gesamte technische Dokumentation umfasst. Tatsächlich handelt es sich jedoch um eine eigenständige Ressource. Beide stehen in einer symbiotischen Beziehung zueinander: Die Wissensdatenbank und die technische Dokumentation sind miteinander verknüpft und ergänzen sich, damit Sie die gesuchten Informationen finden.

Die Wissensdatenbank ist eine zentrale Anlaufstelle zur Selbsthilfe. Ihre Inhalte werden von Mitgliedern des Altium-Supportteams gepflegt – Fachleuten mit fundierten Kenntnissen der Altium-Lösungen. Die Inhalte entstehen unmittelbar aus Problemen, auf die andere Nutzer gestoßen sind. Das Ergebnis ist eine stetig wachsende Sammlung von Artikeln mit gezielten Antworten und Lösungen zu bestimmten Themen und Sonderfällen. Präzise, schnell lesbare Artikel, mit denen Sie rasch wieder weiterarbeiten können.

Die Benutzeroberfläche der Wissensdatenbank ist denkbar einfach. Sie können entweder alle Artikel durchsuchen oder die Suche auf eine der unterstützten Kategorien für Designlösungen eingrenzen. Geben Sie dann einfach einen Suchbegriff ein – die Ergebnisse werden bereits während der Eingabe gefiltert. Wenn Sie einen interessanten Artikel finden, klicken Sie auf den entsprechenden Eintrag, um ihn zu öffnen.

Urheberrechtshinweise zur Dokumentation

Die Urheberrechtshinweise zur technischen Dokumentation sind in der folgenden Abbildung übersichtlich dargestellt und über den Abschnitt „QuickLinks“ im Bereich „Nav Tree“ zugänglich (Urheberrechtshinweise zur Dokumentation). Dieser Bereich ist auf jeder Seite der technischen Dokumentation verfügbar. Die Seite enthält einen Link zur Seite Urheberrechte & Marken auf der Hauptwebsite altium.com.

Ein Zitat zum Abschluss ...

Dies ist ein Leitsatz, dem sich das Team für technische Dokumentation verpflichtet fühlt und den es konsequent umzusetzen versucht. Auch künftig wird die technische Dokumentation kontinuierlich weiterentwickelt, insbesondere im Hinblick auf die Benutzerfreundlichkeit. Schließlich ist eine Fülle an Informationen nur dann hilfreich, wenn unsere Nutzer sie auch finden können. Sobald neue Entwicklungen, Verbesserungen und Funktionen verfügbar sind, wird diese Seite aktualisiert, um diese Ergänzungen vorzustellen und hervorzuheben sowie zu erläutern, wie Sie sie am besten nutzen, um die benötigten Informationen zu finden.