Verwendung der Altium-Dokumentation

Für die verschiedenen Designlösungen von Altium steht eine umfangreiche technische Dokumentation zur Verfügung. In diesem Dokument finden Sie eine Reihe von praktischen Tipps und Tricks, wie Sie die Dokumentation nutzen können, um das zu finden, was Sie brauchen. Außerdem finden Sie hier eine ausführliche Beschreibung der vielen verschiedenen Aspekte der Dokumentation, von denen Sie vielleicht noch nichts wussten.

Zugang zur technischen Dokumentation

Der Hauptzugang zur technischen Dokumentation - sozusagen die "Eingangstür" - ist: https://www.altium.com/documentation/.

Das Herzstück der Seite sind die beiden folgenden Dokumentationsreihen:

• Altium Designer - die Desktop-Design-Software, die wie folgt bezeichnet wird:

  • Altium Designer Develop - als Teil der Altium Develop Lösung.

  • Altium Designer Agile - wenn sie Teil einer Altium Agile Lösung ist.

  • Altium Designer - wenn sie noch verwendet werden (mit aktiver Laufzeit) und nicht Teil einer Plattformlösung sind.

• Altium 365 - die Cloud-Plattform, deren Kern-Workspace wie folgt gebrandet ist:

  • Altium Develop Workspace - wenn er als Teil der Altium Develop-Lösung erstellt wurde.

  • Altium Agile Workspace - wenn er als Teil einer Altium Agile-Lösung erstellt wird.

  • Altium 365 Workspace - wenn sie noch mit Altium Designer (mit aktiver Laufzeit) verwendet wird und nicht Teil einer Plattformlösung ist.

Beachten Sie, dass in beiden Fällen ein einziges Dokumentationspaket verwendet wird, um alle Lösungen zu unterstützen. In der Dokumentation zu Altium Designer wird normalerweise die Kurzform Altium Designer" verwendet, wenn auf die Software Bezug genommen wird. In der Altium 365-Dokumentation wird 'Altium Platform' (oder 'Altium 365') verwendet, wenn man sich auf die Plattform bezieht, und 'Altium Workspace' (oder 'Altium 365 Workspace' oder einfach 'Workspace'), wenn man sich auf einen auf der Plattform gehosteten Workspace bezieht.

Arbeiten mit der Seite:

• Klicken Sie auf die Hauptüberschrift einer Kachel, um auf die Startseite der Dokumentation für diese bestimmte Designlösung zuzugreifen.

• Klicken Sie auf einen Link innerhalb der Altium Designer- oder Altium 365-Kacheln, um auf Informationen für diesen speziellen Bereich zuzugreifen.

• Verwenden Sie die verfügbaren QuickLinks menüs, um auf zusätzliche Tasten zuzugreifen, wie unten für die Altium Designer- und Altium 365-Dokumentationskacheln gezeigt.

• Verwenden Sie das Feld Search feld am oberen Rand der Seite können Sie schnell die gesamte Dokumentation für alle Designlösungen (und ggf. deren Versionen) sowie die Knowledge Base durchsuchen. Weitere Details zur Suchfunktion finden Sie unter Documentation Search Facility.

• Klicken Sie auf den Other Products eintrag, um die Seite zu erweitern und auf die Dokumentation für andere Lösungen/Bereiche zuzugreifen: Renesas 365, Altium On-Prem Enterprise Server, Company Dashboard, Altium CircuitMaker, Altium CircuitStudio und Altium Infrastructure Server.

  

• Klicken Sie auf den See Also eintrag, um die Seite zu erweitern und auf andere nützliche Ressourcen zuzugreifen, die Altium zu bieten hat, wie z.B. die Knowledge Base, den Learning Hub (voller interessanter und zielgerichteter Artikel, viele von Branchenexperten verfasst), Altium Professional Training und die Altium Foren (eine unschätzbare Lernquelle mit Informationen direkt von Ihren Kollegen).

  

Direkter Zugriff mit 'F1'

Für Design-Software, einschließlich Altium Designer, ist die F1 tastaturkürzel, mit dem Sie sich unbedingt vertraut machen sollten. Fahren Sie mit der Maus über viele Ressourcen in der Softwareumgebung - einen Menübefehl, ein Dialogfeld, ein Panel, ein Designobjekt oder ein Schlüsselwort der Abfragesprache - und drücken Sie dann F1 um die entsprechende Dokumentation aufzurufen. Diese Verbindung zwischen der Software-Ressource und der technischen Dokumentation wird durch eine Mapping-Datei erleichtert (*.HelpID), die sich im Ordner \Program Files\Altium\AD\Help ordner der Hauptinstallation befindet.

Das folgende Bild veranschaulicht die Funktion in Aktion. Hier wird das F1 tastaturkürzel verwendet, um auf die Dokumentation für den Befehl Material Library zuzugreifen, die bei der Bearbeitung des Ebenenstapels für eine Leiterplatte mit dem Ebenenstapel-Manager verfügbar ist.

F1 Aktualisierungen

Für unterstützte Design-Software wird die HelpID-Zuordnungsdatei im Hauptordner der Installation \Help im Hauptordner der Installation mit jeder neuen Version der Software aktualisiert. Es kann jedoch vorkommen, dass das Team der Technischen Dokumentation die Mapping-Datei zwischen den Releases aktualisiert. Zur Unterstützung der Weitergabe der neuesten F1 änderungen an unsere Benutzer weiterzugeben, ohne auf die nächste Version der Software warten zu müssen, verwenden wir einen Ansatz zur fliegenden Aktualisierung, der die Check frequency einstellung, auf der System - Installation seite des Preferences dialogs.

