Document Statistics

In the <Statistics | Document Statistics> menu, you can view basic information for each document. When you select a document, the information appears on the “Basics”, “Paragraph Type”, and “Chapter” tabs. Short documents do not have the “Chapter” tab.

Basic Information

The analysis includes hidden chapters and paragraphs. The information is provided not only for the document but also for each chapter and paragraph type.

Basic document information

Item

Description

Chapter Count

Number of chapters

Element Count

Number of paragraphs

Word Count

Number of words separated by spaces, tabs, and line breaks

Letter Count

Number of all characters except spaces, tabs, and line breaks, including special characters

Reference Count

Number of all links

Inline Image Count

Number of all inline images

Note the following.

On the “Basics” tab, click “Reference Count” to show a list of the links in the document with their chapters, links, and URLs. Use the “Edit” link in the list to open the paragraph.

Word Analysis

Provides word frequency statistics for the document. On the “Basics” tab, click “Word Count”.

To copy the analysis to the clipboard, click the <1Copy to clipboard> button.

The data is separated by line breaks and tabs. You can paste it into Excel, a text editor, and so on.

Document Validation

To improve the quality of a document, ManualWorks validates the following items. Click the <Start> button in “Document Validation” to run the validation and show a list of errors. To skip checking images and links included by external URL, turn on “Disable External Resource Check”.

Document validation items

Item

Description

Image

Checks whether the images in image paragraphs and inline images exist. An image included by external URL may appear not to exist because the web server rejects Java requests.

Document link

Validates internal document references.

Web link

An external URL link may appear not to exist because the web server rejects Java requests.

"The URL has changed." means that the web server response code is neither 200 nor 404. In most cases, it is a 301 or 302 response.

File link

Checks whether linked files exist.

Email address link

Checks whether the format of linked email addresses is valid.

Unsupported strings

Checks for unsupported strings. If this error occurs, click the <Escape the unescaped contents.> button in the error list.

Referenced chapter

Checks whether the source of a referenced chapter has been deleted.

Include Other Elements

Checks Include Other Elements.

HTML structure check

Checks whether the HTML structure is correct. If this error occurs, open the paragraph in the editor and save it without changes.

Unnecessary white space

Checks for unnecessary white space. If this error occurs, open the paragraph in the editor and save it without changes.

Empty content

Checks whether the content of a paragraph that is not an image, table, or object paragraph is empty.

Config format

Checks whether the format of paragraph setting values is correct.

To validate unnecessary white space, enter the following command in the Console.

set-preference -name VALIDATE_WHITE_SPACE -value true

When ManualWorks validates external images and links, it sends the USER_AGENT setting value in the UserAgent HTTP header. The default value is as follows.

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.36