The web viewer lets you view documents you write directly on the web.

Web Themes and Web Viewer Layouts

The look of the web viewer depends on the web theme and the Web Viewer Layouts you select. To select a web theme and a web viewer layout, follow these steps.

1. Go to the document details page.

2. In “Basics”, click the <Update Book> or <Update Article> link.

3. In Style, select the “Web Theme” and “Web Viewer Layout”.

4. Click the Save button.

Web Viewer Main Type

You can set a different look for the web viewer main page for each document. Set the “Web Viewer Main Type” in the "Style" section of a book or short document.

Setting the Web Viewer Main Type

There are three web viewer main types: “List”, “Tile”, and “Grid”. The web viewer main page looks different depending on the type you select.

To set or change the web viewer main type, follow these steps.

1. Go to the document details page.

2. In “Basics”, click the <Update Book> or <Update Article> link.

3. In Style, set the “1Web Viewer Main Type”.

4. Click the Save button.

Web Viewer Main Types

The “Web Viewer Main Types” are as follows.

Web Viewer Language

The web viewer has labels and messages, such as those for the table of contents and search. By default, they appear in English or Korean, and if the administrator turns on Japanese or Chinese, they can also appear in those languages. The language is determined as follows, depending on whether the user is logged in.

Logged-In Users

The language depends on the user language set in My Profile.

Users Who Are Not Logged In

The language is determined in the following order.

• If the administrator has set a default language, the web viewer appears in that language.

• Otherwise, the web viewer appears in the first supported language according to the language priority set in the web browser.

• If none of the languages is supported, the web viewer appears in English.

Setting Aliases for Chapters and Paragraphs

You can set an alias for chapters and paragraphs. When you set an alias, the URL contains the alias instead of the UUID of the chapter or paragraph.

Without an alias

https://www.3rabbitz.com/book_release_note_ko#26642564a27554e9 (in Korean)

With an alias

https://www.3rabbitz.com/book_release_note_ko#5_0_0 (in Korean)

Note the following when you set an alias.

• You can use only English letters, numbers, underscores(_), and hyphens(-).

• The alias must be unique within the same document.

Setting an Alias for a Chapter

1. Go to the document details page.

2. Click the <Update Chapter> link of the chapter to set an alias for.

3. In “Options”, set the <1Alias>.

4. Click the Save button.

Setting an Alias for a Paragraph

1. Select the paragraph to set an alias for.

2. Click the <Optionscheck_box> icon.

3. In “Style” of the paragraph options, set the 2alias.

4. Click the Save button.

Changing the Web Viewer Logo

Default UI Settings

See Changing the Logo and Favicon in the Administration Guide.

Changing the Logo in the Web Viewer Layout

To change the web viewer logo in the web viewer layout, follow these steps.

1. Go to the <Style | Web Viewer Layout> menu.

2. Select the web viewer layout whose logo you want to change.

3. In the <Basics> tab, click the <1Choose an image.> link to change the logo.

4. Click the Save Now button.

Showing Tables of Contents

The table of contents is always shown. To add a list of figures, tables, or code, add a chapter of the matching type.

Setting the Table of Contents Level

In the web viewer, the table of contents shows all levels: parts, chapters, and Heading 1 through Heading 5. To show the table of contents only down to a specific level, follow these steps.

1. Go to the document details page.

2. In “Basics”, click the <Update Book> or <Update Article> link.

3. In the “Hide the table of contents in the web viewer.” option, select the heading level from which to hide the table of contents.

   • To show all 5 heading levels, select “No”.

   • A short document builds its table of contents only from headings, so you cannot select Heading 1. Hiding from Heading 1 would leave the table of contents empty and remove the right menu of the web viewer.

4. Click the Save button.

Expanding Table of Contents Headings

In the web viewer, the “table of contents(left panel)” shows only part titles by default. To expand headings down to a specific level when the web viewer opens, follow these steps.

1. Go to the document details page.

2. In “Basics”, click the <Update Book> or <Update Article> link.

3. In the “Unfold the table of contents in the web viewer.” option, select the table of contents level to expand(chapter, Heading 1 to 5).

   • The “Hide the table of contents in the web viewer.” option, which sets the table of contents level for the whole web viewer, takes precedence.

4. Click the Save button.

