Document date 14/10/16 DocuNet Viewer for ios Software version 3.2.1

Transcription

1 Document type User Guide Document code VST-DN-VIEWER-IOS Document owner David Hedley Document date 14/10/16 Software DocuNet Viewer for ios Software version 3.2.1

2 This document is published by and property of Vistair Systems Limited. Vistair Systems Limited All rights reserved. This publication may not be reproduced, whether in whole or part, in any material form without the written consent of Vistair Systems Limited. Manual managed and published by Vistair

3 Version Control VERSION CONTROL Document Date Software Version Updated By 01/01/ Vistair 12/07/ David Hedley 26/07/ David Hedley 05/08/ David Hedley 27/08/ David Hedley 29/09/ David Hedley 14/10/ David Hedley Vistair Systems Limited VC 1

4 Version Control INTENTIONALLY BLANK VC 2 Vistair Systems Limited

5 Contents Contents 1 About this Document System Requirements How to Install Logging in Home Page Tool Bar Viewing and Navigating the Library Library List Deleting Documents Page-by-Page Navigation Back/Forward Tool Location Tracking Breadcrumb Tool Filtering Tool (Where Applicable) Layer Filtering Tool (Where Applicable) Revisions and Notices (Where Applicable) Opening Tabs New Tabs Opening Links in a New Tab Switching Between Tabs Vistair Systems Limited 1 1

6 Contents Rearranging Tabs Closing Tabs Full Screen Icon Selecting Images PDF View Searching Document Content Search Results Annotations Adding Annotations Selecting Text Annotation Creation Window Quickly Adding a Bookmark Annotation Viewing Annotations on the Page Editing and Deleting Annotations The Annotations Panel Reordering and Deleting Annotations Document Updates and Annotations Annotations and Multiple Document Revisions PDF Annotation Hints and Tips Upgrading from Bookmarks Adding and Updating Documents Mandatory Only Mandatory + Updates for Optional Vistair Systems Limited

7 Contents 9.3 All Available Filter Updates Screen Cancelling Group Updates Settings Night Mode Text Size Update Over Wifi Only Advanced Settings Logs Compact Document Content Mark Documents As Read Unregister Device Registration Information Licence Info Portrait View iphone Differences Vistair Systems Limited 1 3

8 Contents INTENTIONALLY BLANK 1 4 Vistair Systems Limited

9 About this Document 1 ABOUT THIS DOCUMENT This document is intended as a guide to installing and using the DocuNet Viewer for ios from an end-user perspective. It covers initial set up and the new functionality featured in the DocuNet Viewer. Vistair Systems Limited 1 1

10 About this Document INTENTIONALLY BLANK 1 2 Vistair Systems Limited

11 System Requirements 2 SYSTEM REQUIREMENTS DocuNet Viewer for ios has been tested on the following systems: ipad ios ipad ios iphone ios The app should also be compatible with ios 7 and 8, although this is not recommended and not supported. Vistair Systems Limited 2 1

12 System Requirements INTENTIONALLY BLANK 2 2 Vistair Systems Limited

13 How to Install 3 HOW TO INSTALL You should install DocuNet Viewer for ios from the Apple App Store or from your company s local app store as directed by your administrator. On the Apple App Store you should search for DocuNet : While searching you may also see the following app: This app is functionally identical to the main DocuNet Viewer app and can installed alongside the main app if you require access to two different libraries at the same time (for example when attending a training course). Vistair Systems Limited 3 1

14 How to Install INTENTIONALLY BLANK 3 2 Vistair Systems Limited

15 Logging in 4 LOGGING IN In order to log in to the new DocuNet app, you must be aware of your Username, Password and Airline Designator. You must enter this information in the Authentication page as displayed below. If you have deleted and reinstalled DocuNet you will be presented with the below screen. Vistair Systems Limited 4 1

16 Logging in Selecting Continue will automatically re-register your app with the displayed credentials: Selecting Unregister Device will generate the confirmation message displayed below. If you would like to logout of the app and login as a different user, select Yes, Unregister to display the standard Authentication screen displayed in Section Vistair Systems Limited

