Web Manuals Glossary

We are happy to present you a list of the most common Web Manuals terms and icons, we hope it helps you navigate our system more easily!

Change log comments:Screenshot 2023-12-06 at 08.49.54.png

Short explanation or description accompanying modifications made to a document. These comments offer valuable context and insight into the reasons behind specific changes, serving as a valuable tool for monitoring and recording a document's or system's progression throughout its development.

Change Log module:Screenshot 2023-12-06 at 08.51.04.png

List of all changes done in a manual. The module change log can be filtered to show only important or minor changes and changes with comments. It gives a list with the username, date, and change.

Change request:Screenshot 2023-12-05 at 11.46.29.png

Written comments a reader gives to ask for a modification. It can be turned on and off on a manual level.

Compliance libraries:Screenshot 2023-12-05 at 11.51.11.png

The Compliance Library is an additional feature that enables the integration of regulatory legislation with your documents, providing a clear indication of your compliance status and pinpointing the exact location within your documents where the regulation requirement is located.

Content mirror:Screenshot 2023-12-06 at 08.51.04.png

This allows you to create a text section that mirrors another document's content.

Cross references:Screenshot 2023-12-05 at 15.04.25.png

Links from one manual to another or parts within the same manual or to an external link.

Custom modules:Screenshot 2023-12-05 at 15.14.20.png

This allows you or us to create templates for modules you use frequently. For example, if you need a customized Front page, MELs, or tables, we will create a custom module for you.

Dashboard:Screenshot 2023-12-05 at 11.51.51.png

The Dashboard offers a summary of the site's status and displays sections like "Last Edited," "Monitor," "Review," "Distribute," "Control," "Expiring Documents," and "Support Tickets." You can customize the dashboard by choosing the tabs you want to see using the "Customize" button at the bottom right of the screen.

Design:Screenshot 2023-12-06 at 09.10.07.png

The design is composed of 3 different parts: the header, the footer, and the body. The header is the top part of the manual that usually reflects the chapter number, name, date, etc. It is fixed and cannot be manually changed. The footer is the bottom part of your manual, it usually shows the page number, manual name, shortcode, which cannot be manually changed. The body is the style that will be reflected in your manual. We can set up the font, size, and color of your text/headers, adjust the spacing between lists, and many other details to give a standard look to your manuals.

Document Type:Screenshot 2023-12-05 at 11.52.30.png

A document type is a classification that links the review process of a document with default configuration options, including preferences for receiving warnings, page layout, heading numbering, and page numbering format.

Dual Locale:Screenshot 2023-12-06 at 09.53.30.png

Allows for a two-column structure in which the contents of each column are written in a different language.

External acceptance:Screenshot 2023-12-05 at 15.13.39.png

An external acceptance document is a specialized document designed to secure approval from regulatory authorities, like the CAA, before it is disseminated to readers.

External document:Screenshot 2023-12-05 at 15.05.34.png

This document is externally stored and serves as a link or hyperlink to the location where the document is hosted. For instance, it could be a link to your CAA home page. 

File document:Screenshot 2023-12-05 at 11.53.01.png

Documents, such as PDFs, Word files, and images, that can be uploaded, stored, and distributed through Web Manuals but cannot be edited are called a file document

Internal acceptance:Screenshot 2023-12-05 at 15.12.52.png

An internal acceptance document is a specialized document designed to seek internal review or approval before distributing it to readers.

Modules:Screenshot 2023-12-05 at 11.59.28.png

All the different features that can be added to a page (ToC, text section, LeP, change log, etc.)

Notice type:Screenshot 2023-12-05 at 15.17.24.png

A notice-type document is a distinct document type that does not involve any review process. It is typically employed for creating items such as meeting minutes or notices.

Numbering format:Screenshot 2023-12-05 at 15.07.23.png

The format used for your page number. N: the number of pages, 0: chapter number. 0.0-n: the chapter number.heading2-page number.

Pages:Screenshot 2023-12-05 at 11.57.33.png

Pages offer an easy way to access internal procedures, links, text, or images from the reader's dashboard.

Page label:Screenshot 2023-12-05 at 11.57.07.png

Page labels are identifiers assigned to individual pages within a document. These labels facilitate efficient navigation and referencing of specific pages within a document, particularly in lengthy or intricate documents.

Partial revision:Screenshot 2023-12-06 at 09.12.36.png

When creating a revision that only includes certain pages of the newest revision. 

Reader App:IMG_0242.jpg

EFB, our app used for the distribution of content.

Reader comments:Screenshot 2023-12-05 at 11.56.06.png

Written response or feedback submitted by a reader who has read a manual to express their thoughts or engage in a discussion concerning the content they have read.

Review comment:Screenshot 2023-12-05 at 11.55.29.png

Written feedback offered by a reviewer who has analyzed a  manual assigned for them to review. These comments typically offer an assessment, critique, or suggestions.

Sections skins: Screenshot 2023-12-06 at 09.08.18.png

It is a recurring look that we create to be easily applied to your paragraph. For example, Note, Caution, and Warning can be added before a paragraph.

Styles:Screenshot 2023-12-06 at 09.05.34.png

It is a recurring look that we create to be easily applied to your text. For example, if you have text in your manual that is red, bold, and underlined, We can create a style that will apply those three criteria to the selected text.

Tags:Screenshot 2023-12-05 at 11.54.54.png

It allows you to create groups of documents and tag them according to your own criteria to highlight their importance and make them more easily accessible to users.

Tasks:Screenshot 2023-12-06 at 09.00.03.png

A "task" is typically an assigned or required activity that necessitates completion, encompassing a range of actions like editing, formatting, and document management. These tasks can be designated as to-do list items for the document's owner. Moreover, in collaborative settings, especially when multiple editors are involved in a manual, tasks are used to establish transparency regarding individual responsibilities and monitor the overall project's progress.

Temporary revision:Screenshot 2023-12-05 at 12.00.30.png

Revisions that are only visible temporarily by using the function "time-limited". If a manual is only available for a year, we call it a temporary revision. 

Web document:Screenshot 2023-12-05 at 11.53.57.png

The only type of document that can be edited in web manuals is called a web document. It has the ability to import content from both HTML and Word documents.

Web Manuals Lifecycle:Screenshot 2023-12-05 at 11.58.19.png

Correspond to the top menu you see when editing your manuals, Monitor, Author, Review, Publish, and Control. It is called a lifecycle as it is the steps that can be followed while editing a manual.

Workflow:Screenshot 2023-12-05 at 11.54.29.png

The different steps and processes that documents must follow in order to be published. It decides who can edit, review, or publish. 

Was this article helpful?
1 out of 1 found this helpful

Articles in this section