You can collaborate through structured authoring. Structured authoring proceeds in the following order.

• Create a document first.

• Create chapters in the document.

• Add independent paragraphs to the chapters.

This chapter describes how to create and organize documents and chapters. For how to add independent paragraphs to a chapter, see Getting Started with the Editor.

Creating a Document

Create a document as follows.

Create Book

You can create a book-style document consisting of multiple chapters.

- ManualWorks 6.0 User Guide

Create Article

You can create a short document(article) consisting of a single chapter.

- The Best Choice for Writing Manuals - ManualWorks (in Korean)

Create Static

You can create Static Documents that serve HTML files and other content.

Create Blog

You can create a blog (in Korean).

Create Video

You can create Video (Audio) Documents.

Create Visual

You create pages and write on them. It provides the same features as the Visual Editor for image paragraphs.

Create Mandalart

You can create Mandalart Documents.

The main input fields are described below.

Basics

Style

• Select the Web Themes and Web Viewer Layouts and the Web Viewer Main Type to apply to the web viewer. For details, see Themes and Web Viewer Layouts.

  • You can also set a web viewer layout in a library. If you set a web viewer layout in the library applied to the document, the library's web viewer layout takes precedence over the document's.

• You can also set the web viewer main page and CSS.

Options

Select options by referring to the following descriptions.

Components of Book

If you select “Create Book” in <Create Document>, you can select the chapters that make up the book from a list and create them. For a description of the chapters that make up a book, see Structure of a Book.

Organizing the Table of Contents

Create chapters to organize the table of contents of the document, including the front matter, body, and back matter.

Creating Chapters

Create a chapter as follows.

1. In “Table of Contents” on the document details screen, click the <1Create Chapter> link.

   • To create multiple chapters at once, click the <2Create Chapters> link.

2. Enter the “Basics” such as the title and type, and set the style, options, and so on.

3. Click the Save button.

   • To make changes later, click the <3Update Chapter> link of the chapter.

When you click the <1Create Chapter> link, a screen appears where you enter the basic information, style, and other settings. The main input fields are described below.

Basics

Title

Enter the chapter title.

Type

Select the chapter type, such as Preface, Table of Contents, Chapter, or Appendix.

Subtitle

Enter a subtitle to add to the chapter title.

Authors

Enter the name of the author writing the chapter.

Subject

Enter the subject of the chapter.

Alias

Enter a unique alias. For details, see Setting Aliases for Chapters and Paragraphs.

Position

If you select a chapter, the new chapter is placed after the selected chapter. To change the position later, drag the <drag_indicator> icon in the table of contents.

Style

Section View

You can choose the section view of the chapter from Tab, Accordion, and Opened Accordion.

Theme Color

When the <Web Viewer Main Type> is “Tile” or “Grid”, an icon appears on each part or chapter. You can choose the color of the icon.

Icon

When the <Web Viewer Main Type> is “Tile” or “Grid”, you can choose the icon that appears on the part or chapter.

Exclude

You can selectively exclude the chapter when you create web viewer, PDF, or EPUB output. The chapter does not appear in the outputs you select for Exclude. If you select RAG, the chapter is excluded from the material the chatbot refers to when it answers.

Options

External URL

External URL

If you set an external URL for a chapter, the web viewer shows an open-in-new-window (open_in_new) icon next to the chapter title and goes to the specified address.

Editing Chapter Content

In “Table of Contents” on the document details screen, click the <1Edit Content> link to edit the content of the chapter.

To prevent the chapter content from being edited, select the "Disable Edit" option in <Update Chapter>. When you set this option, the <Edit Content> link disappears and the chapter is marked with a 2lock in "Table of Contents".

Copying Chapters

You can copy a chapter on the document details screen. Click the <1more_horiz> icon in the chapter table of contents, and then select “2Copy” from the context menu.

A chapter whose title has the prefix 'Copy of' is created. Details such as the content, type, and options are copied, but the alias is not.

Copying a Chapter as a Short Document

You can turn a chapter into a short document. When you select “3Copy as Article” from the context menu, the content of the chapter is copied into a new short document, and the details screen of the new short document opens. The user who copied the chapter becomes the owner of the new document.

Importing Chapters from Other Documents

Import chapters from another document as follows.

1. In “Table of Contents” on the document details screen, click the <Import Chapters from Other Document> link.

2. Select the document that contains the chapters to import.

3. Select the chapters to import.

4. Select either “By Copy” or “By Reference”.

5. Click the Save button.

Importing MS Word Files

See Creating Chapters from MS Word Files.

Moving Chapters to Another Document

You can move a chapter of the current document to another document. Note that unlike "Copy", this moves the original.

Move a chapter as follows.

1. Go to the document details screen.

2. In the chapter table of contents, click the <more_horiz> icon of the chapter to move.

3. Select “Move to Another Document” from the context menu.