17 Home Page 5 HOME PAGE Upon logging into the DocuNet app, you will be presented with your airline specific home page. This will be similar to the image seen below, and will contain airline branding and contact information for your application support. Vistair Systems Limited 5 1

18 Home Page INTENTIONALLY BLANK 5 2 Vistair Systems Limited

19 Tool Bar 6 TOOL BAR DocuNet Viewer for ios has a tool bar situated in the bottom left hand corner of the screen when the device is in landscape mode. This tool bar will allow you to access; 1. Document library list and contents (See Section 7) 2. Search functionality (See Section 7.13) 3. Annotations (See Section 8) 4. Updates screen (See Section 9) 5. Settings (See Section 10) Vistair Systems Limited 6 1

20 Tool Bar INTENTIONALLY BLANK 6 2 Vistair Systems Limited

21 Viewing and Navigating the Library 7 VIEWING AND NAVIGATING THE LIBRARY The DocuNet Viewer contains the standard viewing and navigating functionalities featured in previous versions. The below covers a brief explanation of the document library: 7.1 LIBRARY LIST The library is a list of documents divided into groups. Groups are coloured grey for reference. Current selected document is shaded a lighter grey. Group You can filter the list of documents in the library by typing into the Filter Documents box displayed below the Documents title. This will filter the list of installed documents by the search terms used. E.g. Typing FCOM will only show installed documents with FCOM in the title. Documents with a blue dot before the title are newly installed documents that have not yet been opened / viewed. The blue dot will disappear once viewed. Selecting a document from the list will load that document into the current tab of the right hand content panel. Selecting the triangle to the right of the group name will expand/ collapse that group s contents. Select the triangle to the right of Documents will expand/collapse all groups. Tapping on the document name will load the first page of that document into the content pane on the right hand side Vistair Systems Limited 7 1

22 Viewing and Navigating the Library Tapping on the right arrow in the document/section list will allow you to navigate into that document/section without loading anything into the content pane. When viewing a document, the library list will switch to showing the contents for that document (see Section 7.4) You can return to the document library list at any time by tapping twice on the book icon in the tool bar Deleting Documents If you wish to remove documents from your library, you can tap and hold on either the document group, or the individual document in the list. Deleting a group of documents offers 2 available options; to delete all documents in group, or to delete all optional documents in group: If there are no optional documents in the group then that option will be disabled. Select which option is applicable select Delete from the resulting popup to action the delete. To delete an individual document, select the document in question and hold down until the Delete Document pop up is visible. Select this to delete the document. 7 2 Vistair Systems Limited

23 When prompted, select Delete. DocuNet Viewer for ios User Guide Viewing and Navigating the Library Delete individual document Note: Any mandatory documents that have been deleted will immediately show as requiring an update to reinstall the document. 7.2 PAGE-BY-PAGE NAVIGATION You can navigate through a document by swiping left/right, and/or for HTML documents, by using the Previous and Next links at the top and bottom of the pages. 7.3 BACK/FORWARD TOOL You can move back to a previous page you have visited using the back button on the bottom bar. Once you have moved back to a previously read page, you can move forward to a page you read subsequently by using the forward button. 7.4 LOCATION TRACKING The table of contents tracks where you are in the document, highlighting the current section you are looking at. Selecting the above highlighted Info icon will display the details of the document. Vistair Systems Limited 7 3

24 Viewing and Navigating the Library 7.5 BREADCRUMB TOOL You can see the path you have taken through the navigation panel by tapping on the breadcrumb button. This shows each section you have been through. You can jump to any of the sections displayed by tapping on them. 7 4 Vistair Systems Limited

