Getting Started with the Editor

In the editor, you edit documents paragraph by paragraph. Paragraph-based editing offers the following advantages.

Paragraph-based editing consists of the following tasks.

Editor Sidebar Menu

The editor provides various menus and features to help you edit documents.

1Find and Replace

2Terminology Check
Checks for prohibited terms, discouraged terms, and other terms set in <Tool | Terminology Rule>.

3AI 글쓰기
Appears only when AI is configured.

4Document Explorer

5Table of Contents
Shows the table of contents of the chapter and separate lists of its figures, tables, code, and proofreading paragraphs.

6View Documents
As shown in the figure above, you can view the content of another chapter in the editor side panel.

7Setting
Lets you set frequently used editor options, such as the default paragraph type, in one place.

8Chapter Revisions

9Translate
Appears only to users with the Translator role.

10Help

Adding Paragraphs

Click a paragraph icon or drag it to the editor(drag and drop) to add a text, image, table, or object paragraph where you want it. Press the Esc key while dragging to cancel.

Paragraph icons and toolbar

Paragraph icons and toolbar

You can also add paragraphs with keyboard shortcuts1. If a paragraph is selected, the new paragraph is added below it. Otherwise, it is added at the bottom.

Keyboard shortcuts for adding paragraphs

Paragraph Type

Shortcut

Text

Ctrl + 1, Ctrl + I

Image

Ctrl + 2

Table

Ctrl + 3

Object

Ctrl + 4

If you also press the Alt key while a paragraph is selected, the new paragraph is added above the selected paragraph. If no paragraph is selected, it is added at the top. For example, if you press Ctrl + Alt + 1 with no paragraph selected, a text paragraph is added at the top.

Selecting Paragraphs

Most tasks in the editor start with selecting a paragraph. When you select a paragraph, a box appears around it with icons for the tasks you can perform, as shown in the following figure.

Select paragraphs in the following ways.

Selecting Nonadjacent Paragraphs at Once

When you need to delete several nonadjacent paragraphs or give them the same indentation, select them all at once with the Ctrl key and edit them together.

Select the first paragraph, and then hold down the Ctrl key while you click other nonadjacent paragraphs.

You can apply the following tasks to the selected paragraphs at once.

Moving Paragraphs

Move paragraphs as follows.

  1. Select the paragraph to move.

    • You can select multiple consecutive paragraphs and move them together. Multiple paragraphs are moved in their original order.

    • If you selected nonadjacent paragraphs, or if you drag a paragraph that is not selected, only the dragged paragraph is moved.

  2. Click the <drag_indicator> icon at the upper left of the selected paragraph, and drag the paragraph to where you want it.

    When you move the pointer over the <drag_indicator> icon, the move pointer (drag_pan) appears.

    • Press the Esc key while moving to cancel the move.

To move paragraphs to another chapter, use Copying and Pasting Paragraphs.

Moving Sections

You can move an entire section(the heading and the paragraphs under it) at once.

  1. Select the heading paragraph.

  2. Click the collapse (keyboard_arrow_down) button to the left of the heading paragraph.

    • You can also press the Left(←) key to collapse the section.

  3. Click the <drag_indicator> icon at the upper left of the selected paragraph, and drag the paragraph to where you want it.

  4. When asked “Do you want to move the entire section, including the paragraphs under the heading?”, click the button.

Editing Paragraphs

Switch the selected paragraph to edit mode in one of the following ways.

Paragraph edit mode

Paragraph edit mode

1Click the button or press Ctrl + S to save the content.

2Click the <Cancel> link or press the Esc key to return to normal mode without saving.

While a paragraph is in edit mode, you cannot edit other paragraphs.

To edit multiple consecutive text paragraphs together, select them and edit them as follows.

  1. Select multiple paragraphs, for example with the Shift key.

  2. Switch to edit mode.

  3. Save the content.

You cannot combine Heading 1 to Heading 5, step, note, tip, caution, or proofreading paragraphs for editing. You also cannot edit paragraphs together when you select nonadjacent paragraphs with the Ctrl key.

Undo and Redo

You can undo any task or redo a task you have undone.

After you close the editor or refresh the web browser, you can no longer undo or redo earlier tasks. In that case, use the revision history feature to restore the content.

Deleting Paragraphs

Delete paragraphs as follows.

  1. Select the paragraph to delete.

    • You can select multiple paragraphs and delete them at once.

  2. Click the <Deletedelete> icon.

    • You can also press the Delete key.

Copying and Pasting Paragraphs

