Mit dem Editor können Sie die Dokumentation für Ihren Sourcecode und Dokumentationstext, der keinem bestimmten Symbol zugeordnet ist schreiben. Darüber hinaus können Sie Kommentare für dokumentierte Symbole an einer anderen Stelle hinzufügen. Wenn Sie die Kommentare an verschiedenen Stellen speichern, werden die Kommentare in verschiedenen Registern im Editor angezeigt. Die Register werden im Editor unter der Symbolleiste angezeigt.
Doc-O-Matic speichert den eingegeben Text an der Stelle von der er eingelesen wurde. Wenn Sie ein neues Thema erzeugen oder wenn Sie New Topic Location im kontextbezogenen Menü auswählen, können Sie sich aussuchen, wo Sie die Kommentare speichern möchten.
Bevor Sie Ihre Sourcedateien im Editor bearbeiten, müssen Sie Ihr Projekt von Doc-O-Matic analysieren lassen. Sie können die Option Monitor Project Files einschalten, damit Sie gewarnt werden, wenn Sie eine Datei außerhalb von Doc-O-Matic bearbeitet haben. Wenn Sie die Funktion Autosave verwenden kann es zu folgendem Problem kommen. Wenn Doc-O-Matic Ihr Projekt nicht analysiert hat bevor Sie Änderungen im Editor eingegeben haben, ist Doc-O-Matic nicht in der Lage fortzufahren. Sie müssen in diesem Fall Undo All klicken, damit Doc-O-Matic fortfahren kann. Wenn Sie die eingegebenen Änderungen nicht verlieren möchten, kopieren Sie diese in die Zwischenablage.
Die Tabelle unterhalb erklärt die Grafiken der Symbolleiste, die Befehle und die Menüpunkte des kontextbezogenen Menüs, die zur Verfügung stehen:
Gruppe |
Grafik |
Befehl |
Tastaturbefehle |
Beschreibung |
|
|
Spelling Suggestions |
|
Wenn Sie ein rot unterlegtes Wort anklicken, werden die korrigierten Vorschläge aus Ihrem Wörterbuch angezeigt. |
|
|
Add Word to Dictionary |
|
Fügt das rot unterlegte Wort zu Ihrem Rechtschreibwörterbuch hinzu. |
Clipboard |
|
Edit > Cut |
Strg+X, Umschalt+Entf |
Kopiert den markierten Text in die Zwischenablage und entfernt ihn. |
Clipboard |
|
Edit > Copy |
Strg+C |
Kopiert den markierten Text in die Zwischenablage. |
Clipboard |
|
Edit > Paste |
Strg+V, Umschalt+Einfg |
Fügt den Inhalt der Zwischenablage an der Stelle, wo sich der Cursor befindet, ein. |
Topic |
|
Edit > Save |
Strg+S |
Speicher jede Änderung |
Topic |
|
Edit > Save As |
Umschalt+ Strg+S |
Öffnet das Dialogfeld Save Topic. |
Topic |
|
QuickDoc Settings |
|
Öffnet den QuickDoc-Manager. |
Topic |
|
Edit > Undo |
Strg+Z |
Macht die letzte Aktion rückgängig. |
Topic |
|
Edit > Redo |
Umschalt+Strg+Z |
Macht die letzte rückgängig gemachte Aktion rückgängig. |
Topic |
|
Edit > Undo All |
|
Entfernt alle Änderungen im Editor, die seit dem letzten Mal speichern im Thema vorgenommen wurden. |
Topic |
|
Edit > Find |
Strg+F |
Ermöglicht die Suche von Wörtern im Text des Themas. |
Topic |
|
Edit > Find Again |
F3 |
Sucht das soeben gesuchte Wort noch einmal. |
Topic |
|
Edit > Live Spelling |
|
Aktiviert die aktuelle Rechtschreibüberprüfung. |
Topic |
|
Edit > Spell Check |
F7 |
Beginnt die Rechtschreibüberprüfung des Inhaltes des Editors und der Topic Properties an der Stelle, an der sich der Cursor befindet. |
Topic |
|
Edit > Spell Check Project |
|
Beginnt die Rechtschreibüberprüfung für das gesamte Projekt an der Stelle, an der sich der Cursor befindet. |
Topic |
|
Options > Spell Checker Options |
|
Ermöglicht es die Einstellungen für die Rechtschreibüberprüfung zu ändern. |
Topic |
|
Options > Readonly |
|
Aktiviert die Option Readonly. Der Text im Editor kann nicht mehr bearbeitet werden. |
Topic |
|
Topic Properties |
Umschalt+Strg+P |
Blendet die Topic Properties aus oder ein. |
Topic |
> |
Edit >Whitespace |
|
Zeigt die Steuerzeichen an oder blendet sie aus. |
Topic |
|
Change Topic ID |
|
Ermöglicht die Änderung der aktuellen Themen-ID. |
Topic |
|
Assign to Symbol |
|
Assoziiert Themen, die nicht im Sourcecode gespeichert sind, mit dem entsprechenden Symbol. |
Topic |
> |
Delete Topic |
|
Löscht das aktuelle Thema. |
Topic |
|
New Topic Location |
|
Ermöglicht es Ihnen einen Kommentar zu einem dokumentierten Symbol an einer anderen Stelle hinzuzufügen. |
Topic |
|
Options> Configure Shortcuts |
|
Öffnet das Dialogfeld Shortcuts, in dem Sie die Tastaturbefehle ändern können. |
Topic |
|
Options > Editor Options |
|
Öffnet die Programmeinstellungen für den Editor, in denen Sie Einstellungen wie Schriftarten umstellen und automatisch speichern einstellen können. |
Character |
|
Format > Bold |
Strg+B |
Formatiert den markierten Text fett oder entfernt diese Formatierung. |
Character |
|
Format > Italic |
Strg+I |
Formatiert den markierten Text kursiv oder entfernt die Formatierung. |
Character |
|
Format > Underline |
Strg+U |
Unterstreicht den markierten Text oder entfernt die Unterstreichung. |
Character |
|
Format > Color |
Strg+O |
Bestimmt die Farbe für den markierten Text. Sie können aus einer Liste von Farben mit Namen, die im Projekt verfügbar sind wählen. |
Character |
|
Format > Color > Add Color |
|
Öffnet den Dialog Color. |
Character |
|
Format > Code |
|
Formatiert den markierten Text in Code. |
Character |
|
Format > Label Selection |
Umschalt+Strg+<Leerzeichen> |
Zeigt die Liste mit verfügbaren Labels an. Indem Sie eine Markierung auswählen, wird der Text markiert. |
Character |
> |
Format > Label Selection > Add Label |
|
Öffnet das Dialogfeld Edit Label. |
Character |
> |
Format > Label Selection > Remove Label |
|
Entfernt den Label von dem ausgewählten Text. |
Character |
|
Format > Subscript |
|
Stellt den markierten Text tief. |
Character |
|
Format > Superscript |
|
Stellt den markierten Text hoch. |
Character |
|
Format > Numbering |
Umschalt+Strg+N |
Fügt eine nummerierte Liste an der Position des Cursors ein. |
Paragraph |
|
Format > Bullets |
Umschalt+Strg+B |
Fügt Aufzählungszeichen an der Position des Cursors ein. |
Paragraph |
|
Format > Set List Number |
|
Läßt Sie das aktuelle Listenelement nummerieren. |
Paragraph |
|
Format > Increase List Indent |
|
Rückt das ausgewählte Listenelement ein. |
Paragraph |
|
Format > Decreases List Indent |
|
Rückt das ausgewählte Listenelement aus. |
Paragraph |
|
Align > Left |
|
Richtet den ausgewählten Absatz nach links aus. |
Paragraph |
|
Align > Center |
|
Zentriert den ausgewählten Absatz. |
Paragraph |
|
Align > Right |
|
Richtet den ausgewählten Absatz nach rechts aus. |
Paragraph |
|
Align > Justify |
|
Formatiert den ausgewählten Absatz mit Blocksatz. |
Paragraph |
|
Paragraph Format > Text |
|
Formatiert den ausgewählten Absatz als Text. |
Paragraph |
|
Paragraph Format > Heading |
|
Formatiert den ausgewählten Absatz als Überschrift. |
Paragraph |
|
Paragraph Format > Preformat |
|
Formatiert den ausgewählten Absatz als Vorformat. |
Paragraph |
|
Paragraph Format > Code |
|
Formatiert den ausgewählten Absatz als Code. Wahlweise können Sie eine Programmiersprache aus dem Menü auswählen und damit die Sprache bestimmend die zum Hervorheben der Syntax verwendet wird. |
Insert |
|
Insert > Link |
Umschalt+Strg+ L |
Fügt einen Link an der Position des Cursors ein. |
Insert |
|
Follow Link |
|
Öffnet das Thema in Ihrem Projekt zu dem der Hyperlinks erstellt ist. |
Insert |
|
Edit > Convert to Text |
|
Wandelt einen ausgewählten Hyperlink in Text um. |
Insert |
|
Insert > Image |
Umschalt+Strg+ I |
Fügt ein Bild an der Position des Cursors ein. |
Insert |
|
Edit > Edit Image |
|
Öffnet ein externes Bildbearbeitungsprogramm. |
Insert |
|
Insert > Table |
Umschalt+Strg+T |
Fügt eine Tabelle an der Position des Cursors ein. |
Insert |
|
Table > Table Properties |
|
Lässt Sie die Textausrichtung (links, zentriert rechts) der Spalten Ihrer Tabelle bestimmen. Lässt Sie bestimmen, ob die Tabellenzellen einen Rahmen haben und ob die Tabelle eine Titelzeile hat. |
Insert |
> |
Table > Insert Row |
Umschalt+Strg+R |
Fügt eine neue Zeile in die ausgewählte Tabelle unter der aktuellen Zeile ein. |
Insert |
> |
Table > Insert Column |
Umschalt+Strg+C |
Fügt eine neue Spalte links von der aktuellen Spalte in die ausgewählte Tabelle ein. |
Insert |
> |
Table > Delete Row |
Umschalt+Alt+R |
Entfernt die aktuelle Zeile der ausgewählten Tabelle |
Insert |
> |
Table > Delete Column |
Strg+Alt+C |
Entfernt die aktuelle Spalte der ausgewählten Tabelle. |
Insert |
> |
Table > Delete Table |
Strg+Alt+D |
Entfernt die gesamte Tabelle. |
Insert |
|
Insert > Variable |
Strg+<Leerzeichen> |
Öffnet die Liste Variable. Wählen Sie eine Variable aus und diese wird an der Position des Cursors eingefügt |
Insert |
|
Insert > Variable > Add Variable |
Umschalt+Strg+V |
Öffnet das Dialogfeld Edit Variable. |
Insert |
|
Insert > Snippet |
Strg+ALT+<Leerzeichen> |
Öffnet die Liste Snippet. Wählen Sie ein Snippet aus der Liste aus und ein Platzhalter für das Snippet wird an der Position des Cursors eingefügt. |
Insert |
|
Insert > Topic ID |
Umschalt+Strg+D |
Fügt eine Topic ID an der Position des Cursors ein. |
Insert |
|
Insert > HTML Code |
|
Gibt HTML-Code direkt in die HTML-Ausgabe aus. |
Insert |
|
Insert > Text Include |
|
Fügt einen Dateinamen mit dem vollständigen Pfad an der Position des Cursors ein. Der Text der Include-Datei wird nach dem speichern in der Themen-Vorschau angezeigt. |
Sections |
|
Append Section |
|
Öffnet eine Liste mit allen für Ihr Thema verfügbaren Abschnitten. Der ausgewählte Abschnitt wird am Ende des Themas angefügt. |
Sections |
|
Insert Section |
|
Öffnet eine Liste mit allen für Ihr Thema verfügbaren Abschnitten. Der ausgewählte Abschnitt wird im aktuellen Absatz eingefügt. |
Sections |
|
Tools > Select Section |
|
Markiert den Abschnitt in dem sich der Cursor befindet. |
Sections |
|
Tools > Delete Section Heading |
|
Entfernt die Überschrift des Abschnittes, in dem sich der Cursor befindet. |
Sections |
|
Tools > Delete Section |
|
Entfernt den Abschnitt, in dem sich der Cursor befindet. |
Sections |
|
Tools > Select Topic |
Strg+A |
Markiert den gesamten Text des Themas. |
Sections |
|
Tools > Empty Topic |
|
Entfernt den Inhalt des Themas. |
- |
|
Properties |
- |
Ermöglicht es Hyperlinks oder Grafiken zu bearbeiten, wenn der Cursor auf dem Hyperlink oder einer Grafik positioniert ist. |
Editor, Dokumentationsstandard