25 Viewing and Navigating the Library 7.6 FILTERING TOOL (WHERE APPLICABLE) In certain documents there is the ability to filter pages by the aircraft registration or other audience. If this is selected, only sections that are relevant to the relevant selected are displayed. 7.7 LAYER FILTERING TOOL (WHERE APPLICABLE) In certain documents, there is the ability to see different layers of information. You will recognise these pages as three buttons, numbered 1-3, which will appear in the bottom bar. The layer numbers will be greyed-out (as above) if there is no information on the page in that layer. Tapping on the layer tool will cycle through the display of information contained in those layers. By convention the following apply, however the exact interpretation is down to the document owner: 1. Layer 1 only ( Need to know ) 2. Layer 1 and layer 2 ( Nice to know ) 3. Layers 1, 2 and layer 3 ( Background information ) Vistair Systems Limited 7 5

26 Viewing and Navigating the Library 7.8 REVISIONS AND NOTICES (WHERE APPLICABLE) The Revisions button links to all the revisions made for the selected document. In some documents, notices or temporary revisions have also been incorporated and these are listed and hyperlinked via the Notices button. The title of the Notices button is configurable and may show different text in your app. Revisions and Notices can now be opened in a new tab: simply hold down on the required item in the Revisions or Notices list and select the option displayed in the below selection (Section 7.9.2) 7.9 OPENING TABS A significant new feature with the DocuNet Viewer is the ability to open multiple tabs (up to 7) New Tabs You can open a new tab by simply pressing the + button in the document viewing page. Once you have selected to open a new tab, you will see the additional tab displayed below, with the currently selected tab displaying document title text in bold. 7 6 Vistair Systems Limited

27 Viewing and Navigating the Library Opening Links in a New Tab The DocuNet Viewer also supports the ability to open hyperlinks in a new tab. You can tap and hold on a link, and you will have the options to Open or Open in a New Tab Switching Between Tabs You switch between tabs by tapping on the document name in the tab Rearranging Tabs Tabs can be rearranged by tapping and holding on the tab title. It can then be dragged left or right to a new position within the list Closing Tabs Only the current tab can be closed. Tap on the small X to the left of the tab title 7.10 FULL SCREEN ICON When in landscape view, you can select to view the document in full screen mode by tapping the full screen button. This will then hide the left-hand panel. Vistair Systems Limited 7 7

28 Viewing and Navigating the Library 7.11 SELECTING IMAGES When selecting images from a document, there is a control panel at the top of the image that allows you to rotate the image in 90 increments and pinch zoom in/zoom out. To go back to the document, select Close in the top right corner PDF VIEW When viewing a PDF document, there are options in the bottom right hand corner of the main page view for the document to do the following actions: 7 8 Vistair Systems Limited

29 Viewing and Navigating the Library Selecting the PDF Thumbnail will generate the below bar allowing you to swipe to pages further into the document. Each page is watermarked with a page number and will be displayed in the viewing panel when selected SEARCHING DOCUMENT CONTENT The search functionality allows you to search for specific terms and phrases within the library. Once selected, the Search menu will display in the left hand pane of the main screen. The scope of search results can be set to search the current document being viewed ( Current ), all the documents in the same group as the current document being viewed ( Group ), or all documents ( All ) in the library. In addition, you can also search for Titles Only or the Exact Phrase. Titles Only will only show results where the search phrase appears in a section title. Exact Phrase will only show search results which contain the exact phrase typed. i.e. If you enter Engine Fire as the search phrase, it will show results from all sections which have both Engine and Fire in them somewhere. When Exact Phrase is selected, only sections containing Engine Fire will be shown. Selecting this option is equivalent to putting double quotes around the search phrase. Note that search phrases are not case sensitive. Vistair Systems Limited 7 9