Copy paragraphs as follows.

  1. Select the paragraph to copy.

    • You can select multiple paragraphs and copy them at once.

  2. Click the <1Copycontent_copy> icon.

    • You can also press Ctrl + C to copy paragraphs.

  3. A copy mark appears at the upper right of the copied paragraph.

Paste the copied paragraphs as follows.

  1. Choose where to paste. Paragraphs are pasted below the selected paragraph, so select the paragraph just above the place where you want to paste.

  2. Click the <2Pastecontent_paste> icon to paste the copied paragraphs.

    • You can also press Ctrl + V to paste paragraphs.

Setting Paragraph Options

You can set several options, depending on the paragraph type. The main options are as follows.

Paragraph options

Option

Description

Applies To

Exclude Element

Hides the paragraph on the web or in PDF. If you select “RAG”, the paragraph is excluded from the material that the AI chatbot references.

All paragraphs. You can select multiple paragraphs and set this option at once.

Section View

Sets how the section of a “Heading 1” paragraph is displayed.

“Heading 1” paragraphs

Exclude from numbering.

Hides the number of a “Heading 1” paragraph in the web viewer.

“Heading 1” paragraphs

Trim Parent Prefix

In the web viewer table of contents, if the subheadings start with the same text as this heading, that common text is removed from them.

“Heading 1” to “Heading 4” paragraphs

Renumbered

Starts the numbering of an ordered list at 1, regardless of any preceding ordered list.

Ordered list paragraphs, step paragraphs

Layout

Sets how a definition list appears in the web viewer.

Definition list paragraphs

Ignore step indent.

Paragraphs below a step paragraph are indented. Select this option when you do not want them indented.

All paragraphs except heading, step, proofreading, and object paragraphs

Figure Float

Places text paragraphs beside an image paragraph.

Image paragraphs

Prevent Image Resizing in PDF

Keeps the image from being scaled down, regardless of page breaks.

Image paragraphs

Alternative Text

Enter alternative text that describes the image.

Image paragraphs

Table Layout

Sets the column widths of a table. For details, see Setting Column Widths.

Table paragraphs

Language

Selects the language for code highlighting.

Code paragraphs, table paragraphs(table code cells)

Show Line Numbers

Shows code line numbers. Use “Start Number” to set the number of the first line.

Code paragraphs

Alias

For details, see Setting Aliases for Chapters and Paragraphs.

All paragraph types

Set options as follows.

  1. Select the paragraph whose options you want to set.

  2. Click the <1Optionscheck_box> icon in the paragraph editor.

  3. Set the options you want under “Options”.

  1. Click the button.

Adding Labels to Paragraphs

You can add labels not only to documents and chapters but also to paragraphs. Add labels to a paragraph as follows.

  1. Select the paragraph to label.

  2. Click the <1Labellabel> icon in the paragraph editor.

  1. Select the labels to add to the paragraph.

  2. 2Click a label added to the paragraph to enter a title or short description to show in the web viewer.

    • If you do not enter a description for the web viewer, labeled items are shown by their title for heading paragraphs(including image, table, and code paragraphs) and by their 3paragraph ID for all other paragraphs.

Managing Labels

Other Paragraph Options

Click <1more_horiz> to show additional paragraph options.

Copying the Paragraph ID

Copies the paragraph ID.

AI Spell Check

Checks or corrects spelling through the OpenAI integration.

For details, see Integrating OpenAI with the Editor.

Opening the Web Viewer

Opens the web viewer and moves to the paragraph.

Copying the Content of Code and Command Paragraphs

Copies the content of a code paragraph or command paragraph.

Adding a Title to a Code Paragraph

Adds or changes the title of a code paragraph.

Uploading an Image for Print

Favorites, Renaming, and Opening Other Chapters

1Adds the chapter to your favorites.

2Changes the chapter title in the editor.

3Click the book title to open a pop-up window where you can move to another chapter.

Paragraph View Options

1Click the icon to expand the options menu.

2Copies the chapter ID.

3Hides all marks for applied character styles.

4Shows only the heading paragraphs of all sections and hides their content.

5Filters paragraphs by paragraph type.
Only the paragraph types used in the current chapter are shown.

Exporting Files from the Editor

In the editor, you can export a chapter as a PDF file or a Word file.

This feature creates files. It differs from Export and Import, which moves documents and styles to another ManualWorks server.

Select the <PDF> or <MS Word> tab, and then set the style. For PDF, select a PDF theme and a PDF page layout. Click the button to create the file for the chapter.


  1. This chapter describes keyboard shortcuts for Windows. Some shortcuts may differ on Linux and macOS. For details, see Editing with Keyboard Shortcuts.