Wenn das Prüfintervall verstrichen ist, wird bei der nächsten Verwendung der F1 wird bei der nächsten Verwendung der Funktion eine neuere Version der Mapping-Datei in den \ProgramData\Altium\Altium Designer \Help ordner heruntergeladen. Diese neuere Version der HelpID-Datei hat Vorrang vor der Standarddatei im Hauptinstallationsordner \Help ordner.

Alternative Zugriffsmethoden

Auf die technische Dokumentation kann auch auf verschiedene andere Arten zugegriffen werden, z. B:

• Über eine externe Suche mit der Suchmaschine Ihres Webbrowsers, z.B. Google. Um eine solche Suche auf die Altium-Dokumentation zu fokussieren, geben Sie die Website als Präfix ein, indem Sie das Format site:altium.com/documentation

  (z.B., site:altium.com/documentation PCB Layout Replication).

• Indem Sie einem Link folgen, der in einem offiziellen Forumspost von Altium angegeben ist.

• Durch das Folgen von Links, die in anderen Bereichen der Haupt-Website altium.com verfügbar sind (z.B. im Bereich Learning Hub oder auf speziellen "What's New"- und Feature-Level-Seiten).

• Über spezielle Links in der Software. Zum Beispiel über ein Help menü, oder über 'Learn More' (oder ähnlich formulierte) Links.

Die Dokumentationsschnittstelle

Die Dokumentationsschnittstelle besteht in der Regel aus bis zu 14 verschiedenen Bereichen, die in der folgenden Abbildung dargestellt und im Folgenden näher erläutert werden.

1. Product Documentation Selector - Verwenden Sie dieses Steuerelement, um zwischen den einzelnen verfügbaren Dokumentationsbereichen zu wechseln.

2. Theme Selector - Verwenden Sie dieses Steuerelement, um zwischen hellen () und dunklen () Darstellungsmodi zu wechseln, wie im folgenden Beispiel dargestellt.

   

   

3. Search - Verwenden Sie dieses Feld, um einen Suchbegriff einzugeben und Informationen innerhalb der gerade angezeigten Produktdokumentation zu finden. Mit den entsprechenden Suchfiltern können Sie den Umfang der Suche danach anpassen. Weitere Einzelheiten finden Sie unter Dokumentations-Suchfunktion.

4. Nav Tree Pane - zeigt alle Bestandteile der Produktdokumentation an, die gerade angezeigt werden. Klicken Sie auf einen logisch aufgebauten Eintrag, um diese Seite anzuzeigen. Mit den Steuerelementen oben rechts können Sie die Größe des Fensters ändern und/oder seine Sichtbarkeit steuern.

5. QuickLinks - eine spezielle und statische Komponente des Nav Tree die immer angezeigt wird, unabhängig davon, welche Produktdokumentation gerade angezeigt wird. Sie bietet einen schnellen Zugang zu dieser Seite, zu Copyright-Informationen und zum Hauptportal der Dokumentation sowie einen schnellen Zugriff auf die Wissensdatenbank.

6. Breadcrumbs - Bereitstellung einer sekundären Navigationsmöglichkeit zu übergeordneten Seiten in der Hierarchie, basierend auf der aktiven Seite, die gerade gelesen wird. Wenn der Breadcrumb-Pfad viele Seiten umfasst, wird ein Ellipsis-Steuerelement verwendet, um die Anzeige übersichtlich zu halten. Klicken Sie darauf, um ein Pop-up-Fenster mit allen zusätzlichen Zwischenseiten im Pfad aufzurufen, die jeweils einen aktiven Link zu der entsprechenden Seite enthalten.

   

7. Main Page Content - Dies ist der Hauptbereich der Benutzeroberfläche, in dem die im Fenster ausgewählte Seite angezeigt wird Nav Tree fensterbereich. Weitere Einzelheiten zu verschiedenen Aspekten des Inhalts einer Seite sowie Tipps zu den Merkmalen und Funktionen der einzelnen Komponenten finden Sie unter Anzeigen eines technischen Dokuments.

8. Feature Availability Note - Dies wird auf jeder Seite innerhalb bestimmter Sätze der Dokumentation dargestellt. Die technische Dokumentation enthält alle Features und Funktionalitäten eines Produkts oder eines Elements einer Gesamtlösung. Im Falle von Altium Designer und Altium 365 hängt es davon ab, welche Altium-Lösung Sie haben - Altium Develop, eine Edition von Altium Agile (Agile Teams oder Agile Enterprise) oder Altium Designer (mit aktiver Laufzeit) - ob Sie Zugriff auf eine Funktion haben, die auf einer Seite vorgestellt wird. Wenn Sie eine besprochene Funktion nicht in Ihrer aktuellen Software sehen, wenden Sie sich an den Altium-Vertrieb, um mehr darüber zu erfahren.

9. Legacy Documentation Note - Dies wird auf jeder einzelnen Seite der Altium Designer-Dokumentation dargestellt. Sie bietet einen schnellen Zugriff auf den Abschnitt Legacy Documentation auf der Seite Other Installers, wo Sie die Dokumentation zu älteren Versionen der Software finden.

10. Table of Contents - Der Content bereich des rechten Fensters zeigt, wo zutreffend, die Struktur der aktiven Seite in Form ihrer Überschriften (Ebenen 2-4, da Ebene 1 der Titel der Seite ist). Klicken Sie auf einen Eintrag, um zu dieser Stelle auf der Seite zu springen. Umgekehrt wird beim Blättern auf der Seite der Content bereich aktualisiert, um zu verfolgen, wo Sie sich im Dokument befinden.