30 Viewing and Navigating the Library The search phrase can contain more complex expressions: Engine or Fire Engine and Fire Engine near Fire Engine not Fire Eng* Engine Fire shutdown will find sections with either Engine or Fire in them will find sections with both Engine and Fire in them. This is the default mode i.e. this is the same as searching for Engine Fire. will find sections with Engine close (within 10 words) to Fire. will find sections with Engine that do not contain Fire. will find sections containing words that begin with Eng. will find sections containing the exact phrase Engine Fire and the word shutdown. These expressions can be combined with parentheses: (Engine or Fire) not shutdown will find sections that have either Engine or Fire but not shutdown. Other things to note about searching: 7.14 SEARCH RESULTS Synonym matching for alternative spellings is handled, so that searching for aircraft will also find airplane, aeroplane and plane ; passenger will also find pax ; taxi will also find taxy ; color will also find colour etc. Stemming, so that searching for Brakes will also find Brake, Braked and Braking. Accent stripping, so that searching for role will also find rôle. The search results will be displayed as shown below. Search results are split by documents in the order they appear in the library, and will initially display 5 results. There is an option to select the show more button, which will then display all results for this document. In addition, you can use the arrows in the top right hand side of the Search menu to step through the results on a specific page. These results are numbered in the adjacent box Vistair Systems Limited

31 Viewing and Navigating the Library Results are highlighted in yellow, with the search result bordered by a black box as you step through the results. Arrows to step through multiple search results Results highlighted and bordered When selected, shows more search results within this document Vistair Systems Limited 7 11

32 Viewing and Navigating the Library INTENTIONALLY BLANK 7 12 Vistair Systems Limited

33 Annotations 8 ANNOTATIONS When viewing a manual you can add notes and annotations to any range of text in the document. The annotation tool shown below lists the annotations you have made to your documents: Annotations can be created on PDF or structured (HTML) manuals; the process is the same for both. Any annotations you create will be preserved across updates to the documents. See Section 8.5 for more details. 8.1 ADDING ANNOTATIONS Annotations are added by first selecting the range of text you wish to annotate Selecting Text To add an annotation, select some text from the content panel by tapping and holding on some text. You can then extend the text range using the standard ios controls: Each time the selection changes, an Annotate popup will appear. This may appear at the end of a list of options: Vistair Systems Limited 8 1

34 Annotations Annotation Creation Window When you have selected the Annotate option to create an annotation or selected Edit on an existing annotation, you will see the following window: You can type any text you wish into the annotation box up to a 2000 character limit. The radio buttons at the bottom of the window allow you to choose a category for this annotation. The categories will highlight the selected text in different ways, and in the annotations panel (See Section 8.4) you can filter by annotation category. You can move the annotation window by tapping and dragging on the window title bar. You can resize the window by tapping and dragging on the bottom right corner: The window size will be remembered along with your annotation. To save any changes, select the Save button. To undo your changes, select Cancel Quickly Adding a Bookmark Annotation You can quickly and easily add a new bookmark annotation to the text at the top of the content pane. Click the add bookmark button at the top of the left hand Annotations, Search or Contents panel: For PDF documents, a bookmark annotation will be created at the current section or at the top of the current page (depending on how the PDF has been constructed). 8 2 Vistair Systems Limited

35 Annotations For HTML documents, the text at the top of the page will be selected and a new bookmark annotation will be created: In both cases the text of the annotation will default to the current section name and the annotation category will default to a bookmark. To create the annotation click the Save button. 8.2 VIEWING ANNOTATIONS ON THE PAGE To view your annotations on the page, tap on the highlighted text, and a window with the annotation will pop up: will become: 8.3 EDITING AND DELETING ANNOTATIONS To edit an annotation, first select it on the page as in Section 8.2, then tap the Edit text: Vistair Systems Limited 8 3

36 Annotations You will then see the same window described in Section 8.1.2, but with the addition of a Delete button: To delete the annotation, select Delete and select Confirm on the confirmation dialog box. 8 4 Vistair Systems Limited

37 8.4 THE ANNOTATIONS PANEL DocuNet Viewer for ios User Guide Annotations Selecting the annotation tool above will show the annotations panel in the left hand side: Each annotation you have created will be shown in the scrollable list. For each annotation you will see the annotation text, then manual title and the section of the manual, truncated to fit on one line. The annotation text has the appropriate styling for the annotation category. Vistair Systems Limited 8 5