4. Click the <Choose a document or chapter.> link, and then select the document or chapter to move to.

   • If you select a chapter, the moved chapter goes to the document that contains the selected chapter and is placed after the selected chapter.

   • You cannot select a short document.

   • You can move a chapter only to documents in which you participate as an owner or collaborator.

5. In the “Are you sure you want to move?” message, click the OK button.

If an “alias” set on the chapter to move or on its paragraphs also exists in the “target document”, you cannot move the chapter. Change the alias on one side.

Note the following when you move a chapter.

• You can still view the edit history of the chapter after the move.

• Document tags created before the move are not affected.

• Feedback statistics from both before and after the move are available in the destination document.

• Visit statistics and search statistics are available separately in the source document and the destination document.

Moving Short Documents

You can move a short document into a book as a chapter.

On the document details screen, click the <1Move to Another Document> link, and then select the document to move the short document into as a chapter.

Deleting Chapters

You cannot restore a deleted chapter. When you delete a chapter, the following are also deleted.

• Chapters in other documents that reference the chapter

  • If referencing chapters exist, check the list of referencing chapters on the “Are you sure you want to delete the referenced chapter?” screen, and then delete them.

  • If you do not own one of the documents that contain referencing chapters, you cannot delete the chapter. Ask the owner of that document to delete the referencing chapter first.

• Visit records and feedback for the chapter

• Progress management items for the chapter, such as proofreading and revision requests

Delete a chapter as follows.

1. Go to the document details screen.

2. In the chapter table of contents, click the <more_horiz> icon of the chapter to delete.

3. Select “Delete” from the context menu.

Creating Parts

If you select "Part" for "Type" in <Create Chapter>, the chapter becomes a 1part. You can create parts to group multiple chapters. If you do not divide the document into multiple parts, all chapters are placed under the same part.

In the chapter table of contents, you can hide the chapters under a part, as shown in the 2figure above. Click a part to expand or collapse it.

Placing Chapters at the Same Top Level as Parts

As shown below, you can place a chapter at the same level as parts instead of including it in a part. In the chapter options, select "Same as Part Level".

Renumbering Chapters Under a Part

Unless you set otherwise, chapters are numbered continuously regardless of parts. With the "Renumbered" option, you can restart the 1chapter numbers within a part.

This option is available only for parts. Set it when you first create the part(<Create Chapter>), or change it with the <2Update Chapter> link.

Changing the Order of the Table of Contents

You can change the order of the table of contents by drag and drop.

1. In “Table of Contents” on the document details screen, place the mouse pointer over the <drag_indicator> icon of the chapter to reorder. The move pointer (drag_pan) appears.

2. Click and drag the chapter to the position you want.

   • The change is saved as soon as you move the chapter.

Reordering a Part Together with Its Chapters

When you change the order of a part in “Table of Contents” on the document details screen, you can move all the chapters under the part at once.

When you move a part in "Table of Contents", the message shown in the figure below appears. Click the OK button to move the chapters under the part together, or click the Cancel button to move only the part.

Excluding Chapters

If there is a chapter that you do not want to include in the web viewer or in files such as PDF, exclude the chapter as follows.

1. Go to the document details screen.

2. In the chapter table of contents, click the <Update Chapter> link of the chapter to exclude.

3. In the “1Exclude” option, select the files or web viewer that should not include the chapter.

4. Click the Save button.

Setting Options for Multiple Chapters at Once

In “Table of Contents” on the document details screen, click the <Configure Chapter Option> link to apply the same style and options to multiple chapters at once.

1. Select the style and options, such as Section View and Exclude.

2. In the “Choose a chapter.” panel, select the chapters to apply the settings to.

3. Click the Save button.

Copying Documents

On the document details screen, click the <1Copy> link to copy the document.

A document whose title has the prefix 'Copy of' is created. You can change the title on the copy screen, and you can copy other documents at the same time with the <Add Document> link in the “Other Documents to Copy” panel. You must be the owner of all the documents to copy together; if you do not own even one of them, nothing is copied. All content is copied, but access permissions, publishing, and similar settings are not. The user who copied the document becomes the owner of the new document.

Copying Document Settings

With <Copy Document Configurations> on the document details screen, you can select the types you want among style, options, access permissions, and parameters, and copy them to other documents.

Copy the selected types of settings from the current document to other documents as follows.

1. On the details screen of the source document, click the <Copy Document Configurations> link.

2. In the 1configuration types, select the types to copy.

3. In the “Document” panel, use the <Choose a document.> link to select 2documents, and then click the Save button.

   • You can select multiple documents and copy the settings to all of them at once.

4. Check that the ‘selected types’ were copied to the selected documents.

Deleting Documents

On the document details screen, click the <Delete> link to delete the document.

Note the following when you delete a document.

• You cannot restore a deleted document. If necessary, first export the document with the <Export> link on the delete screen.

• Deleting a document also deletes its chapters.

• If chapters in other documents reference chapters in this document, you cannot delete it. First delete the “Chapters referencing this document” shown on the delete screen.

1. On macOS, press the <RETURN> key.