11. Like/Dislike - die allgegenwärtige "Daumen hoch/runter"-Funktion, mit der Sie schnell bewerten können, ob eine Seite hilfreich war oder nicht, und, falls nicht, uns mitteilen können, warum (verfügbar, wenn Sie in Ihrem Altium-Konto angemeldet sind). Weitere Einzelheiten finden Sie unter Like/Dislike-Funktionalität.

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

13. Documentation Feedback (wird angezeigt, wenn Sie in Ihrem Altium-Account angemeldet sind) - diese Funktion bietet Ihnen eine schnelle Möglichkeit, dem Team der Technischen Dokumentation Ihr Feedback zu einer Seite zukommen zu lassen, das eher darauf abzielt, Tippfehler, falsche/veraltete Informationen oder fehlende Informationen hervorzuheben. Markieren Sie einfach den Text und/oder ein Bild auf der Seite und verwenden Sie die Ctrl+Enter tastaturkürzel, um die Funktion aufzurufen. Weitere Einzelheiten finden Sie unter Feedback-Mechanismus für die Dokumentation.

14. Printer-friendly version - Bereitstellung von Mitteln, mit denen on-the-fly eine Version der Seite erzeugt werden kann, deren Inhalt speziell für den Druck vorbereitet ist (z. B. zum Speichern als PDF).

Paging der Struktur

Innerhalb des Nav Tree der Benutzeroberfläche werden Sie manchmal auf Einträge stoßen, die, wenn Sie darauf klicken, keine Dokumentationsseite anzeigen. Diese Einträge dienen der zusätzlichen Strukturierung der Baumstruktur, wenn eine Gruppierung von Seiten unter einer übergeordneten Seite erforderlich ist, die Informationen auf der übergeordneten Seite selbst jedoch nicht benötigt werden. Diese Art von Seite - eine Structure seite - tut genau das. Wenn Sie den Mauszeiger über einen solchen Eintrag bewegen, wird er nicht unterstrichen (wie der Eintrag für eine "echte" Seite der Dokumentation). Wenn Sie auf einen solchen Eintrag klicken, wird der entsprechende Abschnitt der Baumstruktur einfach erweitert. Klicken Sie erneut, um ihn wieder zu schließen.

Anzeigen eines technischen Dokuments

Die folgenden Abschnitte enthalten Informationen über verschiedene Aspekte des Seiteninhalts selbst.

Dokumentenkonventionen