38 Annotations Tapping on an annotation will take you to where that annotation is and display it in the content panel. Similarly selecting an annotation in the content panel will highlight the corresponding annotation in the list in annotation panel. The currently selected annotation in the list is shown in an expanded form: This shows the annotation text, manual title and section as before, except they are now word-wrapped and not truncated. It also shows the highlighted text. You can filter the list of annotations in the following ways: Typing text in the search box at the top of the panel. As you type, only annotations which have highlighted text or annotation text which contain the typed text will be displayed Selecting the Current Document option. This will only show annotations in the currently viewed document. You can select a specific annotation category from the category picker. This will only show annotations that have the specified category Reordering and Deleting Annotations You can delete annotations by swiping left on an annotation and selecting the Delete option: Alternatively you can select the Edit button in the top panel and then select the tool, followed by the Delete option. While in Edit mode, you can reorder the annotations by tapping and dragging on the tool. Select Done to exit edit mode. 8 6 Vistair Systems Limited

39 Annotations 8.5 DOCUMENT UPDATES AND ANNOTATIONS When documents in the library are updated, the system will normally automatically reattach annotations to the correct place in the document. However, depending on how the document has changed, there are some cases where this will not work correctly. For example: The text that was originally highlighted has been changed or removed The section that contained the text has been deleted In cases like these, the application will alert you by attaching a warning symbol to the affected annotations: If possible, selecting the annotation will still take to you to approximately where the annotation was originally made. When the annotation is selected, the expanded information tells you what is wrong with the annotation: In this case, the highlighted text in the document has changed from when the annotation was created. You can then repair the annotation as follows: Select some text that you want to reattach the annotation to Tap on either of the warning triangles You will see the following dialog box: Vistair Systems Limited 8 7

40 Annotations Once you have selected OK, the annotation edit window will appear against the newly selected text: You can edit the annotation text as required When you select Save, the annotation will be reattached to the selected text Annotations and Multiple Document Revisions If there are duplicate documents in the library for example the current revision and the next revision due to become effective then you can make annotations to either revision. When the next revision becomes effective and the previous revision is removed from the library, any annotations made on the old revision should automatically transfer to the new revision PDF Annotation Hints and Tips Annotations can be made to either structured (HTML) or PDF documents. Due to how the documents are constructed it is much more reliable to annotate structured documents than PDFs. To improve the likelihood of annotations being correctly reattached to PDF documents when they are updated, please note the following: The quality of the outlines/bookmarks in the PDF is crucial. In particular bookmarks that point to regions of PDF pages (as opposed to just the page itself) will allow the annotations to work much better. Word will generate bookmarks like this if you set the following PDF option when doing Save as : Annotations are linked to the closest possible previous bookmark. If the text of the bookmark changes between revisions then it will not be possible for the application to automatically reattach the annotation. Therefore if at all possible, do not change bookmarks between different revision (i.e. avoid putting revision information into the text of the bookmark). 8 8 Vistair Systems Limited

41 Annotations Successive revisions of the PDF documents should be constructed in exactly the same way for each revision. E.g. if you are saving a Word document to PDF, ensure you do it in exactly the same way with the same options each time. Don t do Save as PDF for one revision and then print it to a PDF for the next revision. Some PDFs use custom font encodings where it is not possible to determine the text on the page. In these cases, the PDF will not be searchable and the highlighted text will not make sense. 8.6 UPGRADING FROM BOOKMARKS In versions v3.1.2 and before of DocuNet Viewer for ios, there was a bookmarks feature. This has now been replaced by the annotations functionality. If you have created bookmarks using the previous version of the viewer then they will be transformed into annotations with the category when you install version 3.2 and above. Vistair Systems Limited 8 9

42 Annotations INTENTIONALLY BLANK 8 10 Vistair Systems Limited

