Topic Editor

Use the Topic Editor to write comments for your source code symbols and documentation text that is not related to source code symbols. In addition, you can add comments to a documented symbol in another location. If you store comments for a symbol in multiple location there are several tabs for your comments. Tabs appear on top of the Topic Editor beneath the toolbar.

Doc-O-Matic stores comments you edit in the Topic Editor in the same location where they were read from. If you create a New Topic or select New Topic Location on the shortcut menu you can choose where you want to store your comments.

The main parts of the editor are:

Editor tab
Topic Properties inspector
Editor shortcut menu

Notes

You must update your source files before you edit them in the Editor. You can turn on the Monitor Project Files options, to issue a warning, when files are changed outside Doc-O-Matic. If you are using the Autosave feature the following problem might occur: If you did not update your source files before adding text to a topic, Doc-O-Matic is not able to proceed. You need to click Undo All , so that Doc-O-Matic can proceed. To avoid loosing your changes copy them to the clipboard.

Editor Commands

The following table describes toolbar buttons, shortcut menu commands, and shortcuts:

Group	Icon	Command	Shortcut	Description
		Spelling Suggestions		Displays suggestions for misspelled words when you right-click an underlined word.
		Add Word to Dictionary		Adds the underlined word to your spelling dictionary.
Clipboard		Edit > Cut	CTRL+X, SHIFT+DEL	Cuts the current selection to the clipboard.
Clipboard		Edit > Copy	CTRL+C	Copies the current selection to the clipboard.
Clipboard		Edit > Paste	CTRL+V, SHIFT+INS	Pastes the content of the clipboard to the current cursor position.
Topic		Edit > Save	CTRL+S	Saves any modifications.
Topic		Edit > Save As	SHIFT+ CTRL+S	Opens the save topic dialog.
Topic		QuickDoc Settings		Changes QuickDoc Settings.
Topic		Edit > Undo	CTRL+Z	Undoes the last operation.
Topic		Edit > Undo All		Cancels everything written using the Editor since you last saved.
Topic		Edit > Redo	SHIFT+CTRL+Z	Undoes the last undo.
Topic		Edit > Find	CTRL+F	Find words in the topic text.
Topic		Edit > Find Again	F3	Find previously searched words again.
Topic		Edit > Spell Check	F7	Checks the spelling in the content of the Editor and Topic Properties starting at the current cursor position.
Topic		Edit > Spell Check Project		Checks the spelling in the whole project starting at the current cursor position.
Topic		Edit > Live Spelling		Checks the spelling in your text while you are typing.
Topic		Options > Spell Checker Options		Sets spelling checker options.
Topic		Options > Readonly		Makes topic text read only.
Topic		Topic Properties	SHIFT+CTRL+P	Shows or hides Topic Properties.
Topic	>	Edit >Whitespace		Shows or hides nonprinting characters.
Topic		Change Topic ID		Changes the topic ID of the current topic.
Topic		Assign to Symbol		Assigns a off-source topic to a symbol.
Topic	>	Delete Topic		Deletes the current topic.
Topic		New Topic Location		Lets you add comments to a documented symbol in another location.
Topic		Options> Configure Shortcuts		Opens the Shortcuts dialog where you can change the default shortcuts.
Topic		Options > Editor Options		Opens the Editor Options Application Options page where you can set options such as Editor fonts and autosave.
Character		Format > Bold	CTRL+B	Makes the selected text bold.
Character		Format > Italic	CTRL+I	Makes the selected text italic.
Character		Format > Underline	CTRL+U	Underlines the selected text.
Character		Format > Code		Formats the selected text mono-spaced as code.
Character		Format > Color	CTRL+O	Sets the color for the selected text. You can choose form a list of named colors available in the project.
Character		Format > Color > Add Color		Opens the dialog Color.
Character		Format > Label Selection	SHIFT+CTRL+<SPACE>	Opens the label list. Lets you select a label in the list that labels the selected text.
Character	>	Format > Label Selection > Add Label		Opens the Edit Label dialog.
Character	>	Format > Label Selection > Remove Label		Removes the label from the selected text.
Character		Format > Subscript		Formats parts of the text in subscript.
Character		Format > Superscript		Formats parts of the text in superscript.
Paragraph		Format > Numbering	SHIFT+CTRL+N	Inserts a ordered list at the current cursor position.
Paragraph		Format > Bullets	SHIFT+CTRL+B	Inserts a bullet list at the current cursor position.
Paragraph		Format > Set List Number		Sets a list number for the list item.
Paragraph		Format > Increase List Indent		Increases the list indent for the selected list item.
Paragraph		Format > Decreases List Indent		Decreases the list indent for the selected list item.
Paragraph		Align > Left		Aligns the selected paragraph on the left.
Paragraph		Align > Center		Centers the selected paragraph
Paragraph		Align > Right		Aligns the selected paragraph on the right.
Paragraph		Align > Justify		Justifies the selected paragraph.
Paragraph		Paragraph Format > Text		Formats the selected paragraph as text.
Paragraph		Paragraph Format > Heading		Formats the selected paragraph as heading.
Paragraph		Paragraph Format > Preformat		Formats the selected paragraph as preformat.
Paragraph		Paragraph Format > Code		Formats the selected paragraph as code. Optionally you can select a source language in the language list to syntax highlight this code paragraph according to this language.
Insert		Insert > Link	SHIFT+CTRL+ L	Inserts a link at the current cursor position.
Insert		Follow Link		Opens the topic in your project that the selected link links to.
Insert		Edit > Convert to Text		Converts a selected link to text.
Insert		Insert > Image	SHIFT+CTRL+ I	Inserts an image at the current cursor position.
Insert		Edit > Edit Image		Opens an external image editor.
Insert		Insert > Table	SHIFT+CTRL+T	Inserts a table at the current cursor position.
Insert		Table > Table Properties		Lets you choose the alignment (left, center, right) for the columns of your table. Choose if your table and cells have borders and if the table has a header row.
Insert	>	Table > Insert Row	SHIFT+CTRL+R	Inserts a new row into the selected table below the current row.
Insert	>	Table > Insert Column	SHIFT+CTRL+C	Inserts a new cell into the selected table to the left of the current cell.
Insert	>	Table > Delete Row	CTRL+ALT+R	Deletes the current row of the selected table.
Insert	>	Table > Delete Column	CTRL+ALT+C	Deletes the current column of the selected table.
Insert	>	Table > Delete Table	CTRL+ALT+D	Deletes the entire table.
Insert		Insert > Variable	CTRL+<SPACE>	Opens the variable menu. Lets you select a variable that is inserted at the current cursor position.
Insert		Insert > Variable > Add Variable	SHIFT+CTRL+V	Opens the Edit Variable dialog.
Insert		Insert > Snippet	CTRL+ALT+<SPACE>	Opens the snippet menu. Lets you select a snippet a placeholder for which is inserted at the current cursor position.
Insert		Insert > Topic ID	SHIFT+CTRL+D	Inserts a topic ID at the current cursor position.
Insert		Insert > HTML Code		Emits HTML code into your HTML output.
Insert		Insert > Text Include		Inserts a file name with complete path at the cursor position. The text of the included file is shown in the Topic Preview after saving.
Sections		Append Section		Opens a list showing all available sections. If you select a section the section is inserted at the end of the topic.
Sections		Insert Section		Opens a list showing all available sections. If you select a section the section is inserted at the current paragraph.
Sections		Tools > Select Section		Selects the current section the cursor is located in.
Sections		Tools > Delete Section Heading		Deletes the current section heading the cursor is located in.
Sections		Tools > Delete Section		Deletes the current section the cursor is located in.
Sections		Tools > Select Topic	CTRL+A	Selects the entire topic text.
Sections		Tools > Empty Topic		Empties the topic content.
		Properties	-	Lets you edit links or images if you point to links or images.