Bold	Wird verwendet, um einen Menübefehl, ein Dialogfeld, eine Schaltfläche oder eine Symbolleiste hervorzuheben, auf die im Text verwiesen wird. Beispiele: Verwenden Sie den Annotate Schematics Quietly befehl. Wenn die Option Copy routed nets im Dialog aktiviert ist, wird das Routing vom Quellblock aus platziert. Klicken Sie auf die Schaltfläche Refresh schaltfläche oben im Dialogfeld Constraint Manager. Auffinden und Verwenden des Place Pad befehl () auf der Registerkarte Active Bar oder Wiring symbolleiste.
Italic	Wird verwendet, um ein Bedienfeld oder ein Dialogfeld zu markieren, auf das im Text verwiesen wird. Beispiele: Der Zugriff auf die PCB CoDesign-Funktionen erfolgt über das PCB CoDesign bedienfeld. Schaltplananmerkungen werden über den Annotate dialog. Kursivschrift wird bei Bedarf verwendet, um einen wichtigen Punkt hervorzuheben.
Monospace	Wird verwendet, um einen Festplattenspeicherort, einen Dateinamen, eine Dateierweiterung, einen Ausdruck in einer Abfragesprache oder ein Sprachschlüsselwort, auf das im Text verwiesen wird, hervorzuheben. Beispiele: Als Teil der Erstinstallation wird eine Auswahl von Beispielen installiert. Bei einer Standardinstallation der Software befinden sich diese im Ordner \Users\Public\Documents\Altium\AD\Examples ordner. Der Zugriff auf dieses assistentengestützte Installationsprogramm erfolgt durch Ausführen einer kleinen ausführbaren Datei - AltiumDesignerDevelopSetup.exe (oder AltiumDesignerAgileSetup.exe). Ein Draftsman-basiertes Fertigungszeichnungsdokument kann zu einem PCB-Design-Projekt (*.PCBDwf), einem Kabelbaumentwurfsprojekt (*.HarDwf) oder einem Multi-Board-Design-Projekt (*.MbDwf). TouchesRoom('Monitor','Auxilary','Effects')
Bold + Monospace	Dient zum Hervorheben eines Tastaturkürzels, auf das im Text verwiesen wird. Beispiele: Klicken Sie mit der rechten Maustaste oder drücken Sie Esc um den Platzierungsmodus zu beenden. Drücken Sie die Taste Spacebar um das Textobjekt gegen den Uhrzeigersinn zu drehen oder Shift+Spacebar für eine Drehung im Uhrzeigersinn.
Menu » Menu Item	Hauptmenüverweise in der Altium Designer Dokumentation verwenden das Zeichen " als Trennzeichen. Der erste Eintrag verweist auf das Menü selbst, gefolgt von dem Befehl in diesem Menü. Wenn auf einen Befehl von einem Untermenü aus zugegriffen wird, dann wird ein zusätzliches " Zeichen verwendet, um dies anzuzeigen. Beispiele: Die Konfiguration für die Entwurfsregelprüfung erfolgt im Design Rule Checker dialog, der über den Befehl Tools » Design Rule Check aus einem PCB-Dokument aufgerufen wird. Die Kabelbaumeinträge sind für die Platzierung im Schaltplaneditor verfügbar. Wählen Sie Place » Harness » Harness Entry aus den Hauptmenüs.
Tab | Group | Button	Hauptmenü-Referenzen in der Dokumentation von Altium CircuitStudio und Altium CircuitMaker verwenden das Zeichen | als Trennzeichen. Der erste Eintrag verweist auf die spezifische Registerkarte des Ribbon-Menüs, gefolgt von der Gruppe (oder Region) der Registerkarte und schließlich der Schaltfläche innerhalb dieser Gruppe. Wenn ein Befehl über ein Menü aufgerufen wird, das mit einer Schaltfläche verknüpft ist, wird das Zeichen " verwendet, um dies anzuzeigen. Beispiele: Das View Configuration panel, mit dem konfiguriert werden kann, was aktuell im Designbereich angezeigt wird und wie es angezeigt wird, kann vom PCB-Editor aus aufgerufen werden, indem man View | PCB | View Configuration. Um die aktuell ausgewählten Objekte zu verschieben, verwenden Sie den Tools | Arrange | Move » Move Selection befehl.
Key1+Key2	Wenn Sie sich auf Tastenkombinationen beziehen, bedeutet die Verwendung des Pluszeichens (+), dass Sie mehrere Tasten auf der Tastatur in der angegebenen Reihenfolge gedrückt halten. Beispiele: Shift+H (um das Heads Up Display im PCB-Editor ein- oder auszuschalten). Shift+Ctrl+X (um den Cross-Select-Modus im Schaltplan/PCB-Editor ein- oder auszuschalten).
Key1, Key2	Wenn Sie sich auf Tastensequenzen beziehen, bedeutet die Verwendung des Komma-Symbols (,), dass Sie jede Taste in der Sequenz nacheinander drücken. Beispiele: X, A (im Schaltplan-Editor, um die Auswahl aller Objekte auf dem aktuellen Blatt aufzuheben). P, V, K (im Schaltplan-Editor, um eine Kompiliermasken-Anweisung zu platzieren). T, D, R (im PCB-Editor, um eine Batch-Design-Regelprüfung durchzuführen).
Link	Ein normaler Hyperlink zu einem Ziel, das sein kann: Zu einem anderen Bereich der gleichen Seite. Zu einer anderen Seite innerhalb desselben Produktdokumentationssatzes. Zu einer anderen Seite innerhalb eines anderen Produktdokumentationssatzes. Zu einer Seite außerhalb der technischen Dokumentation.
Info-Box	Dient zur Hervorhebung wichtiger Zusatzinformationen zu einem bestimmten Thema, das auf der Seite behandelt wird. Beispiel: Die Quelle für die Stücklistendaten eines Kabelbaumprojekts ist die Layoutzeichnung des Projekts. Wenn also das Verdrahtungsschema Ihres Kabelbaumentwurfs geändert wurde und sich diese Änderung in der Stückliste widerspiegeln soll, muss zuerst die Layoutzeichnung aktualisiert werden.
Merkmal/Tipp-Box	Wird verwendet, um ein bestimmtes Merkmal oder eine bestimmte Funktionalität hervorzuheben, oder um einen Tipp für deren Verwendung zu geben. Beispiel: Der Satz von Altium Designer Beispielprojekten enthält ein Beispielprojekt für das Design von Kabelbäumen -Harness_Demo_Prj.PrjHar - im Ordner \Users\Public\Documents\Altium\AD\Examples\Harness Demo MB\Harness_Demo_Prj ordner, das standardmäßig mit einem Multi-Board-Demoprojekt verbunden ist (\Examples\Harness Demo MB\Harness_Demo_MB\Harness_Demo_MB.PrjMbd) zugeordnet ist, so dass Sie Kabelbäume direkt nach dem Auspacken testen können.
Warnbox	Wird verwendet, um auf etwas hinzuweisen, das wichtig ist oder das durchgeführt werden sollte. Beispiel: Es wird besonders empfohlen, vor der Erstellung von Reinzeichnungen immer eine Designregelprüfung im Batch-Modus durchzuführen. Der Online-DRC erkennt nur neue Verstöße, d. h. Verstöße, die nach der Aktivierung der Funktion auftreten, während der Batch-DRC eine manuelle Prüfung zu einem beliebigen Zeitpunkt während des Leiterplattenentwurfs ermöglicht. Gute Designer kennen zwar den Wert des Online-DRC, aber sie wissen auch, dass das Board-Design mit einem Batch-DRC beginnen und enden sollte.

Ansprechendes Bildmaterial

In der gesamten Dokumentation finden Sie eine Vielzahl von visuellen Elementen, die dazu dienen, Informationen auf eine ansprechende Art und Weise zu vermitteln. Die folgenden Abschnitte veranschaulichen, wie diese auf einer Seite erscheinen und wie sie verwendet werden.

Statisches Bild

Das einfache statische Bild ist ein Eckpfeiler der Dokumentation, der in Verbindung mit dem umgebenden Text verwendet wird, um Einzelheiten über einen wichtigen Aspekt der Software zu vermitteln.

Um die Darstellung (und Lesbarkeit) eines Dokuments überschaubar zu halten, wird eine feste Breite für eine Seite verwendet. Daher können Bilder in der Regel nicht in voller Größe dargestellt werden. Wenn Sie mit dem Mauszeiger über ein Bild fahren, ändert sich die Darstellung von einem Zeigersymbol () zu einem Lupensymbol (). Wenn Sie auf das Bild klicken, wird es in voller Größe in einem schwebenden Fenster angezeigt (falls zutreffend und in Übereinstimmung mit der aktuellen Größe Ihres Browserfensters). Das folgende Bild veranschaulicht dies für ein statisches Bild in der Dokumentation (ironischerweise müssen Sie auf das Bild klicken, um es in voller Größe zu sehen).

Diashow