Showing Chapter Icons in the Table of Contents

You can show the icons set for chapters in the web viewer's table of contents.

Setting the Table of Contents Level on the Web Viewer Main Page

You can set the table of contents level of the web viewer main page separately from the web viewer's “table of contents(left panel)”. Follow these steps.

1. Go to the document details page.

2. In “Basics”, click the <Update Book> or <Update Article> link.

3. In the “Show the table of contents down to the next level on the web viewer main page.” option, select the table of contents level to show(chapter, Heading 1 to 5).

4. Click the Save button.

Hiding the Chapter Table of Contents

The right side of the web viewer shows the table of contents of the current chapter. To hide the chapter table of contents, follow these steps.

1. Go to the <Style | Web Viewer Layout> menu.

2. Select the web viewer layout of the document.

3. In Options, select “Do not display the table of content in chapter.”.

4. Click the Save Now button.

Showing Only the Outline of the Chapter Table of Contents

If you click the 1icon of the chapter table of contents on the right side of the web viewer, only the “outline” appears, without the headings, as shown in the following figure.

Downloading Files (PDF, EPUB, HTML, MS Word)

Download files from the <1Downloaddownload> menu in the web viewer sidebar.

You can disallow downloading specific files. Follow these steps.

1. Go to the document details page.

2. In “Basics”, click the <Update Book> or <Update Article> link.

3. In “Options”, select the files that users cannot download.

4. Click the Save button.

Downloading PDFs by Chapter

You can download PDF files by chapter from the web viewer. This feature is off by default. It works in documents that have a PDF theme and a PDF page layout set and that allow PDF downloads. To turn it on, run the following command in the Console.

set-preference -name SUPPORT_CHAPTER_PDF_DOWNLOAD -value true

Click the <1Chapter Title.pdf> link to download the file.

Setting the Section View

You can show sections as an accordion, an opened accordion, or tabs.

Setting the Section View of a Chapter

You can set a different section view for each chapter. To set the section view of a chapter, follow these steps.

1. Click the <Update Chapter> link of the chapter to set the section view for.

2. In Style, select the “1Section View”.

3. Click the Save button.

Setting the Section View of a Heading 1 Paragraph

To set the section view of a “Heading 1” paragraph, follow these steps.

1. Open the editor.

2. Click the <Optionscheck_box> of the “Heading 1” paragraph to set the section view for.

3. In Style of the options, select the “2Section View”.

4. Click the Save button.

Search Suggestions

When you search in the web viewer, ManualWorks automatically 1suggests search terms based on “heading” paragraphs and “index” settings.

Ignore spaces when suggesting search terms

When you type "유지보수" (maintenance), ManualWorks finds not only "유지보수" but also "유지 보수", which is the same word written with a space.

Match Korean by jamo when suggesting search terms

When search terms are autocompleted, typing only the initial consonants of Korean words shows related entries. For example, typing "ㄱㅅ" shows entries such as "기사" and "검색".

Search autocomplete in blogs and libraries

The search boxes of blogs and libraries also support search autocomplete. However, in libraries it works only when you set the documents to search.

Search suggestions are turned on by default in new documents, and the administrator can change this default in the general settings. To turn off this feature, clear the “2Support search suggestions.” option of the document.

set-preference -name SUGGESTION_CACHE_SIZE -value 10

Receiving Feedback

The web viewer supports receiving feedback. This option is selected by default when you first create a book.

• When a user gives feedback, you are informed by a notification or email.

• View the feedback on the document details page and in the <Statistics | Feedback Statistics> menu.

Users submit feedback by selecting one of the five options at the bottom of the web viewer.

When users select one of the following options, they add details before submitting, as shown in the figure.

• Not At All Helpful

• Not Very Helpful

• Somewhat Helpful

To stop receiving feedback, follow these steps.

1. Go to the document details page.

2. In “Basics”, click the <Update Book> or <Update Article> link.

3. In Options, clear “Support feedback.”.

4. Click the Save button.

Sharing

The web viewer supports sharing through “Copy Link”, “X.com”, “Facebook”, and “Mail”.

If you set up a mail server, sharing by mail appears. To turn off sharing by mail, run the following command in the Console.

set-preference -name ENABLE_MAIL_SHARING -value false

