Guides

Documentation Navigation Guide

Overview

The Web Manuals Reader consists of three different navigation groups and the document content itself.

  1. The top bar should be familiar from the portal page you use to navigate to a document.
  2. The side bar can be used to get an overview of the document you are reading, send comments, print and much more.
  3. The bottom bar is most likely the navigation tool you will use the most as it quickly lets you navigate between pages.


Top Bar

We will start off with a quick introduction of the available items in the top bar and continue with a more detailed guide.

  1. The Home button lets you navigate back to the start page.
  2. Under Recent you will find a list with links to all recent documents you have accessed.
  3. Clicking My Documents in the Reader will show you a list of the documents you have marked as favourites, and by clicking them you will open them.
  4. Some documents requires explicit checkout or a quiz. The button placed here will either checkout the document or take you to the quiz.
  5. Use the search function to quickly find the page with the relevant information you need.
  6. The User Settings Menu contains options for going to the Web Manuals Help page, Log Out and more.


Recent​

The Recent button will display a list of all the recent documents you have accessed. Clicking on an item in the list will open up that document in the Reader. This feature is also available from the portal pages.


My Documents

Clicking My Documents in the Reader will show you a list of documents you have marked as favourites in the Portal. Clicking on an item in the list will open up that document in the Reader.

You make a document a favourite in the Portal. By clicking on a document in the list of document you will see the pages, detailed information about the document and a blue star.


Checkout

Some documents requires either an explicit checkout or a quiz, a message will be displayed when that is the case and the button shown above (quiz in this case) will help you checkout the document.

Search

When using the search function in the reader you can choose to search the current document or any document on the site.

If you get more than one search result and choose one alternative you can then go through all the other search results by using the buttons next to the search field as shown below.

User Settings Menu

The available menu items can vary depending on your user type and site specific settings. By default you will have at least the three options displayed in the image below. 

  • User Settings - Allows you to change user information, the options available can vary.
  • Change Password - Not always available, but when it is it lets you change your password.
  • Help - Opens up the Web Manuals Service Desk site.
  • Logout - Logs out you from the site.

Left Bar

We will start off with a quick introduction of the available items in the left bar and continue with a more detailed guide.

  1. Under Pages you will get an overview of all the available pages in the current document.
  2. The Table of Contents lists all the headings in the document.
  3. Here you can manage your favorite pages for the current document.
  4. Post a comment (comments can be view by all readers) or send a change request to the document owner.
  5. Access the print functionality.
  6. From here you  can highlight and annotate text your document as well as navigate between highlights.
     

Pages

By clicking on the Pages button a window with all pages in the document will be displayed, the current page is marked with a blue border. Pages marked with the Greek Delta sign represents pages with changes and pages with the star icon represents pages added to your favorites. The filter, found in the upper right corner, allows you to filter out the desired pages by page name.

​Table of Contents

The Table of Contents windows displays all the headings in a expandable tree, clicking on a heading will take you to the page containing the selected heading. The filter function, found in the upper right corner, can be used to filter out the desired headings.

Favorites


The Favorites windows displays all the pages you have added to your favorites, pages added are marked with the star icon in the thumbnail. To add a new page to your favorites open up window and press the Add to Favorites button, you can remove it by pressing the Remove From Favorites button.

Comments

The Comments window contains two views, the User Comments and the Change Request. The former allows you to post a comment connected to the current page and to view all other comments made by users for the current page. Change Request sends a message to the document owner in the form of a task.


Print

The Print window contains options for printing pages from the current document, the printed pages will include a watermark if the checkbox print with watermark is being checked. If the option print with watermark is not visible it means you cannot print without watermarks. This is a specific setting for the document type that the document has.


Highlight & Annotations

The Highlight button opens up a window used for creating new highlights, managing annotations no longer connected to a highlight, navigating between highlights and giving you a list of all annotations in the document. To create a new highlight select a color from the above window and mark the appropriate text.

Annotations

If you want to add an annotation to a highlight you simply click on the highlight and a dialog like the one shown above will be displayed. Enter your text and press save to store it. Note that highlights with annotations are marked with a border around it, as shown below.

 

Annotation box

The annotation box have two buttons on the lower right. The first one is for removing an annotation and the associated highlight. The second button, resembling a linked chain lets you detach the annotation and by pressing it again you can reattach it to another location (even another page) by selecting text on the page.


Navigation Bar

The navigation bar consists of eight buttons and a slider, if a button is grayed out it means that the there is no page to navigate to using that button.

  1. Takes you back to the first page in the document you are viewing.
  2. Takes you back to the first page in the previous chapter.
  3. Takes you back to the first previous page with changes.
  4. Takes you to the previous page.
  5. Using the slider you can quickly navigate through the document by dragging the circle button.
  6. Takes you to the next page.
  7. Take you to next page with changes.
  8. Takes you to the first page in the next chapter.
  9. Takes you to the last page in the document.


View a future revision

If Readers are allowed they can view a revision before the date it has been made available.


Make it possible to view a future revision in the Reader

You do this before publishing the document by choosing to make it available at a later date and tick the box Allow readers to view the Revision before "from" date. 

 

View a future revision in the Reader

If the option is checked a dropdown menu is to be found in the topbar in the Reader. If clicked you can choose the not yet available revision to view it.


Reviewing a document

When you are logged in as a Reviewer you will get some additional options to help you review the document.

  1. Click this tab to open up the Review tab.
  2. Reviewing next revision means that you are viewing an unpublished revision of the page. Next to it you find the current Workflow status with a number in a white circle, which shows the number of reviewer comments that has been made on the current page. Clicking the Workflow status will open up the Review tab.
    On the right side of the Workflow status are two buttons which gives you the possibility to either Reject or Accept the page directly from the top bar menu. 
  3. Click the triangle icon to open up a change log that shows what has been changed since the last revision. If the Editor has made a comment to the changes you will see that to.
  4. The black line shows you where on the page the changes has been made.
  5. To make it easier to find the pages in need of reviewing you can navigate using these buttons as they will take you the previous/next page containing changes.


The Review tab

The review window consists of three different tabs: Current page, Pages and Document Log. In the topbar of the page you see the current Workflow status of the page (In Review in the example below) and the number of Reviewer comments. 


Reviewing the current page

The tab Current Page lets you review only the current page. As a Reviewer you can either Comment, Reject or Accept the page. If you comment the page you will leave a comment to the Editor but the Workflow status of the page will not change. Note that a reviewer comment can never be deleted.

If you choose to Reject the page you should write a reason why you rejected the page so that the Editor will not the reason for the page being rejected. Rejecting a page cannot be made undone. Instead the Editor needs to put the page back to Draft.

If you choose to Accept the page it will move to the next Workflow status.

If you tick the checkbox Show status history you will see a history containing both of reviewer comments and changes of the Workflow status (with timestamps).


Reviewing multiple pages

If you click the tab Pages you will get a list of all the pages in the document and their Workflow statuses. From this view you can select multiple pages and Reject or Accept several pages at once.


1) Shows the different available Workflow statuses that can be reviewed. If you click a Workflow status all pages with that status will be selected and can be Rejected or Accepted in one click.

2) On all pages that can be reviewed you will see checkboxes which lets you select multiple pages and Reject or Accept them in one click.
 

The Document log

The Document log shows you a detailed list of all the pages, their current Workflow status, their previous statuses and reviewer comments together with time stamps. It is also possible to print the document log.

Sign in

Lorem ipsum dolor sit amet consectetur adipisicing elit. Sequi earum repellat id accusamus unde labore nihil quam impedit voluptates modi ratione, amet in!