Ein Diashow-Element kann aus mehreren Bildern (und Videos) bestehen, um mehr visuelle Informationen zusammen mit Beschriftungen zu zeigen. Dieses Element ist besonders nützlich, wenn Sie eine Progression oder eine schrittweise Abfolge bei der Verwendung einer bestimmten Funktion der Software veranschaulichen möchten.

Das folgende Bild zeigt ein Beispiel für eine Diashow in der Dokumentation und hebt einige Schlüsselbereiche hervor, die im Folgenden beschrieben werden.

1. Mit diesen Steuerelementen können Sie in der Diashow vor- und zurückblättern. Wenn Sie den Mauszeiger über einen Bereich bewegen, wird dieser dunkler. Sie können überall im "Pfeilrahmen" klicken, nicht nur auf das Pfeilsymbol selbst.

2. Diese "Blasen" zeigen an, wie viele Dias in der Show enthalten sind und an welcher Stelle des Sets Sie sich befinden (dunklere Blase). Sie können auf eine Blase klicken, um schnell zu dieser Folie zu springen.

3. Eine Diashow kann Beschriftungen enthalten - eine Beschriftung pro Dia. Diese werden aktualisiert, wenn Sie durch die verschiedenen Dias klicken.

Animiertes Gif

Ein animiertes Gif wird verwendet, wenn ein Prozess oder ein Aspekt der Software in einer videoähnlichen Form dargestellt werden soll, die visuelle Darstellung aber nur kurz ist und ein Video zu lang wäre. Ein animiertes Gif in der Dokumentation zeichnet sich dadurch aus, dass es in der Mitte eine auffällige "Play"-Schaltfläche hat, wie in der folgenden Abbildung dargestellt. Wenn Sie auf die Schaltfläche klicken, wird das Gif bis zum Ende abgespielt und dann gestoppt, wobei die Schaltfläche erneut angezeigt wird.

Video (MP4)

Ein Video wird wie ein Gif verwendet, wenn ein Prozess oder ein Aspekt der Software visuell festgehalten werden soll und wenn der visuelle Inhalt länger ist als für ein Gif geeignet. Ein Video in der Dokumentation zeichnet sich durch ein Kontrollfeld am unteren Rand aus, wie in der folgenden Abbildung dargestellt. Klicken Sie auf eine beliebige Stelle des Videos, um es abzuspielen (Sie müssen nicht auf den Abspielpfeil unten links klicken). Klicken Sie erneut (auf eine beliebige Stelle des Videos), um die Wiedergabe zu unterbrechen. Verwenden Sie die verfügbaren Videosteuerelemente, um z. B. zur vollen Größe und zurück zu wechseln, entlang der Zeitachse vor- und zurückzuspringen und die Abspielgeschwindigkeit zu ändern.

Schwebebild

Ein Schwebebild wird verwendet, um ein Vorher-Nachher-Szenario oder eine Art Vergleich in Bezug auf ein Merkmal oder eine Funktion der Software zu präsentieren. Es besteht nur aus zwei Bildern. Es erscheint auf der Seite wie ein normales statisches Bild, wobei das erste Bild standardmäßig angezeigt wird. Wenn Sie mit dem Mauszeiger darüber fahren, erscheint das zweite Bild.

Im Folgenden finden Sie ein reales Beispiel für ein Schwebebild, das in der Dokumentation verwendet wird. In diesem Fall wird es zur Veranschaulichung von Abschirmungsvias (Standardbild/erstes Bild) und Stitching Vias (zweites Bild, das beim Überfahren mit dem Mauszeiger erscheint) verwendet.

Pop-up-Bild

Ein Pop-up-Bild wird verwendet, um etwas im Kontext des umgebenden Textes zu zeigen, ohne dass das Bild ausdrücklich zum Inhaltsfluss hinzugefügt wird. In dieser Hinsicht könnte man es eher als eine Art "Nebenbemerkung" oder Beispiel betrachten, das einen Kommentar oder eine Aussage im Text unterstreicht. Ein solches Element erscheint mit einem von zwei Symbolen - (ein Pop-up-Bild) oder (ein animiertes Pop-up-Gif oder Video). Das folgende Bild zeigt ein Pop-up-Element, wenn es angeklickt wird, in diesem Fall ein Pop-up vom Typ "Bild", das das Bild in voller Größe zeigt.

Hover-Text (Tooltip)

Hover-Text (oder ein Tool-Tipp) wird verwendet, um zusätzliche, hilfreiche Hinweise im Zusammenhang mit einem bestimmten Eintrag auf einer Seite zu geben. Dabei kann es sich z. B. um eine Erläuterung zu einem Eintrag oder um eine glossarähnliche Erklärung der verwendeten Terminologie handeln. Ein Tooltip kann auf zwei Arten erscheinen:

• Das Symbol . Bewegen Sie den Mauszeiger über das Symbol, um den Tipp aufzurufen.

  

• Text mit einer gepunkteten Unterstreichung. Bewegen Sie den Mauszeiger über den Text, um den Tipp aufzurufen.

  

Ausklappbare Abschnitte

Um den Seiteninhalt übersichtlich zu halten, werden ausklappbare Abschnitte verwendet. Diese werden in der Regel für Informationen verwendet, die eine größere Tiefe haben, aber nicht unbedingt benötigt werden, um den typischen Seitenfluss zu verstehen (und daher nicht offen dargestellt werden müssen). Solche Inhalte könnten zum Beispiel Optionen sein, die in einem Dialog oder Panel verfügbar sind, oder spezielle Überlegungen zu einem bestimmten Aspekt einer Funktion, die im Hauptinhalt behandelt wird. Erweitern bzw. reduzieren Sie einen solchen Abschnitt, indem Sie auf eine beliebige Stelle in der Kopfzeile des Abschnitts klicken.