To turn off the “Sharing” feature, follow these steps.

1. Go to the document details page.

2. In “Basics”, click the <Update Book> or <Update Article> link.

3. In Options, clear “Support sharing.”.

4. Click the Save button.

Related Documents and Backlinks

The web viewer shows Related Documents and, for each chapter, backlinks that reference the chapter. Documents that the reader cannot view(documents that are not published and that the reader has no access permissions for) and tasks that the reader cannot access do not appear in the lists.

The LinkUpdateScheduler scheduler updates backlink information every 30 minutes by default. Backlinks may not appear until 30 minutes after an update. To show backlinks immediately after an update, click the 2Init Backlinks link in the <Resource | Related> menu.

To hide backlinks in the web viewer, run the following command in the Console. Supported starting with ManualWorks 6.0.20.

set-preference -name HIDE_BACK_LINKS -value true

Blocking External Search Engines

To block search engines such as Google from accessing published documents, follow these steps.

1. Go to the document details page.

2. In “Basics”, click the <Update Book> or <Update Article> link.

3. In Options, select “Disable the access of Web Crawler.”.

4. Click the Save button.

Hiding the Author and Update Time

To hide the author and update time, follow these steps.

1. Go to the <Style | Web Viewer Layout> menu.

2. Select the web viewer layout of the document.

3. In Options, select “Do not display the author and update time.”.

4. Click the Save Now button.

Hiding the Image Paragraph Overlay

When you click an image paragraph in the web viewer, an image paragraph overlay appears. To turn off this feature, follow these steps.

1. Go to the <Style | Web Viewer Layout> menu.

2. Select the web viewer layout of the document.

3. In Options, select “Do not use the figure overlay.”.

4. Click the Save Now button.

Preventing Content Copying

To prevent users from copying web viewer content, follow these steps.

1. Go to the <Style | Web Viewer Layout> menu.

2. Select the web viewer layout of the document.

3. In Options, select “Disable Content Copy.”.

4. Click the Save Now button.

Copying Chapter Content as Markdown

You can copy chapter content in Markdown format.

Click the <1Copy as Markdown> link in the web viewer and select <Copy as Markdown> from the context menu to copy the chapter content in Markdown format. In the same menu, use <Preview as Markdown...> to preview the content, and <Copy Path> to copy the Markdown address of the chapter. Paste the chapter content copied as Markdown into the prompt of an AI service such as ChatGPT.

Viewing Content at Markdown Addresses

If you add .md to the end of the address of a published document or chapter, the content appears as Markdown. Use this to give an AI just the address instead of copying and pasting the content.

• Added to a document address, it shows the document title and the table of contents of chapters.

• Added to a part address, it shows the part title and the table of contents of the chapters under it.

• Added to a chapter address, it shows the content of that chapter.

Each item in the table of contents links to the Markdown address of that chapter. Chapters excluded from the web do not appear in the table of contents. For documents published by tag, the structure, titles, and aliases at the time of the tag are used.

Opening External Links in the Current Window

When you click an external link, it opens in a new window. To open external links in the current window, follow these steps.

1. Go to the <Style | Web Viewer Layout> menu.

2. Select the web viewer layout of the document.

3. In Options, select “Open the external link in current window.”.

4. Click the Save Now button.

Opening Internal Links in a New Window

When you click an internal link, it opens in the current window. To open internal links in a new window, follow these steps.

1. Go to the <Style | Web Viewer Layout> menu.

2. Select the web viewer layout of the document.

3. In Options, select “Open the reference link in new window.”.

4. Click the Save Now button.

Setting a Context Menu for Internal Links

You can set internal links to show a 1context menu, as shown in the figure, instead of opening directly in the current window or a new window when clicked. Follow these steps.

1. Go to the <Style | Web Viewer Layout> menu.

2. Select the web viewer layout of the document.

3. In Options, select “Show the context menu when clicking on the reference link.”.

4. Click the Save Now button.

Opening the Document Explorer by Default in the Web Viewer

You can set the side panel to open the document explorer instead of the document's table of contents by default when the web viewer opens. Follow these steps.

1. Go to the <Style | Web Viewer Layout> menu.

2. Select the web viewer layout of the document.

3. In Options, select “1Open the document explorer when opening a web viewer.”.

4. Click the Save Now button.