About This Guide
This User Guide explains how to use ManualWorks in detail, organized into parts. You can go directly to the part you need.
To learn how to install ManualWorks, see the ManualWorks 6.0 Installation Guide. To learn how to administer ManualWorks, see the ManualWorks 6.0 Administration Guide.
The screenshots in this guide still show the Korean user interface. English screenshots will be added in a future update. Menu and button names in the text follow the English user interface.
This guide is organized as follows.
Logging In: Explains how to stay logged in and recover your password.
Menus: Explains the user menus of ManualWorks.
Logo: Explains the position and size of the logo and how to set it.
Dashboard: Explains the elements of the dashboard.
My Profile: Explains how to change your profile and password.
Projects: Explains how to manage documents with projects.
Searching All Documents: Explains how to search the content of all documents from the side panel.
Document Explorer: Explains how to use the document explorer in the sidebar.
Organizing a Document: Explains how to create and organize documents and chapters.
Managing Document Progress: Explains how to manage TODOs, feedback, change requests from users, and more.
Approving Progress with the API: Explains how to request approval for progress items and approve or reject them with the API.
Document Access Permissions: Explains the roles and allowed tasks for each document permission (owner, collaborator, and reader).
Importing MS Word Files: Explains how to import MS Word files.
Publishing Documents: Explains how to save the content of a document at a point in time with a tag and publish it.
Branches and Pull Requests: Explains how to edit a chapter in a branch, review it with a pull request, and merge it into the original chapter.
Getting Started with the Editor: Explains how to write content by editing paragraph by paragraph.
Text Paragraphs: Explains how to write text paragraphs.
Writing Text Paragraphs: Explains how to write the content of text paragraphs.
Image Paragraphs: Explains how to write image paragraphs.
Table Paragraphs: Explains how to write table paragraphs.
Object Paragraphs: Explains how to write object paragraphs.
Editor Settings: Explains how to set your own editor options and milestones.
Editing with Keyboard Shortcuts: Explains keyboard shortcuts that let you write quickly with minimal mouse use.
Reusing Content: Explains how to reuse content by referencing chapters or including other paragraphs.
Visual Editor: Explains how to use the Visual Editor.
Creating Design Pages: Explains how to create design pages, such as copyright or dedication pages.
Creating an Index: Explains how to create an index.
Comparing Revisions: Explains how to manage and compare the change history.
Find and Replace: Explains how to find a search term in a chapter or the whole document and replace it with another.
JavaScript Modules: Explains how to insert JavaScript modules with object paragraphs.
Themes: Explains how to set fonts, spacing, borders, backgrounds, and other formatting.
Dark Web Themes: Explains how to create a dark web theme that supports dark mode.
Numbering: Explains how to set numbering for headings.
User Style Types: Explains how to create new paragraph and character types.
Code Highlighting Styles: Explains how to set highlighting for code paragraphs.
Web Viewer Basics: Explains the web viewer, which provides your documents on the web.
Web Viewer for Selected Chapters, Sections, and Paragraphs: Explains how to create web viewer links that show only selected chapters, sections, or paragraphs.
Web Viewer Layouts: Explains how to design web viewer layouts.
Libraries: Explains how to create libraries.
Comments: Explains how to add comments to the web viewer.
Banners: Explains how to add banners.
Additional Web Viewer Features: Explains additional web viewer features, such as sending change requests, the pen tool, paragraph tools, and newsletter subscriptions.
Using Google Analytics: Explains how to monitor the web viewer with Google Analytics.
Video (Audio) Documents: Explains how to create video documents that deliver information through video or audio clips.
Static Documents: Explains how to create static documents that bundle HTML, CSS, PDF, and other files and serve them on the web.
Blogs: Explains how to create blog documents and posts.
Mandalart Documents: Explains how to create documents with the Mandalart thinking technique.
Creating Files: Explains how to export to PDF, EPUB, MS Word, and other formats.
Creating EPUB Files: Explains how to create EPUB files.
Creating HTML Files: Explains how to create HTML files.
Creating MS Word Files: Explains how to create MS Word files.
Deleting Exported Files: Explains how to delete created PDF, EPUB, HTML, and MS Word files.
Applying DRM: Explains how to apply your own DRM class when you create PDF and other files.
Creating PDF Files: Explains how to create PDF files.
PDF Page Layouts: Explains how to design PDF page layouts.
PDF Fonts: Explains how to manage the fonts embedded in PDF files.
PDF Hyphenation: Explains how to hyphenate words when text is justified.
Optimizing PDF Creation for CJK Documents: Explains how to optimize PDF creation for Chinese, Japanese, and Korean documents.
Templates: Explains how to create templates and use them in the editor.
Files: Explains how to manage files.
Images: Explains how to manage images.
Inline Images: Explains how to manage small images placed inside paragraphs.
Labels: Explains how to manage labels.
Managing Resource Directories: Explains how to create resource directories and manage their access permissions.
Glossaries: Explains how to create glossaries and insert them into documents.
Abbreviation Lists: Explains how to create abbreviation lists and insert them into documents.
Search Keywords: Explains how to set search keywords.
Related Documents: Explains how to set related documents.
Phrases: Explains how to set phrases.
Feedback Statistics: Explains how to view feedback statistics and delete the data.
Visit Statistics: Explains how to view web viewer visits and file downloads.
Search Statistics: Explains how to view the search history.
Document Statistics: Explains how to view various information about documents.
Reference Statistics: Explains how to view how documents are referenced.
Document Revision Statistics: Explains how to view the writing, editing, and visit history of each document by year.
Revision Statistics: Explains how to view the edit history.
File Creation Statistics: Explains how to view and delete the history of created PDF, EPUB, HTML, and MS Word files.
Export and Import: Explains how to export and import documents and styles.
Web Pages: Explains how to create web pages.
Outlines: Explains how to create outlines and convert them into documents.
Sending Notifications: Explains how to send notifications.
External Systems: Explains how to integrate with external APIs.
Campaigns: Explains how to turn chapter content into an email and schedule it for specific recipients.
Comparing Text: Explains how to compare the content of two chapters.
Structure of a Book: Explains the structure of a book, which is organized by chapter.
Web Browsers: Explains the supported web browsers and issues that can occur in each browser.
Keyboard Shortcuts: Lists all keyboard shortcuts.
Spell Checking: Explains how to use an external spell checker.
Integrating OpenAI with the Editor: Explains how to integrate OpenAI with the editor and use the AI assistant.
Conventions
This guide uses the following formatting conventions.
Item | Description | Example |
|---|---|---|
Emphasis | Words and sentences that need emphasis are shown in bold. | Emphasis |
Menus and links | Menus, links, and similar items are enclosed in < and >. | <Delete> |
Keyboard shortcuts | Keys that you press at the same time are joined with + and shown in a monospace font. | Ctrl + I |
Code and file names | Code, commands, file names, and similar items are shown in a monospace font. |
|
This guide provides notes, tips, and cautions as follows.
A note provides a short explanation, reference, or comment that supplements the text.
A tip provides helpful hints.
A caution calls your attention to something important.
Reporting Errors and Questions
If you find a technical error or a typo, or if there is anything you would like us to correct or add, please email us at support@3rabbitz.com.
In the web viewer, when you select text with the mouse, the <Send Change Request> button appears. You can also click this button to send a change request.