Einen Link zur Seite oder zu einem bestimmten Abschnitt erhalten

Wenn Sie eine Seite für andere freigeben möchten, müssen Sie schnell an die URL der Seite gelangen können. Diese kann auf verschiedene Weise ermittelt (in die Windows-Zwischenablage kopiert) werden:

1. Aus der Adressleiste Ihres Browsers, wenn Sie die Seite zum ersten Mal aufrufen.

2. Durch Rechtsklick auf den Eintrag der Seite in der linken Navigationsstruktur und anschließende Verwendung des Befehls Copy link address aus dem Kontextmenü.

Darüber hinaus können Sie auch eine URL zu einem bestimmten Abschnitt der Seite, die Sie gerade lesen, wie folgt abrufen:

1. Verwenden Sie das rechte Fenster, um den gewünschten Abschnitt innerhalb der Inhaltsstruktur der Seite aufzurufen, und kopieren Sie dann die URL aus der Adressleiste Ihres Browsers.

2. Blättern Sie auf der Seite nach unten zum gewünschten Abschnitt. Während des Scrollens wird die Adressleiste Ihres Browsers aktualisiert und zeigt den aktuellen Abschnitt an, den Sie erreicht haben.

3. Klicken Sie mit der rechten Maustaste auf den Eintrag des gewünschten Abschnitts in der Inhaltsstruktur der Seite (im rechten Fensterbereich) und verwenden Sie dann den Befehl Copy link address aus dem Kontextmenü.

Sie können auch an den folgenden Stellen schnell einen Link "greifen":

• Main Section Header - klicken Sie auf das Steuerelement "Link kopieren" links neben der Überschrift eines Hauptabschnitts.

  

• Collapsible Section - klicken Sie auf das Steuerelement "Link kopieren" rechts neben dem Titel eines ausklappbaren Abschnitts.

  

Versionierte Dokumentation

Für Altium On-Prem Enterprise Server ist die zugehörige Dokumentation versioniert. Dadurch können Sie die richtige Version der Dokumentation für die von Ihnen verwendete Softwareversion auswählen. Die Version kann entweder über das Hauptportal der Dokumentation (über das Menü der Produktkachel QuickLinks menü) oder jederzeit innerhalb der Dokumentation mit Hilfe des Versionswählers im oberen Bannerbereich ausgewählt werden, wie unten dargestellt.

Das Versionierungssystem warnt Sie, wenn Sie eine Seite lesen, die nicht die neueste Version dieser Seite ist. Es tut dies auf zwei Arten:

• Die Versionsnummer in der Versionsauswahl wird in einer anderen Farbe angezeigt und mit einem Warnsymbol versehen.
• Oben auf der Seite befindet sich ein Warnhinweis mit einem Link zur neuesten Version. Wenn Sie dem Link folgen, wird der Eintrag in der Versionsauswahl automatisch auf die neueste verfügbare Version umgestellt.

Anwendbare Versionen

Während sich die Software von Version zu Version weiterentwickelt und neue Features und Verbesserungen der Funktionalität hinzufügt, kann die zugehörige versionierte Dokumentation für Altium On-Prem Enterprise Server nur in bestimmten Bereichen davon betroffen sein. Viele Seiten werden von der nächsten Version der Software nicht betroffen sein, so dass derselbe Inhalt, der zuvor galt, nun auch für diese spätere Version gilt. Daher wird auf jeder Seite angegeben, für welche Versionen der Software der Inhalt der Seite verwendet werden kann.

Die folgende Abbildung zeigt einen solchen Hinweis. Hier ist Version 8.0 der Seite geöffnet, die die Funktion Projektverlauf beschreibt. Dieser Inhalt gilt gleichermaßen für die Versionen 7.0, 7.1 und 7.2 der Software. Mit anderen Worten: Es gibt keinen Unterschied im Inhalt der Seite, wenn Sie den Versionsselektor für die Dokumentation auf 7.0, 7.1, 7.2 oder 8.0 setzen.

Suchfunktion für die Dokumentation

Eine leistungsstarke Suchfunktion hilft Ihnen bei der Suche nach Informationen in der technischen Dokumentation für Altium Design Solutions Search funktion. Mit Hilfe von Google gibt es eine einzige Suchfunktion für die gesamte altium.com-Website. Wie und wo Sie auf die Suche zugreifen, bestimmt, wie "gefiltert" Ihre ersten Ergebnisse sein werden:

• Über das Banner auf der obersten Ebene der Website, das wie in der folgenden Diashow gezeigt aufgerufen und verwendet wird. Die Suche wird auf der gesamten Website durchgeführt, wobei die Ergebnisse in einem separaten Browser-Tab angezeigt werden.

• Über die "Eingangstür" der technischen Dokumentation(altium.com/documentation) - Zugriff und Verwendung wie in der folgenden Diashow dargestellt. Die Suche wird in allen Dokumentationen durchgeführt, die für die verschiedenen Altium-Designlösungen verfügbar sind, sowie in der Knowledge Base. Die Ergebnisse werden auf der gleichen Browser-Registerkarte angezeigt.

• Von einer Seite innerhalb der technischen Dokumentation aus - Zugriff und Verwendung wie in der folgenden Diashow dargestellt. Die Suche wird nur innerhalb des aktiven Dokumentations-Sets durchgeführt, das gerade angezeigt wird. Die Ergebnisse werden auf der gleichen Registerkarte des Browsers angezeigt.

QuickNav Paging (Altium Designer Dokumentation)

