Inhalts-Manager

Der Contents Manager zeigt alle Themen und Symbole (Elemente) eines Doc-O-Matic Projektes in einer Hierarchie. Mit Hilfe des Contents Manager kann man neue Dokumentation für ein Symbol erzeugen oder ein neues Thema erzeugen. Überdies kann man im Inhalts-Designer die Struktur der Dokumentation bestimmen und definieren welche Themen in welcher Konfiguration exportiert werden und welche Themen im Inhaltsverzeichnis aufscheinen.

Die Liste der Befehle zeigt, wie die Dokumentation mit Hilfe des Contents Manager verändert werden kann. Der Contents Manager ist sehr komplex und es gibt die verschiedensten Informationen, die angezeigt werden können.

Der Contents Manager besteht aus den folgenden Teilen:

Die Themenhierarchie, die alle Symbole, Themen, Spezielle Themen, Vorlagen und Snippets. Neben den Symbolen und Themennamen werden die folgenden Grafiken und Kontrollkästchen angezeigt:
- Grafiken für verschiedene Symbolarten und Themen.
- Grafiken, die den Dokumentationsstatus anzeigen. Alle Dokumentationsstati werden im Überblick Export und Dockmentationsstati aufgelistet.
- Exportstatus Kontrollkästchen. Alle Exportstati werden im Überblick Export und Dockmentationsstati aufgelistet.
Spalten, die verschiedene Eigenschaften der Themen anzeigen. Alle Spalten werden in dem Überblick Spalten des Contents Managers aufgelistet.
der Registerkarte Manage. Alle Schaltflächen und Befehle werden in dem Überblick Befehle im Contents Manager aufgelistet.
dem Kontextmenü (rechte Maustaste)
der Sourcecode-Ansicht
dem Filter

Um den Exportstatus zu ändern

Wählen Sie in der Hierarchie das Symbol oder Thema aus, dessen Exportstatus Sie ändern wollen.
Aktivieren Sie das Kontrollkästchen Export state neben dem Symbol oder Thema.

Um die Spalten anzupassen

Zeigen Sie auf dem kontextbezogenen Menü auf Columns.
Wählen Sie oder deselektieren Sie die Spalte, die Sie anzeigen oder nicht anzeigen möchten.

Befehle im Inhalts-Manager

Die folgende Tabelle erklärt alle Schaltflächen der Symbolleiste, alle Kommandos und Menüpunkte des kontextbezogenen Menüs:

Gruppe	Grafik	Befehl	Tastaturbefehle	Beschreibung
Navigate		Back		Hilft dabei durch die Dokumentation zu navigieren. Springt zu dem Thema, das vorher ausgewählt war.
Navigate		Forward		Nachdem die Schaltfläche Zurück benutzt wurde, springt der Fokus auf das nächste Thema, dass nach dem ausgewählten Thema ausgewählt war.
Navigate		Find Topic		Findet Themen in der Hierarchie.
Navigate		Filter		Blendet den Filter ein oder aus.
Navigate	>	Open > Open Source	Eingabe	Öffnet den Sourcecode des ausgewählten Themas im eingetragenen Programm oder dem Programm, das in den Programmeinstellungen angegeben ist.
Navigate		Open Implementation	Strg+Eingabe	Öffnet die Implementation des ausgewählten Symbols im eingetragenen Programm oder dem Programm, das in den Application Options angegeben ist.
		Show Source File in Windows Explorer		Zeigt die Datei, in der sich das Symbol befindet, im Windows Explorer an.
Navigate		Open External Topic > HTML File		Öffnet die HTML- Sourcedatein für das externen Themen im Source-Editor.
Navigate		Open External Topic > PDF File		Öffnet die PDF- Sourcedatein für das externen Themen im Source-Editor.
Navigate		Display > Don't Show Source		Blendet die Sourcecode-Ansicht aus.
Navigate		Display > Show Declaration Source		In der Sourcecode-Ansicht wird der Sourcecode der Deklaration angezeigt (die Deklaration wird von Doc-O-Matic konstruiert).
Navigate		Display > Show Body Source		Die Sourcecode-Ansicht zeigt die Implementierung der ausgewählten Funktion. Dieser Teil wird aus dem Sourcecode kopiert.
Navigate		Display > Show Both		Zeigt sowohl die Deklaration als auch die Implementierung an in der Sourcecode-Ansicht an.
Navigate		Display > Show Source File		Zeigt die gesamte Sourcedatei in der Sourcecode-Ansicht an.
		Display > Option		Öffnet die Programmeinstellungen für den Contents Manager.
		Copy Topic ID to Clipboard		Kopiert die Themen-ID des ausgewählten Themas in die Zwischenablage. Dies ist beim Bearbeiten der Topics sehr nützlich. Alle Themen-IDs sind auch im Topic Picker des Editors aufgelistet.
