Sie sind hier: Dokumentieren > AutoDoc-Funktionen > Automatische Hyperlinks
Close
Doc-O-Matic 10
Automatische Hyperlinks

Das Feature für automatische Hyperlinks ist ein herausragendes AutoDoc-Funktion von Doc-O-Matic. Wenn diese Funktion aktiviert ist (das ist die Standardeinstellung), dann durchsucht Doc-O-Matic den Text nach Teilen, die verknüpft werden können, und erstellt automatisch Hyperlinks von Wörtern und Symbolnamen zu anderen Themen.

Allgemeine Themen

Wenn ein Wort mit einer Themen-ID eines allgemeinen Themas übereinstimmt, wird das Wort automatisch mit diesem Thema verknüpft.

Themen von Symbolen

Abhängige vom Kontext des verknüpften Symbolnamens funktioniert die Funktion für automatische Hyperlinks auch wenn das verwendete Wort mit einem Symbolnamen übereinstimmt. In einer Klasse funktioniert die Funktion für automatische Hyperlinks zum Beispiel mit dem Symbolnamen. Bei Members von abgeleiteten Klassen erstellt Doc-O-Matic einen Hyperlink zum Member der Basisklasse. Wenn Sie möchten, dass Doc-O-Matic automatisch einen Hyperlink zu einem Member einer anderen Klasse erstellt, dann müssen Sie Klassenname::Membername oder Klassenname.Membername verwenden, damit Doc-O-Matic in der Lage ist das Member zu identifizieren. 

Wenn Sie Funktionen verknüpfen möchten, ist es nicht notwendig, dass Sie die Themen-IDs (Klassenname::Funktionsname@parm@parm) verwenden. Wenn Funktionsnamen nicht identifiziert werden können, weil es mehrere Funktionen mit demselben Namen gibt (zum Beispiel überladene Funktionen), dann erstellt Doc-O-Matic automatisch einen Hyperlink zur ersten Funktion, die im Sourcecode deklariert ist. 

Wenn Sie Namespaces verwenden gilt das selbe. Beim Verwenden von Namespaces wird vor den vollständigen Symbolnamen der vollständige Namespace gehängt. Es gibt zwei Möglichkeiten wie Sie das Feature für automatische Hyperlinks in Namespaces verwenden können:

  • Die Verwendungsinformation in Ihrem Sourcecode verwenden. Doc-O-Matic verknüpft dann zuerst Symbole innerhalb eines Namespaces und dann die Namespaces, die in der Klasse verwendet werden.
  • Die Verwendungsinformation für Namespaces ignorieren. Innerhalb eines Namespaces funktioniert die Funktion für automatische Hyperlinks auch wenn Sie den Namespace nicht zum Namen des Symbols hängen. Damit die Funktion für automatische Hyperlinks auch in anderen Namespaces funktioniert müssen Sie den vollständigen Namen des Symbols mit vorangestelltem Namespace verwenden.
Verknüpfungstext

Standard gemäß erscheint das verknüpfte Wort als Linktext in der Ausgabe. Wenn Sie möchten, dass als Linktext der Thementitel angezeigt wird, müssen Sie - für jeden Abschnitt getrennt - das Kontrollkästchen Replace link text with target title aktivieren. Weitere Informationen hierzu finden Sie in Neue Abschnitte.

Aliases für Hyperlinks

Damit Doc-O-Matic auch andere Wörter automatisch mit bestimmten Themen verknüpft, können Sie Aliases verwenden. Geben Sie nur die Wörter und Themen-IDs auf der Seite Alias ein.

Die folgende Tabelle zeigt, wo Sie automatische Hyperlinks aktivieren können und das entsprechende Hilfethema und die Seite der Settings.

Automatische Hyperlinks
Hilfethema/Option um die Funktion ein- und auszuschalten
Dokumentationstext für jede Konfiguration
AutoDoc > Linking
Aktiviert
Deklarationen und Codeabsätze für jede Konfiguration
AutoDoc > Linking
Aktiviert
Thema
Eigenschaften-Tags, Themeneigenschaften / <autolink onloff> Kommentarblock/ Themeneigenschaft Auto Linking
Abhängig von den Settings
Abschnitt
Neue Abschnitte / [General Settings] > Sections
Aktiviert
Wort für jede Konfiguration
AutoDoc > Linking- - Liste von ausgeschlossenen Wörtern
Zum Beispiel: a, an, and, as and so on
Ein bestimmtes Wort
Escape-Zeichenfolge / \"Wort"\ Kommentarblock
Deaktiviert
Wörter mit einer Mindestlänge für jede Konfiguration
AutoDoc > Linking - Mindestwortlänge
Länge: 0
Body Source Code
AutoDoc > Code Options > Body-Source Code
Deaktiviert
Andere Namespaces
[General Settings] > Source Parsing > Namespace Handling
Aktiviert
Copyright © 2000-2020 toolsfactory software inc. Alle Rechte vorbehalten.