Die Informationen zu den Designobjekten und Panels in Altium Designer sind über viele Seiten in der Altium Designer-Dokumentation verstreut. Um ein Mittel bereitzustellen, mit dem man leicht zu diesen Informationen navigieren kann, wurde das Konzept des QuickNav paging verwendet. Analog zu einer Karte in einem Einkaufszentrum bietet eine QuickNav-Seite Schnellreferenzinformationen zu den Designelementen, die für einen bestimmten Designbereich verfügbar sind, und gibt Ihnen die Möglichkeit, schnell zu detaillierteren Informationen über die einzelnen Elemente zu navigieren.

In den meisten Fällen wird eine QuickNav-Seite Informationen in drei verschiedenen Abschnitten präsentieren:

• Graphical Overview - ein zusammengestelltes Bild von häufig verwendeten Objekten, zum Beispiel.
• Slideshow - mehr Übersichtsinformationen zu einigen der Elemente, die Sie häufiger verwenden werden.
• A-Z Listing - eine praktische alphabetische Auflistung. Kein Schnickschnack, keine Aufregung. Nur direkte Links zu den Details für ein bestimmtes Element.

QuickNav Paging ist für die folgenden Elemente verfügbar:

• Schaltplan-Design-Objekte

• PCB-Entwurfsobjekte

• Draftsman Entwurfsobjekte

• Multi-Board-Schaltplanentwurfsobjekte

• Kabelbaum-Design-Objekte

• Schalttafeln

QuickStart Paging (Altium Designer-Dokumentation)

Innerhalb der Altium Designer-Dokumentation (die die Plattformlösungen von Altium unterstützt) gibt es wichtige Seiten auf oberster Ebene, die zusammen betrachtet eine wertvolle Reihe von QuickStart"-Informationen bieten. Diese Seiten führen Sie durch einen bestimmten Designbereich und geben Ihnen genau die richtige Menge an Details, damit Sie mit dem Verständnis dieses Bereichs beginnen können, ohne zu tief einzutauchen. Diese Seiten sind:

• Sich mit der Altium Design-Umgebung vertraut machen

• Erfassen Ihrer Design-Idee als Schaltplan

• Analysieren Ihres Designs mit Hilfe der Schaltungssimulation

• Stücklistenverwaltung mit ActiveBOM

• Verwaltung von Designänderungen zwischen Schaltplan und PCB

• Layouten Ihres PCBs

• Rationalisierung der Board-Design-Dokumentation mit Draftsman

• Vorbereiten Ihres Designs für die Fertigung

• Entwerfen mit mehreren PCBs

• Kabelbaum-Design

Like/Dislike-Funktionalität

Um eine grobe Analyse für das Blättern in der technischen Dokumentation zu erhalten, wird die allgegenwärtige Funktion "Daumen hoch/runter" verwendet. Damit können wir sehen, wie nützlich eine Seite ist, und wenn sie es nicht ist, können wir sie für eine Nachbesserung vormerken. Die Steuerelemente für diese Funktion befinden sich unter dem Content (ToC) für die Seite im rechten Fensterbereich. Klicken Sie einmal auf ein Daumensymbol, um Ihre "Stimme" zu registrieren, klicken Sie erneut, um sie zu entfernen. Wenn Sie auf das Thumbs Down symbol AND klicken, wenn Sie in Ihrem Altium-Konto angemeldet sind, haben Sie die Möglichkeit, ein Feedback zu geben, warum die Seite für Sie nicht nützlich war. Dadurch wird ein Bericht direkt an das Team der Technischen Dokumentation gesendet.

Feedback-Mechanismus für die Dokumentation

Von Zeit zu Zeit kann es vorkommen, dass Sie auf ein Problem in einem Dokument stoßen, wie z.B. einen Tippfehler, ein Zugriffsproblem, falsche/unklare Informationen oder veraltete Informationen. Irren ist menschlich, und wir hoffen, dass Sie, unsere Leser, uns helfen, diese Probleme zu beheben. Zu diesem Zweck enthält die technische Dokumentation einen Feedback-Mechanismus, auf den von jeder Seite aus zugegriffen werden kann und der einen Bericht direkt an das Team für technische Dokumentation sendet.

Dieser Feedback-Mechanismus wird über die Ctrl+Enter tastaturkürzel. Wenn Sie sich auf einen bestimmten Text- und/oder Bildabschnitt beziehen möchten, wählen Sie ihn aus (maximal 200 Zeichen), bevor Sie die Taste Ctrl+Enter.

Nach dem Zugriff auf die Funktion wird das Report Document Issue fenster angezeigt, wobei der referenzierte Text/das referenzierte Bild (falls zutreffend) hinzugefügt wird. Verwenden Sie das Issue feld (max. 500 Zeichen), um so viele Details wie möglich anzugeben - es hilft uns wirklich, ein gültiges Problem zu untersuchen und schneller zu lösen. Wenn Sie fertig sind, klicken Sie auf die Send Feedback um die Meldung abzuschicken. Eine Bestätigungsnachricht bestätigt die erfolgreiche Übermittlung und den Erhalt Ihres Berichts. Wir können gar nicht oft genug betonen, wie wichtig uns Ihr Feedback ist und dass wir es sehr zu schätzen wissen!

Unterstützung für das Betrachten auf jedem Gerät

Vorbei sind die Zeiten, in denen jeder Designer vor einem Desktop-Computer mit einem einzigen 1280x1024-Monitor saß. Heute verfügen unsere Desktop-PCs über mehrere Monitore unterschiedlicher Größe und Auflösung. Wir müssen auch in der Lage sein, von einem Laptop aus zu arbeiten, wenn wir im Außendienst oder im Büro des Kunden sind. Und da wir Wissensdurstige sind, möchten wir auch unser Tablet oder Telefon benutzen können, um mehr Informationen aufzunehmen, während wir auf den Flug warten oder den Bus ins Büro nehmen.