Create Content		QuickDoc	F4	Erzeugt ein neues Thema für die aktuellen Symbole und Themen entsprechend den QuickDoc Einstellungen für diese Symbole.
Create Content	>	QuickDoc Settings		Ändert die Einstellungen für QuickDoc.
Create Content		Document	Strg+F4	Erzeugt ein neues Thema für das ausgewählte Symbol, wenn dieses noch undokumentiert ist.
Create Content		New Topic		Erzeugt ein neues Thema.
Create Content		New Snippet		Erzeugt ein neues Snippet.
Design		Contents Design > Design	Strg+D	Aktiviert den Inhalts-Designer.
Design	>	TOC Lock		Sperrt die Hierarchieinformation.
Design	>	Full Lock		Sperrt die Hierarchieinformation und die Kontrollkästchen für die einzelnen Zustände.
Design	>	Contents Design >Apply Status Globally		Wendet Zustandsänderungen so wie den Exportstatus auf alle Konfigurationen an.
		Get TOC from Topic		Entnimmt die Inhaltsverzeichnisinformation, die als Liste im ausgewählten Thema gespeichert ist.
Design		Contents Design > Move Left	Umschalt+Strg+Linker Pfeil	Verschiebt die ausgewählten Themen eine Ebene in der Hierarchie nach oben.
Design		Contents Design > Move Right	Umschalt+Strg+Rechter Pfeil	Verschiebt die ausgewählten Themen eine Ebene in der Hierarchie nach unten.
Design		Contents Design > Move Up	Umschalt+Strg+Aufwärts Pfeil	Verschiebt die ausgewählten Themen einen Platz in der Reihenfolge nach vorne.
Design		Contents Design > Move Down	Umschalt+Strg+Abwärts Pfeil	Verschiebt die ausgewählten Themen einen Platz in der Reihenfolge nach hinten.
Design	>	Contents Design > Sort by Title Ascending		Sortiert die Unterthemen des ausgewählten Themas absteigend nach den Titeln.
Design	>	Contents Design > Sort by Title Descending		Sortiert die Unterthemen des ausgewählten Themas absteigend nach den Titeln.
Design		Contents Design > Custom Sort		Ermöglicht eine benutzerdefinierte Sortierung der Themen.
Export		Modify > Select Next Export State	Strg+E	Ändert den Exportstatus des Themas in den nächsten Wert. Die Veränderung wird durch eine geänderte Anzeige der Kontrollmarkierung angezeigt.
Export		Modify > Set Export State to Predefined		Setzt den Exportstatus aller ausgewählten Themen entsprechend der Einstellungen in den Settings.
Export		Modify > Set Export State to Exported		Setzt den Exportstatus aller ausgewählten Themen auf exportieren.
Export		Modify > Set Export State to Not Exported		Setzt den Exportstatus aller ausgewählten Themen auf nicht exportieren.
Table of Contents		Modify > Show in Table of Contents	Strg+T	Ändert das Aufscheinen des Themas im Inhaltsverzeichnis. Die Veränderung wird durch eine geänderte Anzeige der Kontrollmarkierung angezeigt.
Table of Contents		Modify > Folder Only		Ändert die Eigenschaft Ordner. Wenn ein Thema eine Gruppierungsebene oder Ordner ist, dann scheint es nur im Inhaltsverzeichnis der Hilfesysteme und als Überschrift im PDF-Dokument auf.
Table of Contents		Join Sub-Topics		Zeigt an, dass die Unterthemen auf der Seite des aktuellen Themas zusammengefügt werden. Diese Funktion ist nur in HTML basierten Hilfesystemen verfügbar. Aktivieren Sie das Kontrollkästchen Join Sub-Topics um alle Unterthemen des Themas auf der Seite dieses Themas anzuzeigen.
Folders		Folders > Folders in Modules		Gruppiert Symbole in Modulen in Ordner.
Folders		Folders > Folders in Namespaces		Gruppiert Symbole in Namespaces in Ordner.
Folders	>	Folders > No Member Folders		Gruppiert Members von Klassen als Unterthemen der Klassen.
Folders	>	Folders > Member Type Folders		Gruppiert Members von Klassen in Ordner wie zum Beispiel Methoden.
Folders	>	Folders > Extended Member Type Folders		Gruppiert Methoden in Unterordner wie zum Beispiel Konstruktoren und Destruktoren.
Folders	>	Folders > Member Visibility Folders		Gruppiert die Members von Klassen entsprechend Ihrer Sichtbarkeit in Ordnern.
Folders	>	Folders > Overloaded Function Folders		Fügt Ordner für überladene Funktionen hinzu.
Folders	>	Folders > Member Overview Topics		Fügt Memberüberblicke nach den Klassenthemen hinzu.
Folders		Folders > More Options		Öffnet den Dialog Advanced Symbol Hierarchy Options. In diesem Dialog können Sie Symbole sortieren und Konstruktoren und Destruktoren auf die oberste Ebene in den Klasenverzeichnissen verschieben.
		Columns > In TOC		Zeigt an, ob das Thema im Inhaltsverzeichnis aufscheint oder nicht. Wenn das Kontrollkästchen aktiviert ist, scheint das Thema im Inhaltsverzeichnis auf.
		Columns > Folder		Zeigt an, ob das Thema eine Ordner ist. Wenn das Kontrollkästchen aktiviert ist, wird das Thema nur als Eintrag im Inhaltsverzeichnis wiedergegeben.
		Columns > Topic ID		Zeigt die Themen-ID des Themas an.
		Columns > Filename		Zeigt den Namen der Datei an, in dem das Thema gespeichert ist.
		Columns > Path		Zeigt den Pfad zur Datei an, in der das Thema gespeichert ist.
		Columns > Alias, Combine, Copy		Zeigt an, dass das Thema den Inhalt eines anderen Themas verwendet. (Nur wenn die Eigenschaft oder der Tag combine und alias verwendet wurde, nicht wenn die Eigenschaft oder der Tag combinewith und aliasof verwendet wurde).
		Columns > Join Sub-Topics		Zeigt an, ob die Unterthemen des Themas zu einer Seite zusammengefügt werden. Dieses Feature ist nur für die HTML-Hilfesysteme verfügbar. Wenn das Kontrollkästchen aktiviert ist, werden alle Unterthemen auf der Seite des Themas dargestellt.
		Columns > Show All		Zeigt alle Spalten im Contents Manager an.
		Columns > Hide All		Zeigt keine Spalten im Contents Manager.
		Columns > Reset		Zeigt wieder die Standardeinstellung der Spaltenanzeige an.

Export und Dokumentationsstati

Jedes Topic kann sich in einem der folgenden Exportstati befinden:

Grafik	Bedeutung
	Exportiert
	Nicht exportiert
	Exportiert, gemäß der Standardeinstellung
	Nicht exportiert, gemäß der Standardeinstellung
	Nicht exportiert, da das Gruppenthema nicht exportiert wird.

Jedes Symbol kann in einem der folgenden Dokumentationsstati sein:

Grafik	Bedeutung
	Dokumentiert
	Symbol wird die Dokumentation eines Mitgliedes der Überklasse zugewiesen.
	Symbol ist undokumentiert.
	Symbol ist das Alias/Kombinierte Thema eines anderen Themas.
	Symbole oder Themen sind unbeendet.

Siehe auch

Ändern der Hierarchie, Erzeugen von Symbolüberblicksseiten, Themen, Verschieben und Gruppieren von Themen, Exportieren von Themen, Inhaltsverzeichnis, Wiederverwenden von Themeninhalten

Verwandte Einstellungen

Behandlung von Namespaces