43 Adding and Updating Documents 9 ADDING AND UPDATING DOCUMENTS When updates are available to download, you will see a red badge icon above the updates button. The number indicates the number of updates available. This number includes mandatory updates and also updates to optional documents you have chosen to install. The Updates screen is divided into 3 sections; Mandatory Only, Mandatory and Updates for Optional, and All Available. If there is an update pending for a document, a warning is shown in the contents view (TOC) when the document is selected. 9.1 MANDATORY ONLY Mandatory Only will show all documents that are mandatory for you to Install/Update. These will be displayed with a red icon. 9.2 MANDATORY + UPDATES FOR OPTIONAL Mandatory + Updates for Optional will show all Mandatory documents requiring installation as well as all Optional documents requiring updates. Mandatory documents are displayed in red, Optional updates are displayed in yellow. Vistair Systems Limited 9 1

44 Adding and Updating Documents 9.3 ALL AVAILABLE All Available shows all available Mandatory and Optional updates and installs. Mandatory documents are displayed in red, optional updates are displayed in yellow. This is how you can see new optional documents to install. Once installed, any updates to those documents will be shown in the Mandatory + Updates for Optional tab. 9.4 FILTER UPDATES SCREEN You can filter the updates screen to install a specific set of documents. For example if you wanted to install all FCOM documents, you can type FCOM to filter all available installs with FCOM as part of the title. After you have filtered specific documents, you can select to Update All to install all documents with the filtered text. 9.5 CANCELLING GROUP UPDATES You can cancel a Group install if the Update Group option was selected in error. Individual document updates can still be cancelled in the usual way. 9 2 Vistair Systems Limited

45 Settings 10 SETTINGS There are 3 available options the Settings panel: 10.1 NIGHT MODE Night mode changes the app into a mode which is suitable for environments with low levels of lighting. Night Mode affects text, background and images. Text is shown in colours appropriate for a low-light environment. Images are either inverted or dimmed, depending on the content TEXT SIZE For HTML documents which re-flow the text, you can modify the text size using the slider bar. This will not affect PDF documents in the library. Vistair Systems Limited 10 1

46 Settings 10.3 UPDATE OVER WIFI ONLY This option is turned ON as default. When selected, the app will only update documents when connected to Wifi ADVANCED SETTINGS There are several advanced options at the bottom of the settings panel: Logs If requested by our support team, this will package up some application logs and put them into an . You will then need to select Send on the to send the information to our support team Compact Document Content As delta updates are applied, old data can accumulate on the device. Selecting this option will optimise the storage the application uses to remove this old data Mark Documents As Read Selecting this will mark all the updated and new documents in your library as Read meaning they will no longer be highlighted as unread in the document library list Vistair Systems Limited

47 Settings Unregister Device Selecting this, followed by Unregister on the following confirmation alert will de-register your device. This means you will then need to re-register it with a username and password before the app will work again. You should only select this option if advised to by our support team Registration Information This information shows the details of who the app is registered to, along with some diagnostic and version information Licence Info This displays a popup containing licence information for libraries and packages used in the development of this app. Vistair Systems Limited 10 3

48 Settings INTENTIONALLY BLANK 10 4 Vistair Systems Limited

49 Portrait View 11 PORTRAIT VIEW When you are accessing the DocuNet Viewer whilst in Portrait mode, you can access the Tool Bar section by using the Tool Bar button in bottom left hand corner of the main page view. This will display a pop up menu, which allow you to access the Tool Bar functionalities. (Document library list, Search, Annotations, Updates and Settings) Vistair Systems Limited 11 1

50 Portrait View INTENTIONALLY BLANK 11 2 Vistair Systems Limited

51 iphone Differences 12 IPHONE DIFFERENCES DocuNet Viewer for the iphone has functionally the same as the DocuNet Viewer on the ipad but is restricted to portrait orientation only. There are some minor layout differences to improve the experience for small displays and the Breadcrumb feature is not available. Vistair Systems Limited 12 1

52 iphone Differences INTENTIONALLY BLANK 12 2 Vistair Systems Limited