Um die Inhalte so zu präsentieren, dass sie auf all diesen verschiedenen Geräten funktionieren, verwendet die technische Dokumentation (als Teil der übergeordneten Website altium.com ) responsive web design. Eine responsive Website kommuniziert mit dem Zielgerät und passt das Layout und die Größe des Inhalts an das jeweilige Gerät, die Bildschirmauflösung und die Browsergröße an. Wenn Sie die Breite Ihres Browsers verkleinern, werden die Seitenelemente neu angeordnet und die Schriftarten und Bilder werden kleiner. Selbst auf einem 5-Zoll-Bildschirm ist die Website funktional, da z. B. der Navigationsbaum auch auf Ihrem Tablet oder Telefon als Dropdown verfügbar ist.

Druckerfreundliche Dokumentation

Möchten Sie einen Teil der technischen Dokumentation ausdrucken? Da wir die Online-Funktionalität nutzen und auch viele schicke visuelle Effekte verwenden, um die Informationen zu vermitteln, müssen Sie zunächst sicherstellen, dass eine Seite so vorbereitet ist, dass Sie sie an Ihr vertrautes Druckgerät senden (oder als PDF speichern) können. Auf der rechten Seite des unteren Bannerbereichs finden Sie ein entsprechendes Steuerelement, mit dem Sie eine druckerfreundliche Version der Seite erhalten.

Lokalisierte Dokumentation

Einige unserer Inhalte sind auch in anderen Sprachen als Englisch verfügbar. Verwenden Sie die Sprachauswahl auf der linken Seite des unteren Bannerbereichs, um die gewünschte Sprache aus den derzeit unterstützten Sprachen auszuwählen.

Die alternativen Sprachinhalte für eine bestimmte Version einer Seite werden automatisch angezeigt, wenn sie verfügbar sind, andernfalls werden die englischen Inhalte angezeigt. Die folgende Diashow veranschaulicht die Lokalisierung für eine Seite, die in Englisch, Japanisch, Chinesisch, Koreanisch und Polnisch verfügbar ist.

Browser-Übersetzung (inoffiziell)

Je nach dem von Ihnen bevorzugten Webbrowser haben Sie möglicherweise Zugriff auf eine temporäre On-the-fly-Übersetzung der aktiven Seite, die Sie gerade lesen. Die folgende Diashow veranschaulicht die Verwendung der Übersetzungsfunktion von Google Chrome, um die Seite schnell in einer der unzähligen unterstützten Sprachen anzuzeigen, in diesem Fall Deutsch. Beachten Sie, dass die Übersetzung nur vorübergehend ist - wenn Sie auf eine andere Seite und zurück klicken oder die Seite aktualisieren, wird die angezeigte Sprache wiederhergestellt.

Die Wissensdatenbank

Viele Leute finden den Weg in die Altium Knowledge Base und nehmen an, dass dies der Umfang unserer technischen Dokumentation ist. Tatsächlich handelt es sich aber um eine eigenständige Ressource. Tatsächlich bilden die beiden eine symbiotische Beziehung, in der die Wissensdatenbank und die technische Dokumentation miteinander verknüpft sind und sich gegenseitig ergänzen, damit Sie die Informationen erhalten, die Sie suchen.

Die Wissensdatenbank ist eine Anlaufstelle für den Self-Service, deren Inhalte von Mitgliedern der Altium Support-Organisation kuratiert werden - Menschen, die über Expertenwissen zu Altium-Lösungen verfügen. Diese Inhalte werden direkt aus Problemen erstellt, auf die andere Benutzer gestoßen sind. Das Ergebnis ist ein organisches Repository von Artikeln, die gezielte Antworten/Lösungen für Themen und Eckfälle bieten. Zielgerichtete, schnell zu lesende Artikel, die Sie wieder zum Laufen bringen.

Die Schnittstelle zur Wissensdatenbank ist denkbar einfach. Sie können entweder alle Artikel durchsuchen oder gezielt Artikel in einer der unterstützten Kategorien für Designlösungen. Beginnen Sie dann einfach mit der Eingabe eines Suchbegriffs - die Filterung wird dabei angewendet. Wenn Sie einen Artikel gefunden haben, der Sie interessiert, klicken Sie auf den entsprechenden Eintrag, um ihn zu öffnen.

Copyright der Dokumentation

Die Copyright-Informationen zur Technischen Dokumentation sind in der nachstehenden Abbildung dargestellt und können über den Abschnitt QuickLinks des Navigationsbereichs(Copyright-Informationen zur Dokumentation) aufgerufen werden, der bei der Anzeige einer beliebigen Seite der Technischen Dokumentation verfügbar ist. Die Seite enthält einen Link zur Seite Copyrights & Trademarks auf der Hauptwebsite von altium.com.

Ein Zitat zum Abschied...

Dies ist ein Mantra, an das sich das Team der Technischen Dokumentation hält und nach dem es strebt. Auch in Zukunft wird die technische Dokumentation weiterentwickelt werden, insbesondere unter dem Gesichtspunkt der Benutzerfreundlichkeit. Schließlich ist eine Fülle von Informationen nur dann nützlich, wenn unsere Benutzer sie auch finden können. Sobald neue Entwicklungen, Verbesserungen und Funktionen zur Verfügung stehen, wird diese Seite aktualisiert, um diese zusätzlichen Elemente zu reflektieren und hervorzuheben und um zu zeigen, wie man sie am besten nutzt, um an die benötigten Informationen zu gelangen.