User Guide. TG Browser. Technical Guide Browser 2.6

Transcription

1 User Guide TG Browser TG Browser Technical Guide Browser 2.6

2 TG Browser 2.6 User Guide

3 Contents Contents CHAPTER 1. INTRODUCTION SOFTWARE REQUIREMENTS HARDWARE REQUIREMENTS TG BROWSER RUNNING TG Browser running from TG Builder module TG Browser running from program files folder TG Browser running from exported project folder...12 CHAPTER 2. SYSTEM DESCRIPTION WINDOW HEADING CONTROL PANEL Back and Forward tools Open publication from folder button Contents Button Previous page and "Next page buttons Print tool Tools for catalog parts ordering Display remarks tool Send originator a message tool Playback control tool Publication selection button Settings tool Help Button PROJECT STRUCTURE AND SEARCH RESULTS DISPLAY AREA Project structure display area tabs Project structure display area control panel DATA MODULE INFORMATION DISPLAY AREA DATA MODULE CONTENT DISPLAY AREA General information Tools for data module content viewing...56 CHAPTER 3. OPERATION WITH THE PROGRAM OPERATIONAL DOCUMENTATION PROJECT STRUCTURE NAVIGATION SEARCH OPTIONS IN THE PROGRAM Standard search

4 Contents Quick search VIEWING OF DESCRIPTIVE DATA MODULES General information Abbreviation, terms and definitions view Use of Hyperlinks Illustration viewing Audio clips playback Video clip playback ELECTRONIC CATALOGS VIEWING General Information Project structure display area Illustration area Search in catalogs MAINTENANCE PLANNING DATA MODULES VIEWING Time limits information type data module viewing Maintenance inspection type data module viewing PROCEDURE VIEWING DATA MODULE OF FAULT ISOLATION PROCEDURE TYPE VIEWING General Information Interactive mode viewing Fault isolation procedure viewing Additional data viewing VIEWING DATA MODULES TAKING INTO ACCOUNT THEIR APPLICABILITY General Information Document display filtering regarding applicability VIEWING OF DATA MODULES DURING TG BROWSER RUN FROM TG BUILDER MODULE MULTI-PUBLICATION VIEWING Multi-publication creation and editing Multi-publication viewing PRINT-OUT Print settings Document preview Print out taking into account applicability CONCLUSION

5 Welcome Welcome The EOD system for technical documentation development consist of subsystems, dedicated to: supervision of development process (TG Admin), creation of templates (TG Designer), development of data modules and CSDB management (TG Builder), browsing of interactive technical publications (TG Browser). Further, in the frame of this manual, mentioned above names of subsystems will be widely used. Welcome to electronic technical manuals viewing TG Browser version 2.6 system. If you are a beginner in using TG Browser, then it is recommended to study the contents of this guide. Notation Agreements The following agreements are used in the document text to mark out different meanings in the text of the manual: Pattern unseriffed unseriffed bold SMALL CAPS Monospace Description Identification of chapters and section of this document Identification of chapters and sections in other documents Names of dialog boxes, interface keys and menu items Combinations of keys to be pressed Text typed from a keyboard Besides the following agreements concerning abbreviation of identifications and names are assumed: Abbreviation IETP Context menu DM Description Interactive Electronic Technical Publication Menu opened by the right mouse button clicking Data module system System TG Browser 2.6 TD EOD Technical documentation Electronic operational documentation This guide contains figures made as screen shots. The figures show different interface elements of TG Browser program module. The following terms are used for the interface elements: 5

6 Welcome Interface element Description Dialog window an auxiliary window opened in case of the main menu item selection, mouse button click, etc. It contains dialoge elements which enable to adjust the program operation modes or control its further operation, e.g. by responding to the program request by selecting one of two provided buttons. Button a rectangular button displayed, with inscription or icon. Clicking a mouse key at the button results in a respective program action. Input field a rectangular window where any alphanumeric data can be entered. Some data can be entered in the field initially, and can be edited. Radio button an interface element which enables to select one of provided options. To make a selection, click the mouse key at the circle near the required option name. The selection is indicated by a bold black dot inside the circle. When selecting another radio button the previous selection is cancelled automatically. Flag an interface element which enables to select several provided options. To make a selection, click the mouse key at the square near the required option name. The selection is indicated by a black tick mark inside the square. Repeated mouse click at the previously selected flag will cancel the selection. 6

7 Welcome Interface element Description List (drop down list) an interface element which enables to select one of provided options. The list is opened by clicking the button. Additional Information This document is delivered together with the product in electronic form as a reference system. 7

8 Introduction Chapter 1. Introduction In this chapter computer software and hardware requirements and methods of TG Browser run are given Software Requirements For TG Browser 2.6 program operation the computer shall meet certain software requirements. 1. Operating system (any of listed below): Windows 2000 Professional. Windows 2000 Server. Windows 2000 Advanced Server. Windows XP Home / Professional Edition. 2. Supplementary SW (partially included in EOD software module delivery set): Macromedia Flash Player 6 and higher. MS Internet Explorer 5.5 and higher (to be installed where required). Windows Media Player 7 and higher (to be installed where required). Adobe Reader 5 and higher (or any other PDF viewer for help file viewing) Hardware Requirements Computer configuration required for adequate operation is given in the table below. Table 1-1 Device CPU RAM HDD CD-drive Monitor Possible options AMD Athlon <Socket754> or Intel Pentium A <533FSB, 1024Kb, Socket478>. Not less than 256 Mb (512 Mb is recommended) DDR400. Not less than 40 Gb (80 Gb is reccommended). DVD-R/CD-RW (electronic guide publications). 17", with resolution of up to 1024х768@85Hz or better. A minimum computer configuration is given in the table below. 8

9 Introduction Table 1-2 Device Possible options CPU AMD К6-II-233 or Intel Celeron 300. RAM 64 Mb. HDD 4 Gb. Monitor 17", with resolution of up to 1024х768@85Hz TG Browser Running TG Browser program is intended for viewing electronic technical documentation (TD) projects: In development process (under development in TG Builder module). Completed and submitted to the user (exported from TG Builder module). There are three ways of program running: TG Browser running from TG Builder module. TG Browser running from program files folder. TG Browser running from exported project folder. Remark: Depending on TG Browser running mode there are certain differences in available tools. These differences will be noted in the Guide as it is required TG Browser running from TG Builder module To view the projects under development TG Browser shall be run from TG Builder module. After EOD software module installation on the computer a folder with EOD software module shortcuts is added to Programs menu of Windows operating system (Fig. 1.1). Fig

10 Introduction Left-click at icon to run TG Builder module. Then a system log-in window (Fig. 1.2) is displayed in the screen center. Fig. 1.2 Enter username and password in the system in the provided fields. Remarks: 1. At the first start-up to log in the TG Builder use a basic account of ietmu user, for which ietmu password and Administrator rights are preset. 2. When using network system version, a server name shall be selected additionally. After pressing button, Caution dialog window may be displayed, with the message on changed code page settings. It will be displayed if code pages required for correct displaying of fonts for different languages have been changed. If you do not wish to read this warning at each TG Builder module run, check Do not show again flag. After pressing ОК button Welcome dialog window will be displayed (Fig. 1.3). Fig

11 Introduction To enter TG Browser program module press TG Browser icon in Welcome dialog window. Herewith Select a project to be viewed dialog window will be displayed (Fig. 1.4). Fig. 1.4 All projects developed by the current user are displayed in the list. Select the project and press Select button. Then TG Browser program module with the selected project will be run TG Browser running from program files folder After EOD software module installation on a computer TGBuilder 2.6 Loc (for local product version) and TGBuilder 2.6 Wg (for network system version) folders are created on the disk. To view TD: 1. Open the folder and run TGBrowser.exe. file. Then a system log-in window will be displayed (Fig. 1.5). Fig In Username and Password fields enter your requisites and press button. Then Select a project to be viewed window will be displayed (Fig. 1.4). Fig. 1.6 Select the project and press Select button. Then TG Browser program module with the selected project will be run. 11

12 Introduction TG Browser running from exported project folder TD project developed in TG Builder module is exported to be submitted to the customer. At project export the folder with the name, generated according to the following template, will be created in the target catalog: PUBLICATION NAME_DATE_TIME, e.g. AIRCRAFT-2010 Technical manual_ _ The folder contains folders and files with TD as well as TGBrowser.exe file with the program for viewing the exported information (Fig. 1.7). Fig. 1.7 To view TD open the folder with the exported project and run TGBrowser.exe file. TG Browser running with parameters (keys) When running TG Browser from the exported project folder, run parameters may be set. Run parameters are set with the help of command line keys. Keys and additional parameters are entered through space. - or / may be the first key symbol, so -n and /n keys are considered identical. The list of available keys is given in the following table. Table 1-3 <key> [<parameters>] /n /c <data_module_code> Description New TG Browser copy forced run. If the key is not specified and another TG Browser copy, run from the same folder, is found then this copy will be activated. When running the program the attempt to view the data module with the indicated code will be performed. If TG Browser copy, run from the same folder, is found and /n key is not specified then the positioning attempt on the corresponding data module will be performed in the operating program 12

13 Introduction <key> [<parameters>] Description copy. (/l, /t, /w, /h) <integral_number> /s <integral_number>, <integral_number>, <integral_number>, <integral_number> The key data allow setting the window position at TG Browser run. The keys define left and upper limits, width and height of TG Browser window. The keys are considered only when new TG Browser copy is actually run but not when the previous copy is activated. Example: TGBrowser.exe /l 100 /w 400 means run TG Browser, the left window border shall be located in 100 position X-direction and the window width shall be 400 dots. Unspecified key values are set by default. The key operation is similar to four previous keys operation and it sets same four parameters simultaneously. Specified numbers separated by commas define the position of the left border, upper border (relative to the screen left lower corner), width and height of TG Browser window. The key is considered only when a new TG Browser copy is run but not when the previous copy is activated. Example: TGBrowser.exe /s 100,100,600,400 means: TG Browser run with coordinates (100;100) of program main window left corner, width of 600 and height of

14 System description Chapter 2. System description In this chapter the following issues are discussed: TG Browser main window structure. Tools for technical publication navigation and information search and viewing. Only tools and commands used for operational documentation viewing in the current program version are considered in this and following chapters. After TG Browser run from the exported project folder the main program window opens (Fig. 2.1). Fig

15 System description TG Browser window consists of five parts. The numbers in Fig. 2.1 mean the following: 1 window heading; 2 control panel; 3 project structure and search results display area; 4 data module information display area; 5 data module content display area. Remark: When mouse cursor is set at any control element for 1 2 seconds, pop-up help appears. Let us consider all TG Browser window parts Window heading. The following information is displayed in the window heading. Program name TG Browser. Enter the viewed publication code, if any. Publication name. In the example, shown in Fig. 2.1, AIRCFT-2010 Technical manual publication code is unavailable Control panel Control panel mode depends on TG Browser running mode. If the program is run from the exported project folder, the control panel mode is shown in Fig Fig. 2.2 If the program is run from TG Builder module, the control panel has the appearance shown in Fig Fig. 2.3 Availability of Open publication from folder button and availability of Display remarks or Send originator a message buttons depends on the program running mode. Control panel tools and their brief description are given in the table. 15

16 System description Table 2-1 Button Description Back and Forward tools are used to navigate the previously viewed data modules. In the beginning of viewing both buttons are not active as no data module has been viewed. The following tools have the drop-down menus of data module viewing history. There is Open publication from folder button on the panel if the program was run from the exported project folder by OS Windows tools. It allows opening a project while viewing another one. Contents button is used to show\hide the project structure. Previous page and Next page tools ensure data module sequential viewing in the project in direct and reverse order. Print button is used to print out the whole project or its selected part. Send originator a message button is used to open the TG Builder module internal mail window. This button is on the panel if the program is run from TG Builder module. Display remarks button allows viewing remarks in technical publication. The button is on the panel if the program is run from the exported project folder by OS Windows tools. Add to order tool is used to order component items. This tool is on the panel when the electronic catalog is viewed. View ordered items tool is used to view component items order list. This tool is on the panel when the electronic catalog is viewed. Playback control (audio clips) tool allows controlling playback of audio clips embedded in data modules. Publication selection button opens Selection of publication to be loaded window. This button is on the panel if the multi-publication is viewed. Settings tool calls parameter setting dialog, which influences project viewing. Help button opens help file. Let us consider control panel tools in more detail Back and Forward tools In the beginning of viewing Back and Forward buttons are not active as no data module has been viewed. Press buttons to the right of the buttons to open the list of viewed data modules (Fig. 2.4). 16

17 System description Fig. 2.4 Left-click the viewed data module identification to return to this DM Open publication from folder button Open publication from folder from the exported project folder. button will be on the control panel, if TG Browser was run This tool allows opening a project for viewing when the project is being viewed in TG Browser. After button pressing Browse window opens. To load a project, select a folder with the exported project and press OK button. Herewith project path is saved. Users who often work with several technical publications may use this option. After button pressing to the right of Open publication from folder will open (Fig. 2.5)., a drop-down of projects viewed during the last operation session 17

18 System description To load a project left-click at its name. Fig Contents Button Contents button is used to show\hide the project structure. The button is pressed by default. Herewith in the left part of the window project structure display area is shown Previous page and "Next page buttons Previous page and Next page buttons allow paging a project like a book, selecting all DM sequentially Print tool After Print button pressing print setting dialog opens. For information about print setting creation see section 3.12 Conclusion Tools for catalog parts ordering When viewing DM of Electronic catalog type, Add to order tools are displayed on the toolbar. and View ordered items 18

19 System description Add to order tool Press Add to order button to order the required items (spares) which are described in electronic catalogs. For information about this option see section Project structure display area. View ordered items button Press View ordered items button to view generated orders. For information about this tool see section Project structure display area Display remarks tool Display remarks project folder. button will be on the control panel if TG Browser was run from the exported Display remarks button allows viewing remarks in technical publication. For information about creating remarks in data modules see subsection Add a remark Tool of section Press Display remarks button to view remarks. Herewith in the lower part of TG Browser window additional Remarks window will be displayed (Fig. 2.6). Fig. 2.6 If any remarks have been created in technical publication data modules, then in Remarks window the structure in the form of the tree consisting of codes and data module names for which those remarks were created and the remarks will be displayed (Fig. 2.6, Fig. 2.7). To view the remarks press icon to the left of the required DM identification to maximize the tree branch and left-click at the remark to select it. Then in the right part of Remarks window the 19

20 System description content of the selected remark will be displayed and in the DM content viewing area the data module where the remark was created will be displayed (Fig. 2.7). Herewith the text to which the remark was made is highlighted with color. To edit a remark proceed as follows: Fig In Remarks window select the remark and press button. 2. In Remark window edit the remark text (Fig. 2.8). Fig

21 System description 3. To confirm the changes press button. Press button to close Remark window without changes saving. To delete a remark proceed as follows: 1. In Remark window select the remark and press button. Then request to confirm deletion will be displayed (Fig. 2.9). Fig Select Yes to delete the current remark, select No to save it. To hide Remarks window release Display remarks button on TG Browser window toolbar. Also Remarks window can be hidden by pressing the splitter in the upper part of the window (Fig. 2.10). Fig Send originator a message tool Send originator a message button will be on the control panel if TG Browser was run from TG Builder module. Press this button to open Message window which you can use to create and send a message to other originators, working on the project Playback control tool Playback control tool allows controlling playback of audio clips embedded in DM. For information about this tool see section Audio clips playback. 21

22 System description Publication selection button Publication selection button is on the toolbar when multi-publication is viewed. The button is used to go to another publication viewing (see subsection Publication switching of section ) Settings tool Select Settings tool to open Settings window (Fig. 2.11). Fig In the left part of the window the tab list is displayed. The right part of the window is intended for selected tab parameters displaying. There are three tabs for documentation viewing setting: Document. 22

23 System description Browser. Other. Document Tab Document tab is shown in Fig. 2.11: It is divided into four sections: Noname. Skip Paragraphs. Warning Settings. Tables Options. Noname section DM Language Select the language from the drop-down list (Fig. 2.12). The selected language defines: Fig Headers and other service information language according to ASD S1000D standard. Standard elements headings language: Warning, Caution and Remark. To be viewed in a particular language, data modules content should be developed in this language. If By default language is selected the service information language is the same as the language of the data module version. Besides the section contains three parameters: Highlight abbreviations. Fit view all figures. Show all illustration sheets. Highlight abbreviations The abbreviation dictionaries are created in TG Designer module. When the documentation is viewed set cursor at the abbreviation to view its decryption. To emphasize the abbreviations in the 23

24 System description text highlight them with color. For this purpose select Highlight abbreviations parameter. Herewith abbreviations and terms for which the decryptions are created will be highlighted (Fig. 2.13). Fit view all figures Fig The parameter is selected by default. When it is selected all illustrations will automatically fit the screen. Show all illustration sheets. The parameter is disabled by default. In this case if multisheet illustration is viewed in TG Browser module only the first sheet can be viewed. If the parameter is selected all sheets of the multisheet illustration can be viewed. Skip Paragraphs section The section contains three radio buttons: None. Empty. Filled with spaces. If None radio button is selected data modules will be displayed in TG Browser as they were created by the originator. If Empty radio button is selected, the paragraphs containing only one paragraph symbol will not be displayed. If Filled with spaces radio button is selected, the paragraphs containing Space symbols and empty paragraphs will not be displayed. The example of the data module containing empty paragraphs and a paragraph consisting of spaces is shown in Fig

25 System description Fig This DM with active None radio button when viewed in TG Browser is displayed in Fig Fig DM with active Empty radio button is shown in Fig The paragraphs containing one paragraph symbol are not displayed. 25

26 System description Fig DM with active Filled with spaces radio button is shown in Fig The paragraphs containing one paragraph symbol and the paragraph consisting of spaces are not displayed. Fig Warnings settings section The section contains the following parameters: Show warnings/cautions on datamodule opening. Show warnings/cautions for the entire data module. Align Caution and Warning by the left. 26

27 System description Show warnings/cautions on data module opening If this parameter is selected when procedures and data modules of Fault isolation procedure type are viewed warnings entered in preliminary requirements are displayed in display area. Show warnings/cautions for the entire data module The parameter is disabled by default. If Show warnings/cautions on data module opening parameter is selected then when procedures and data modules of Fault isolation procedure type are viewed only warnings entered in preliminary requirements are displayed. It meets the requirements of ASD S1000D standard. If Show warnings/cautions for the entire data module parameter is selected, then when procedures and data modules of Fault isolation procedure type are viewed ALL Caution and Warning units including those specified in technology steps and search procedure are displayed. Align Caution and Warning by the left If this parameter is selected the warning text will be aligned left. The example is shown in Fig Tables Options section Fig Tables Options section contains 4 parameters and radio buttons section: Add service tables. Consider servicing tables when numbering. Force table s borders. Show reference table in schedules. Interlace table lines colors. Add service tables Select the parameter to view data module service tables, for example reference table, illustration table. Otherwise service tables will not be displayed when DM is viewed. If the parameter is selected Consider service tables when numbering flag is checked automatically and is not available for editing (Fig. 2.19). 27

28 System description Fig The system does not allow service table addition but is not taken into account when data module tables are numbered. Data module table numbering starts with the number following the number of last service table (Fig. 2.20). Fig Reference table is a service table, Landing gear specifications table is a data module table. 28

29 System description Consider service tables when numbering The parameter is possible only when Add service tables flag is unchecked. If the parameter is not selected DM table numbering starts with No. 1. Force table s borders The parameter is not selected by default, and the tables are displayed according to ASD S1000D standard (Fig. 2.21). Fig When the parameter is selected the tables are displayed with ruling (Fig. 2.22). Fig

30 System description Show reference table in schedules The parameter is not selected by default. It can be selected when Add service tables flag is checked (see Fig. 2.23). Fig If Show reference table in schedules parameter is not selected reference table is not displayed in data modules of Inspection definition type but taken into account in table numbering (Fig. 2.24). Fig After Show reference table in schedules parameter selection, the reference table will be displayed in the beginning of DM (Fig. 2.25). 30

31 System description Fig Interlace table lines colors Let us continue consideration of Options dialog window parameters. Interlace table lines colors section allows setting interchange of white and grey colors of table lines. It is convenient when viewing large tables. It contains three radio buttons: Never. Based on table options. Always. If Always option is selected in formal and service table white and grey colors of lines will interchange (Fig. 2.26). 31

32 System description Fig If Never radio button is checked all table lines will be of different colors. If Based on table options radio button is checked, in formal table white and grey colors of lines will interchange if it is set in table properties at table creation in TG Builder module. Service formal tables are colored, if Always option is selected. Browser tab In Settings window go to Browser window (Fig. 2.27). 32

33 System description Fig In Browser tab there is the following: Selection window View Language (default) Parameters: Hide not applicable versions. Hide all DM version tabs. Show reset area. Show additional DM information. Show security class Unclassified. IDStat Panel Modes radio buttons: 33

34 System description Mode 1. Mode 2. View language selection by default In View Language (default) window the English language is selected by default. View language by default is taken into account when data modules containing versions in different languages are opened for viewing. When data module is selected the version with maximum number in selected by default language will open. To change view language by default select it from the drop-down list (Fig. 2.28). Fig The system saves the selected value. At next TG Browser module opening, the language by default will be the language selected during the last operation session. Remark: Language selection by default does not influence reference transition mechanism. The system will attempt to open DM version in the same language as the referenced DM. Hide not applicable versions The following in not used in the current system version: Hide all DM version tabs The parameter selection allows hiding data module versions tabs. Herewith DM version content will be displayed with maximum number. Show reset area If Show reset area parameter is selected then in the upper left part of TG Browser window large To initial state button is displayed (Fig. 2.29). 34

35 System description Fig After To initial state button pressing request to confirm the operation will be displayed (Fig. 2.30). Fig If Yes reply is selected you will return to initial DM from which viewing at the project opening has begun. Forward and Back buttons are not active, viewing history in Log tab is cleared. Show additional DM information If the parameter is selected, the following data are displayed on the information panel (Fig. 2.31): Marks text, set for publication or its chapter. For information about marks refer to EOD software module 2.6 User Guide. 35

36 System description Fig Show security class Unclassified If the parameter is selected then Security Unclassified is indicated on DM information panel (Fig. 2.32). If parameter flag is unchecked only security classifications names different from Unclassified will be displayed on DM information panel. DM information panel modes Fig On IdStat panel of data module information display area two modes of attributes display are available. Mode 1. Mode 2. IdStat panel view with selected Mode 1 is shown in Fig Fig IdStat panel view with selected Mode 2 is shown in Fig Fig

37 System description Others tab In Settings window go to Others tab (Fig. 2.35). Fig The tab contains the following parameters: Ask for confirmation while switching to another publication. Highlight visited links. Highlight false references. Ask for confirmation while switching to another publication The parameter is used for multi-publication viewing (see subsection Transition via references from publication data modules to other publications of section ). If the parameter is selected at 37

38 System description each transition via reference to another publication (and also at transition via Back/Forward buttons) the dialog window with the message informing that the data module is in a different publication and request to confirm transition will be displayed. Highlight visited links The parameter is selected by default. Herewith names and codes of viewed data modules change are highlighted with color. The example of the data modules of Scheduled/Unscheduled maintenance section viewed by the user is shown in Scheduled/Unsheduled maintenance. Highlight false references Fig The parameter is not selected by default. If the flag is checked then false references that is references with not found reference objects, will be colored. The example is given in Fig

39 System description Fig All changes made in Settings window tabs take effect after button pressing Help Button Let us continue consideration of TG Browser window main panel tools. Press Help open User guide file. button to Press button to the right of Help button to open the drop-down menu consisting of one item (Fig. 2.38). Fig Left-click at Show issue information item to open the window with information about the viewed publication creation date (Fig. 2.39). 39

40 System description Fig Project structure and search results display area Let us continue consideration of program main window elements (Fig. 2.40). Fig In the following section project structure display area and search results are described, in Fig it is indicated with number 3. Further it will be shortly referred as project structure area. 40

41 System description Project structure display area tabs Until Search tool is used, project structure display area contains two tabs: Structure. Log. In Structure tab the project structure is displayed, it is used for project navigation. The structure elements viewed by the user are colored similar to majority of Internet browsers. The example of project structure with viewed data modules is shown in Fig Fig In Log tab the codes and data modules names viewed by the user are displayed (Fig. 2.42). Fig Log tab is used for quick return to viewed data modules. For this purpose left-click at the data module identification. In Log tab the data modules identifications can be sorted by various criteria. For that purpose rightclick at the tab area to use the context menu commands. The context menu is shown in Fig

42 System description Fig Menu commands allow sorting the viewed data modules by the following criteria: Name. Code. Type. Time. Besides sorting can be performed by ascending\descending the values Project structure display area control panel Project structure display area control panel is shown in Fig Fig If TG Browser is run from TG Builder module, additional Edit version tool is displayed on the toolbar, which is used to load the editor corresponding to the viewed data module (Fig. 2.45). Fig The control panel buttons brief description is given in the following table. Table 2-2 Button Description Display settings tool opens View options window for selection of project structure elements display mode. Expand tool is used to expand embedded elements to the level determined by the user. It contains the drop-down menu for selection of expansion level depth of structure branches. Collapse all nodes tool is used to collapse all expanded embedded nodes. 42

43 System description Button Description Edit version tool is used to load the editor corresponding to the viewed data module. This button is on the panel if TG Browser is run from TG Builder module. Search tool is applied for search within the structure or catalogs. It contains the drop-down menu for selection of search type. Search options tool contains the drop-down menu for selection of quick search parameters by code and (or) name. Go to upper level tool is used to go one level up in the guide structure. Sort tool contains the drop-down menu for selection of sorting type. DM filter tool is applied to set display mode of project elements using the filter. It contains the drop-down menu for filter settings modification. Let us consider these tools in more detail. Display settings tool In TG Browser left window the project elements tree is displayed in Structure tab. There are several variants of elements representation codes, names, codes and names simultaneously. To set the project elements display use Display settings options window (Fig. 2.46). button. Press this button to open View 43

44 System description Fig The window is divided into two sections of parameters: Show Codes. Show Names. Checking\unchecking the flag in the section heading makes it available\unavailable for parameter entry. Names and codes may be selected simultaneously. When Highlight DM Code parameter is selected viewed structure elements codes are highlighted with violet color and selected elements code with yellow color. The situation when codes and elements names are not displayed is impossible, so the system does not allow unchecking both flags simultaneously one of them is always checked. Let us consider Show Names section names in more detail. In the upper part of the section the following radio buttons are displayed: Use DM Name. Use Last DM Version Name. Use DM Version Name in Lang. If Use DM Name radio button is selected data module names will be displayed in the structure tree. 44

45 System description If Use Last DM Version Name radio button is checked data module versions names with maximum number will be displayed in the structure tree. If Use DM Version Name in Lang radio button is checked the drop-down list for language selection will be available. Data module versions in selected language are displayed for DM, which have these versions. For the rest of DM the names are displayed in the available language. In the lower part of the section Show Only Part of DM Name parameter is displayed. Check the flag to make the following radio buttons available: TechName. InfoName. DM name consists of two parts separated by hyphen, and each part starts with the capital letter. The first part shows a described system (TechName), the second part shows the type of information contained in DM (InfoName), for example Landing gear Specifications. When corresponding radio button is enabled in View options window some parts of data module names will be displayed in Structure tab. Tools to expand and collapse embedded nodes Expand tool In Structure tab select all the project or its section. After arrow pressing in the right part of Expand button the drop-down menu will be displayed (Fig. 2.47). Fig Select Expand all command to expand the project structure or its part to the whole depth that is all data modules irrespective of the nesting depth will be displayed in Structure tab. The same result can be obtained by pressing Expand button. If Expand command is selected Enter dialog window will be displayed (Fig. 2.48). 45

46 System description Fig In Enter branch depth field specify the number of element nesting levels of the project tree which can be seen in Structure tab. Remark: Expand tool is related to the selected project tree branch in Structure tab. Collapse all nodes tool Select Collapse all nodes elements. tool to collapse the selected section containing expanded embedded Edit version tool Edit version module. tool button is on the toolbar if TG Browser module is run from TG Builder This button is active if a data module is selected. If a tool is selected (or F4 button is pressed on the keyboard) the editor with the data module content, corresponding to the data module type, will open. The document may be edited. Close DM editor to return to TG Browser module. Search tool In TG Browser window select the section for search in Structure tab. Pressing Search will lead to opening of the drop-down menu (Fig. 2.49). button Fig For information about search in the catalogs see section Search in catalogs. 46

47 System description Select Search menu item (or press key combination CTRL+F) to open Search dialog window (Fig. 2.50). Fig Search window contains three units for parameter entry. Search. Data Module type. Search parameters. Search Unit If In section radio button is checked, the search is performed in the section selected in Structure tab. Herewith in the field to the right of the button the name of the selected section is displayed. If Entire publication radio button is checked, search is performed in the whole project. Data Module type Unit In the window the data module types where the search will be performed are set. For this purpose check the flags before DM types names. To select all DM types press Select all button under the window. Search parameters Unit In the corresponding fields enter DM name, its code or text, contained in the required DM. In Name and Code input fields enter not less than two symbols, contained in the required elements. To search in the text you can set additional conditions: 47

48 System description Whole words. Case sensitive. If Whole words parameter is selected symbols sequence is considered to be meeting search conditions if it is a whole word and not a part of another word. Remark: Input fields have drop-down lists. In these lists the words entered by the user are saved to perform a quick search according to the previously entered criteria. After entering the parameters press Start search button. Search results are displayed in the left window in Search results tab which is displayed next to Structure tab (Fig. 2.51). Fig In Search results tab the list of all found data modules meeting the required search criteria is displayed. In the lower part of the tab search options are displayed. If any data module from the found list in the left window is selected in the right window its content with selected search words is displayed (Fig. 2.51). Let us continue considering control panel tools of the project structure display area and search results. Search options Button System provides an option of quick search. Quick search is a search by the first letters of the data module name or by the first symbols of its code. 48

49 System description For selection quick search settings Search options button is used. Press it to open the dropdown menu consisting of one Structure search opt. item. This item contains two more items by code and by name (Fig. 2.52). Fig Select the corresponding menu items to set the quick search parameters by code, by name or by code and by name simultaneously. To perform quick search: 1. In TG Browser window from the drop-down list of Expand tool select Expand all item to expand the project structure. Quick search can be performed only in opened folders. 2. From the keyboard enter the first letters of DM name if the search is performed by name (or DM code symbols if search is performed by code). In the lower part of Structure tab quick search window with the entered search line will be displayed (Fig. 2.53). Fig After search information input the first found section or data module in the project structure will be the current one. Transition to the next found element is performed by pressing the button with the down arrow on the keyboard. Remark: Quick search is performed by the first entered symbol, then by the first and the second symbols and so on. If the program does not allow entering the symbols it means that there is no such symbol combination in DM names (codes). 49

50 System description Go to upper level button tool allows quick navigating up the structure levels. At each button pressing every upper structure level becomes a current one. So by pressing this button several times you can go to the upper structure level and then the button becomes inactive. Sort Button Press Sort button to open the drop-down menu of data modules sorting settings in the project structure (Fig. 2.54). Fig By selecting the corresponding menu items you can set the required data module arrangement mode in the project structure display area. DM Filter ON/OFF Button The system provides an option of filtering data modules, displayed in the structure area by their name, code and type. To select the filter proceed as follows: 1. Open the list of DM Filter ON/OFF button by pressing the arrow to the right of the button. 2. Select Set filter command. Herewith the filter selection window will be displayed (Fig. 2.55). Fig

51 System description 3. In By name field enter the search line, for example, maintenance. 4. Check Descriptive flag. 5. Press Apply filter. After filter selection DM Filter ON/OFF button appearance will change from to. If the filter, described in the example is selected, in Structure tab data modules of Descriptive type with the name containing the word maintenance will be displayed (Fig. 2.56). Fig Remarks: Context menu 1. Press DM Filter ON/OFF button to reset the filter if it was set. 2. At setting cursor at the button for 1 2 seconds pop-up help showing if the filter is set and its parameters if it is set will be displayed. Some of described tools are duplicated by context menu commands called by right-click at the selected element of the project structure display area. The context menu is shown in Fig Fig

52 System description Toolbar buttons are duplicated by three upper menu sections commands. Lower section commands allow copying of the code and the name (or the code and the name separately) of the selected area element to Windows clipboard Data module information display area Let us continue consideration of program main window elements. In this section data module information display area is described and in Fig it is designated with number 4. Fig The example of the data module information display area is shown in Fig Fig

53 System description Data module information display area is shown in two lines. To expand the line press + icon to the left of the line. The first line contains the information about the data module identification and status part parameters (Fig. 2.60). Fig In the right part of the panel the organization logotype is displayed if it was defined on the project template creation step in TG Designer module. If in the viewed project applicability is set below the logotype the applicability filter will be displayed. By default, All value is set that is the document is valid for all items and under any operational conditions. Expand information panel about the data module by pressing + icon above the IdStad inscription. The fully expanded panel is shown in Fig Fig Press the corresponding - icon to hide status part or minimize the panel. The second line contains the information about data module structure number of headings, illustrations, tables and references, embedded in DM (Fig. 2.62). Fig To view the information maximize the line by pressing + icon. Maximize the line by pressing any active reference. The fully maximized line is shown in Fig Fig

54 System description To go to any element of the structure left-click at it. Please, note Panel options button to the left of References line (Fig. 2.63). After pressing the button the drop-down menu appears (Fig. 2.64). The menu contains 2 items: Autosize panel. Collapse when select. Fig If Autosize panel item is selected height of expanded window with the information about data module structure will be adjusted to the number of lines displaying all information about DM structure. In this case height of the window cannot be changed by dragging the window border with the mouse. If the item is not selected then height of the window can be changed by dragging the window border with the mouse. If Collapse when select menu item is selected, the line will be minimized after transition via reference to the data module structure element (Fig. 2.62). If the item is not selected the line remains maximized after transition via reference to the data module structure element (Fig. 2.63). If any structure elements are missing (figures, tables or references) in the data module, the corresponding references will be inactive and highlighted in grey color. The example of the data module area with missing tables is shown in Fig Fig In the previous sections the following parts of main TG Browser window such as Window heading (1), Control panel (2), Search structure and search results display area (3) and Data module information display area (4) (Fig. 2.66) were discussed. Data module content display area is described in the following section (5) (Fig. 2.66) Data module content display area General information In the right part of the program main window there is a data module content display area. It is designated 5 in Fig

55 System description Fig To view data module content left-click at its identification in the left window in Structure tab (Fig. 2.67). 55

56 System description Fig In the data module content display area all data embedded in the selected module will be displayed. text, tables, illustrations, video clips and so on. If there are several versions of the same data module each version is displayed in a separate tab with the version number, DM language and DM version creation date on shortcut. To go to the required DM version left-click at the corresponding shortcut. For more detailed viewing the data module content the display area can be dragged on the whole screen. For this purpose press F11 key on the keyboard. Press F11 key repeatedly to cancel the mode Tools for data module content viewing Above the display area of data module content there is a data module toolbar (Fig. 2.68). Fig The control panel tools description is given in the following table. 56

57 System description Table 2-3 Button Description Zoom In tool is used to increase the document scaling at viewing with an increment of 15 %. Zoom Out tool is used to decrease the document scaling at viewing with an increment of 15 %. 100 % button is used for quick return of the data module displayed part size to the initial size of 100 %. Scale tool is intended to change the document scaling at viewing. It is selected from the drop-down list or typed manually. Tool button is displayed on the toolbar if TG Browser is run from the exported project folder. Add a remark tool is used to create remarks, intended for the originator. Scroll Mode tool is used to switch over the data module display mode into the scrolling mode. Select Mode tool allows selecting the document text for subsequent coping. Quick Search field is used to enter the text fragment for search. Find tool is used to search the entered text in the document. Find previous tool is used to return to the previous found text fragment. Find next tool is used to repeat the search of the entered text fragment in the document. 57

58 System description Button Description Applicability display settings tool is used to control applicability display. The tool is displayed on the panel if applicabilities are set for the viewed project. Let us consider action of toolbar buttons. Zoom In tool Press Zoom In of 15 %. button subsequently to increase the size of DM part display area with increment Zoom Out Tool Press Zoom Out increment of 15 %. button subsequently to minimize the size of DM part display area with 100 % Button Press 100 % button to set the scale of the size of DM part display area of 100 %. Scale Tool Scale tool is intended to change the document scaling display at viewing. 100 % value is set by default. Scale value is selected from the drop-down list or typed from the keyboard. When scaling Arabic documents the distance to the right boundary of the horizontal scroll bar is set automatically. At scaling the position of the right text boundary remains unchanged for convenient reading of the document from right to left. Add a remark Tool Tool button is displayed on the toolbar if TG Browser is run from the exported project folder. Add a remark tool allows creating the remark to the selected text of the document for subsequent sending of the documentation to originators. Perform the following to create a remark: 1. Press button to switch to Select Mode. 2. In the data module display window select the text to which the remark will be added. To select the text set cursor to the text unit beginning, left-click and holding it move cursor to the end of the unit. 3. Press Add a remark button. 58

59 System description 4. In appeared Remark window enter the remark text (Fig. 2.69). Fig To create a remark press button. To cancel an operation press button. The created remark is saved in Notes folder which is created in the folder with the exported project. The remarks are saved in Notes.xml file. Scroll Mode tool When scroll mode is active cursor looks as. If you left-click cursor will look as. Then the data module content can be moved to any direction. Select Mode tool When scroll mode is active cursor looks as. In selection mode holding left mouse button you can select text units by the line. A part of DM content with selected text is shown in Fig

60 System description Fig Right-click the selected part to open the context menu consisting of one Copy item. If this item is selected then the selected fragment is copied to Windows clipboard and is available for any application. Quick Search field The field is intended to enter the text fragment for the search in the document. Find tool Press Find button to find the text entered in Quick search field. If the text is not found nothing occurs. If the text is found data module content is scrolled up to the required place and the found text is highlighted with the color (Fig. 2.71). Fig If the required text appears in DM again Find next button becomes active. 60

61 System description Find next tool Press Find next button to scroll DM content up to the next search line entry and select it. Herewith Find next button will be available. Find previous tool Action of Find previous performed to DM beginning. button is similar to Find next button but search and scrolling are Applicability display settings Tool Applicability display setting button is intended to set document elements display for which the applicability is specified. Press this button to open the setting list (Fig. 2.72). Fig Select Highlight items with applicability command to highlight the data module elements for which the applicability is specified. If Use different colors command is selected then data module content parts with different applicability will be of different colors. The example of the data module with two different applicabilities is shown in Fig

62 System description Fig In this chapter you have studied the following: the program main window structure. the tool for the program control and search and navigation in the project. 62

63 Chapter 3. Operation with the program In this chapter the following issues are described: IETP structure navigation. Search options in the program. Viewing of data modules content of different types. Print-out 3.1. Operational documentation project structure navigation To study the software resources you will require complete technical manual. If you have already worked with EOD software module you have a developed project which you can use to study TG Browser resources. If you have not then Operation in TG Browser demonstrational project is added to the guide. This example is not a real project but illustrative material. In the folder with the demonstrational project find TGBrowser.exe file. With the help of this file TG Browser run by usual means of Windows OS is performed. The program main window with the opened project is shown in (Fig. 3.1). Fig

64 The demonstrational project is a set of modules of different types. It contains five publications (folders) (Fig. 3.2): Descriptive DMs. Electronic catalogues. Procedures. Fault isolation procedure. Scheduled/Unscheduled maintenance. Fig. 3.2 Data modules of the type corresponding to its name is embedded in each folder. The data module name indicates the information embedded in it. For example, Descriptive DMs contains the following descriptive data modules demonstrating program main capabilities. Descriptive DMs Fire safeties there are references from other project data modules to this module. 64

65 Descriptive DMs Hyperlink data module with external reference which allows to view the information in another DM. Descriptive DMs Audio, video this DM contains the audio clip which you can playback and the video clip which you can view. Descriptive DMs Illustration with callouts the illustration with callouts is embedded in DM. Descriptive DMs Individual set of onboard tools the example of special tools list according to ASD S1000D standard. The tools from this data module are used in procedures. Descriptive DMs List of standard control instruments the example of standard control instruments list. Standard control instruments from this data module are used in procedures. Descriptive DMs List of consumables the example of consumables list. The consumables from this data module are used in procedures. Data module names are compiled according to ASD S1000D standard requirements. Data module name consists of two parts separated by hyphen, and each part starts with the capital letter. The first part refers to a described system (sub-system), the second part refers to the type of information contained in the DM, for example Descriptive DMs Hyperlink. The information embedded in the demonstrational project allows studying all software resources. To view the content of any data module left-click its identification in Structure tab. If you know the DM name and its location in the structure area then maximize the elements tree branch where it is located. Let us suppose we wish to view [BR-A A-362A-A] DM Procedures Checking air pressure in landing wheel tire which is in Procedures folder. To maximize Procedures tree branch select it and press Expand button. Herewith the tree branch will maximize and in the structure window the elements embedded in it will be displayed (Fig. 3.3). Fig. 3.3 To view the required DM, left-click at its name. DM code will be highlighted with yellow color and in the right window DM content will be displayed (Fig. 3.4). 65

66 Fig. 3.4 All DM content may not fit the display area. There are following ways to view the unavailable data modules parts: 1. Use scroll bars to the right of and below the DM content display area. 2. In the scrolling mode that is when Scroll mode button is pressed, left-click (herewith the cursor will look as ) and drag it to the required direction, the visible data module part will move together with it. 3. Set the cursor on area boundary, herewith it will look as. Left-click at it and move the boundary to the left to enlarge the display area. 4. Press F11 key on the keyboard. DM content display area will drag on the whole screen. Press F11 key repeatedly to cancel the mode. 5. Press Contents button on the control panel. To return Structure tab to the screen press this button again. To expand the project structure to the whole depth select the upper level of the project tree and press Expand button on the control panel. To navigate the viewed data modules use Back and Forward tools. The tools contain the drop-down lists of viewed data modules which are opened by pressing button to the right of the corresponding tool. Besides to navigate the list of the viewed data modules you can use Log tab (Fig. 3.5). To go to another tab left-click at the corresponding shortcut. 66

67 Fig. 3.5 To return to the viewed data module, left-click at its identification. For information about Log tab see section Project structure display area tabs. To look through all data modules backwards or directly use Previous page and Next page buttons. These buttons should be used to navigate within one tree branch. To navigate the project structure elements in Structure tab you can use keys with arrows of the additional keyboard. Up and down arrows moves the highlighting on all structure elements in the corresponding direction. Action of to the left and to the right arrows depends on the element which is currently highlighted. Let us suppose that the structure element located on the lower level in the given branch is selected (Fig. 3.6). 67

68 Fig. 3.6 If you press to the right arrow key in the situation shown in Fig. 3.6, it will lead to nothing. To the left arrow key pressing is similar to Go to upper level button pressing. The result is shown in Fig

69 Fig. 3.7 In the situation shown in Fig. 3.7, both buttons are active. To the left arrow key pressing is similar to clicking - icon near the element identification that is the selected branch will collapse. The result of to the left arrow key pressing is shown in Fig

70 Fig. 3.8 Let us return to the situation shown in Fig To the right arrow key pressing will lead to highlighting jump to the first DM of the selected branch (Fig. 3.9). Fig

71 Summing up we can say that to the left arrow key pressing will lead to the following: going to the highest structure level (if there is any); Collapsing of the selected branch (if there is a branch to collapse); going to the upper structure level (if there is any). And in this manner up to the highest structure level. To the right arrow key pressing will lead to the following: Expanding the branch (if there is any branch to expand); going to the lower structure level (if there is any). To the left arrow key pressing will lead to the highest structure level. To the right arrow key pressing, if no other arrows are used, will lead to the nearest DM located on the lowest level of the current branch Search options in the program. If the project has a branched structure and contains a lot of data modules then it is difficult to find DM without knowing its location. In such cases special search tools are used. It is possible to find DM if you know the code and\or name (or at least a part of it). Let us suppose that you need to find the following DM: [BR-A A-362A-A] DM Procedures Checking air pressure in landing wheel tire which is in Procedures Standard search To perform the standard search: 1. Make the upper level structure element electronic guide Operation in TG Browser the current one. 2. Press Search button and in the drop-down menu select Search item. Herewith Search window will open (Fig. 3.10). 3. Let us suppose that you do not know the type the required DM. Select all types in DM type section or press Select all button under the window. 4. In Search options section enter the known information about DM in the following fields: Name Checking air pressure in landing wheel tire or Code [BR-A A-362A-A. At least two symbols are required for the successful search. 5. It is possible to find DM without knowing its name and code. For this purpose in Searching by text field enter the text, unique for DM. If the text is too vague a lot of data modules will be found. 71

72 Fig After entering the search parameters press button. The search results will be displayed in the left window in Search results tab (Fig. 3.11). Fig In the tab the name and the code of the required data module meeting the search conditions are displayed. In the lower part of the tab search options are given and the time and the number of data modules, meeting the search conditions. To view the found DM left-click at its identification. Herewith in the right window its content will be displayed. To return to the project structure click at Structure shortcut. 72

73 Quick search There is one more way to search the data modules quick search. To set the quick search perform the following: 1. In TG Browser window in structure display area and search results press Search options button. 2. Select by code or\and by name search mode from the list of Structure Search opt. item (Fig. 3.12). To perform the quick search: Fig Make the upper level structure element the current one. 2. In TG Browser window from the drop-down list of Expand tool select Expand all item to expand the project structure. The quick search can be performed only in opened folders. 3. From the keyboard enter the fist letters of DM name if the search is performed by the name (or DM code symbols if the search is performed by the code). In the lower part of Structure tab quick search window with the entered search line will be displayed (Fig. 3.13). 4. After search information input the first found section or data module in the project structure will be the current one. The transition to the next found element is performed by pressing the button with the down arrow on the keyboard. 73

74 Remark: Fig Quick search is performed by the first entered symbol, then by the first and the second symbols and so on. If the program does not allow entering the symbols it means that there is no such symbol combination in the project. To remove the quick search window from the screen left-click at any place in TG Browser window. In the following sections let us consider software recourses of viewing data modules of different types Viewing of descriptive data modules General information Descriptive information is used to represent data on the item design, its working principles, purpose and operation. Description shall contain information on identification and arrangement of systems and survey information on components maintenance. Typical data modules are as follows: Item and its components description; Item operation description. 74

75 Descriptive modules may contain text, tables, illustration, audio and video clips, references. In Structure tab in Descriptive modules folder select BR-A A-040-A-A Descriptive DMs Hyperlink DM. Program main window with the data module opened for viewing is shown in Fig Fig In the upper part of the DM content view window there is an area containing the information about the data module viewed version. For information about this area see section 2.4 Data module information display area. Under the information about the data module version there is a toolbar (Fig. 3.15). Fig Using the tools you can perform the following: Change the scale of DM content view. Add remarks for the originator. Scroll DM content. Select the text areas. Perform search by DM content. 75

76 Select applicability information search settings. For information about the toolbar see section Tools for data module content viewing Abbreviation, terms and definitions view When the project template in TG Designer module is created, abbreviation, terms and definitions of normative documents are filled. You can set several variants of abbreviation decryption. When the document in TG Builder module is created you can paste the information from the dictionary in it. When the documents in TG Browser are viewed there is an option to view the decryption of abbreviation, terms and definitions of normative documents. To use this option check Highlight abbreviations flag in Settings window. When this parameter is selected the abbreviation will be highlighted. Set cursor at the abbreviation (term) for which the decryption is set, after two seconds the decryption of the abbreviation (term), the type and category name, to which this abbreviation (term) belongs will be displayed. The system tracks the language of the data module viewed version and provides the decryption in the DM version language if they were created in TG Designer module at the stage of project template preparation. The system also highlights the abbreviations in the data modules, imported in the project from XML files created in different programs Use of Hyperlinks It is often necessary to bind a particular element of the document with another element of the same document or other data module. References are used in such cases. There are several types of references: External references (hyperlinks) are used to create links with other data modules or their objects. Cross-references bind the selected place of the document with the element (illustration, table, section) of the same document. References are highlighted in the document with blue font and underlining (Fig. 3.16). When cursor is set at the external reference pop-up help with the information about the referenced data module and DM version will be displayed (Fig. 3.16). The name display is performed taking into account DM version language. Besides, the transition via reference is performed taking into account the language. If the referenced data module has versions in different languages then the transition will be performed into the version in the same language. 76

77 Fig Set cursor at operating controls external reference, wait for it to look as and left-click at it. Then the transition will be performed into the data module to which hyperlink refers. As a result the data module containing the information about operating controls operation will open for viewing (Fig. 3.17). 77

78 Fig In the left window in Structure tab the highlighting moved to DM identification which content is displayed in DM display area. Press Back button to return to DM view from which the transition via hyperlink was performed. The viewed hyperlink changed the color Illustration viewing General information Illustrations may be embedded in descriptive DMs. To view the DM with the illustration in Structure tab in Descriptive DM folder select [BR-A A-041A-A] Descriptive DMs Illustration with callouts DM (Fig. 3.18). 78

79 Fig Please, note the numbers to the left of the headings. These numbers help to navigate the DM headings structure which has hierarchic numeration like Microsoft Word multi-level lists. Under the illustration there are callouts numbers with the explanatory notes, so called legend. Set cursor at callout number so that it will take the shape of forefinger and left-click at it. Herewith in the upper part of the window an additional window with the illustration will be displayed. Activated callout will be highlighted with red color in this window (Fig. 3.19). 79

80 Fig When cursor is set at another callout, it will be highlighted with blue color and the inscription, corresponding to the legend will be displayed (Fig. 3.20). Fig

81 In Fig there are same numbers in different callouts in general view and in callout element. To view the next callout with the same number in the illustration click at the callout number in the legend again. The boundary between DM content area and illustration area can be moved in usual for Windowsapplications way. To close an additional window with the illustration, take the cursor to the windows boundary in its middle part (the cursor will take the shape of forefinger ) and left-click at it. An additional window with the illustration will be displayed if you left-click at the illustration. Illustration cross-references Cross-reference binds the selected place of the document with the element (illustration, table, section) of the same document. In this document illustration references are position numbers highlighted with blue font and underlined (Fig. 3.21). Fig Set the cursor to the reference so that it resembles a finger. Left-click at the reference. Herewith in the upper part of the window an additional window with the illustration will be displayed. The callout to which the reference is created will be highlighted in the illustration. Tools for illustration viewing The toolbar is in the upper part of the illustration viewing area (Fig. 3.22). Fig Remark: The toolbar has this view if the illustration has more than one sheet. If the illustration has one sheet, Current sheet field will not be displayed. A short description of the tools is given in the table. 81

82 Table 3-1 Tool Description Back tool allows returning to the previous viewed illustration sheet. Current sheet field allows selecting the required sheet of the multi-sheet illustration. It contains a drop-down list of sheet numbers. Scale tool is intended to change the illustartion scaling at viewing. It is selected from the drop-down list or typed manually. Zoom out button is used to minimize the size of illustration with increment of 25 %. Zoom in button is used to increase the size of illustration with increment of 25 %. Navigator tool allows viewing large illustrations in parts with all details. When this tool is selected additional Navigation window will be displayed. Back tool With the help of the tool you can return one step back to the previous viewed illustration sheet. For example, using it you can quickly return from the sheet view display and cross-section to the main view sheet (see subsection Additional options of illustration viewing ). Current sheet Tool Use Current sheet tool select the sheet number of the multi-sheet illustration. Use the sheet number using to the left arrows (Go to previous sheet ) and to the right arrows (Go to next sheet ). The transition is performed sequentially decreasing or increasing the numbers. Also it is possible to enter the sheet number from the keyboard or with the help of the drop-down list of numbers. Scale Tool Scale tool is used to change the scale of image display. Feet screen value is set by default. Scale value is selected from the drop-down list or typed from the keyboard. Buttons for illustrations viewing scale change are located to the left and right of Scale field Zoom out and Zoom in. Their description is given in the table (Table 3-1). Set the scale, for example 200 %. Then the illustration stops decreasing in the illustration viewing window, and Navigator tool to the right of Scale tool will become active for selection. 82

83 Remark: Navigator tool is not active if Feet screen scale is set. Navigator Tool Navigator tool allows viewing large illustrations in parts in all details. Left-click at Navigator tool, herewith the illustration viewing area will look as it is shown in Fig Fig The part of illustration visible in the screen fits a red rectangle. Red rectangle can be moved within the limits of white rectangular area, being seized by mouse (holding left mouse buton). The part of illustration fitted to a red rectangle is shown scaled-up in the illustration display area. The slider box located below a red rectangle allows changing relative scale of illustration display. Using the mouse move it to the left to decrease illustration size, and to the right to increase it. Additional options of illustration viewing Illustration callout can have a reference to the external data module. Such reference is marked with reference icon (Fig. 3.24). Fig

84 Remark: The reference icon is displayed in the additional window which opens at left-clicking at the illustration. After left-clicking at the illustration icon the code and the referenced external data module name will be displayed (Fig. 3.25). Fig To transit via the reference left-click at the DM name. The illustration callout can have a reference to another sheet of the same illustration, for example to go to the type view or the cross-section of some part Audio clips playback An audio clip, for example to explain some actions, can be embedded in the descriptive data module. In Structure tab in Descriptive DM folder select [BR-A A-040B-A] Descriptive DMs Audio, video DM (Fig. 3.26). 84

85 Fig An audio clip is embedded in the data module as an Icon an embedded object is displayed as icon. It is possible to playback, save, copy the object content. After right-clicking at the icon the context menu will be displayed (Fig. 3.27). Let us consider the context menu commands. Fig Save as... Command When Save as command is selected a window for folder selection to save audio clip will open. In Save as window enter the file name and the location to save a file. Copy Command When Copy command is selected the audio clip is copied to the clipboard. If TG Browser is run from TG Builder module then the audio clip can be pasted from the clipboard to another data module or another place of the document in TG Builder module. 85

86 Activate Command When Activate command the audio clip playback begins and Playback control button on the main toolbar of TG Browser window becomes active. After pressing it control tools of audio clip playback will be displayed to the right of it. When cursor is set at the buttons pop-up help will be displayed. The description of audio clip playback control tools is given in the table. Table 3-2 Button Description Video clip playback Play tool is used to start audio clip playback. Stop tool is used to stop audio clip playback. At subsequent start with the help of Play tool audio clip playback starts from the beginning. Pause tool is used to stop audio clip playback. At subsequent start audio clip playback starts from the moment where it stopped. Video clip can be embedded in the data module. Unlike an audio clip there are two ways to embed a video clip in the DM. In the form of Icon an embedded object which is displayed as an icon, it is possible to playback, save, copy the content. In the form of Embedded in the document object a whole object is embedded in the document equipped with browse facility. Video clip in the form of Icon. Video clip pasting place is marked as will be displayed (Fig. 3.28). icon. After right-clicking at the icon the context menu Fig When Save as command is selected a window for folder selection to save video clip will open. When Copy command is selected the video clip is copied to the clipboard. If TG Browser is run 86

87 from TG Builder module then the video clip can be pasted from the clipboard to another data module or another place of the document in TG Builder module. When Activate item is selected video player is started. Further video clip playback is performed with the tools of this video player. Video clip in the form of object embedded in the document A video clip can be inserted in the form of object embedded in the document with means of viewing. Video player window with control buttons is shown in Fig Fig The description of video clip playback control tools is given in the table. Table 3-3 Button Description Play tool is used to start video clip playback. Pause tool is used to stop video clip playback. At subsequent start with the help of Play tool video clip playback starts from the moment where it stopped. Pause tool is used to stop video clip playback. At subsequent start with the help of Play tool video clip playback starts from the beginning. Rewind tool is used to return to the video clip start. Open separately tool is used to load the video clip into the video player installed into the system by default and to playback. Further control of video clip playback is performed with video player means. 87

88 3.4. Electronic catalogs viewing General Information Electronic illustrated parts and assemblies catalogs databases, which with use of special software tools help users to get data on parts and assemblies easily and quickly. The electronic catalog is a list of items of similar attribute set presented as a table. The catalog can contain the illustrations with the callouts. To start working: 1. Open Operation in TG Browser demonstrational project for viewing. For that purpose run TGBrowser.exe file in the folder with the demonstrational project. 2. In Structure tab in Electronic catalogs folder select BR-A A-A Electronic catalogues Manual control panel DM. 3. For convenient viewing of the catalog hide project structure display area in the left window. For this purpose press Contents button in the toolbar of the main window (Fig. 3.30). You can move the catalog table under the window with the illustration. For this purpose in the catalog toolbar select Parts list snap bottom command from Options button list. Fig

89 Under the DM content view window there is an area containing the information about the data module viewed version. For information about this area see section 2.4 Data module information display area. Display area of the electronic catalog content consists of two parts: Catalog structure. Catalog structure is presented as a tree with all parts and assembly units as its elements. If a tree element is an assembly unit then in the structure it is displayed with icon to the left of its name. Left-click at this icon to view the structure of the assembly unit. Each line of catalog contains information on the item part or assembly, so we will name the line as position later. Each column of catalog contains cells with a certain attribute. Attribute data are set in the document template in TG Designer module. Window for catalog card display or illustration embedded in the catalog depending on the selected tab. The boundary between areas can be moved in usual for Windows-applications way Project structure display area The example of display area of Manual control panel catalog structure is shown in Fig Fig The following catalog contains attributes which are mandatory according to ASD S1000D standard. Under the window with the catalog structure there is a toolbar (Fig. 3.32). Fig The buttons of tools and their brief description are given in table. 89

90 Table 3-4 Button Description Add to Order (Ins) tool is used to order component items. View Ordered Items tool is used to view component items order list. Figures tool contains the drop-down menu for illustration selection and catalog card display mode setting. Settings of callout navigation tool. It is used to navigate the same-name callouts to search the current position in all illustrations, to search the next position from the several same-name ones in all illustrations. It contains the drop-down menu for selection of parameters. Options tool contains the drop-down menu to select the settings of the electronic catalog display. Tool button is displayed on the toolbar if TG Browser is run from the exported project folder. Add Annotation tool is used to create remarks, intended for the originator. Let us consider the action of the tools in detail. Add to Order Tool In TG Browser there is a comfortable system of parts and assemblies order and generation of order form in electronic form. To order perform the following: 1. Select any line cell of the catalog, for example Joint assembly mount. 2. In the toolbar select Add to Order tool. The action of this tool is similar to the action of Add to Order button on the toolbar of the main window and leads to the display of Order form dialog window (Fig. 3.33). 90

91 Fig Order form fields are filled by the program automatically. Filling of Order form window depends on attributes set for Order form window at the stage of electronic catalog template creation in the TG Designer module. For the considered example the following attributes are included in the list: Decription; Part number; Manufacturer; NATO stock number; Quantity. The information for Value column is taken from the corresponding catalog fields. Attribute values can be edited. Specify the quantity required for the order. Press Cancel button to reset the entered parameters and close Order form window. Press Apply to add the selected component item to the order. Add all required assemblies and parts to the order. View ordered items Tool Press View Ordered Items button to open General application window (Fig. 3.34). 91

92 Fig General application window contains the list of the ordered component items. Table form depends on attributes set for order at the stage of electronic catalog template creation in the TG Designer module. For the considered example table columns have the following names: Decription; Part number; Manufacturer; NATO stock number; Quantity. The columns are filled automatically with attribute values, entered in the order form. Above the window of the ordered component parts there is a toolbar with buttons: Change. Delete. Delete all. Change and Delete buttons are used for selected component part, Delete all button for all component parts. Press Change button to open Order form window for the selected component part. Attribute values can be edited in it. Press Delete button to open the window with request to confirm deletion (Fig. 3.35). 92

93 Fig Press Yes to delete the selected position from the order. Press Delete all button to open the window with request (Fig. 3.36). Fig Press Yes to delete all positions from the order. In the lower part of General application window there is a group of radio buttons for order form mode selection. Check MS Excel radio button to save the data in format of the selected program. Check HTML radio button to save the data in HTML format. Check Text radio button to save the data in text format. After order form saving format selection press Order button. If MS Excel format is selected Excel book sheet, containing order form table opens (Fig. 3.37). Fig Generated order can be edited and printed using MS Excel program resources. If HTML saving format is selected Save as window will be displayed. In this window the file name shall be entered and the folder where it will be saved shall be selected. Press Save button to save the order file with the entered name in the selected folder. 93

94 If text format is selected for the file saving the operation is similar to the previous case but the file is saved in *.txt format. Let us continue consideration of tools of catalog structure display area. Figures Button Figures tool contains the drop-down list of illustrations which are located in the current electronic catalog, and Part Description command. The drop-down list for the considered electronic catalog is shown in Fig Fig The considered catalog contains Manual control panel - Illustration with callouts illustration. Select the name of the illustration to view it in the illustration area. When Part Description command is selected catalog card for the selected catalog position is displayed in illustration area. Remark: Catalog cards are displayed only if Use cards parameter was set in Catalog menu when the catalog was created in TG Builder module. Tool for same-name callouts viewing tool is used to set callout navigation and perform same-name callout navigation. The text of the pop-up help depends on the last selected value. In catalog structure area select any cell of ICS-RADIO switch line. Herewith in the right window in the illustration the corresponding callout will be highlighted (Fig. 3.39). 94

95 Fig tool contains the drop-down list of commands (Fig. 3.40). Fig The Next, First and All commands are used to navigate same-name callouts if there are several positions with the same number on the illustration. Select The Next command, herewith the next callout 9, relating to ICS-RADIO switch position will be current (Fig. 3.41). 95

96 Fig Select First command to make the first same-name callout the current one. Select All command to make all callouts with the same number the current ones. Remark: When exiting TG Browser module the program will save the last command used at the same-name callouts viewing. At next TG Browser run the last command selected during the last operation session will be used. Search a position command is used to search the current position in all illustrations. Select Next in all figures command to search the next position from the several same-name ones in all illustrations. Subsequent selection of the same-name callouts when going to the next illustration is performed at selection Next command. Select Memorize the action command if selection of First or All same-name positions when going to the next illustration is required. Options Tool Options button contains the drop-down list of commands (Fig. 3.42). 96

97 Fig Always Show figures command controls illustration display. If this command is selected then on the screen there is an illustration area, if it is not then the catalog structure area is wider because of that. Show callouts command controls the callout display on the illustration. If it is selected then callouts are displayed on the illustration regardless of illustration sheet properties. If the command is not selected then callouts are displayed only if when the illustration was created Display callouts parameter was set in sheet properties. Select Link bar menu item to open the link bar. If this item is selected in the lower left part of the catalog structure display area the link bar will be displayed (Fig. 3.43). Fig If there is a reference left-click at it to go to the data module, specified in the reference. 97

98 Let us return to the drop-down menu of Options button. If Parts list snap bottom menu item is selected the catalog structure area will be displayed under the illustration area. If Highlight item with applicability command is selected the applicable catalog positions will be highlighted with color. If Use different colors command is selected the positions with different applicability will be highlighted with different colors (Fig. 3.43) Illustration area Catalog card viewing For each catalog position a catalog card is formed automatically, the mode of which is set when catalog template is created in TG designer module. Catalog cards are displayed only if Use cards parameter was set in Catalog menu when the catalog was created in TG Builder module. To view a catalog card perform the following: 1. Select catalog position. 2. In illustration area go to Catalog card tab or select Part description command in the dropdown menu of Figures button. As a result a catalog card for the selected position will be displayed in the illustration area (Fig. 3.44). Fig In the considered example the catalog card for Mini-stick position contains four attributes: Description; Part number; 98

99 NSN; NCAGE. Illustrations with callouts viewing Let us continue working with Electronic catalogues Manual control panel data module. To view the illustration with callouts inserted in the EC, in illustration area go to 1. Manual control panel - Illustration with callouts or select the corresponding item in the drop-down menu of Figures button (Fig. 3.45). Fig The numbers of callouts to illustration should coincide with Item number catalog field value for the corresponding elements. Matching of catalog specification with information in the illustration is provided for convenient navigation within the catalog while viewing. When selecting a cell of any position number in the catalog table, a corresponding callout in the illustration will be highlighted, and vice versa. In Fig in catalog structure area position 1 is selected and the corresponding callout is highlighted in the illustration area. On the illustration there are two positions with the same number 9. To navigate the same-name callouts use tool. Callout selection is performed with the help of the commands of the dropdown list of button. For information about the same-name callouts see section Project structure display area. 99

100 In the upper part of the illustration window there are tools for illustration viewing which are given in section Tools for illustration viewing Search in catalogs When a catalog template of Electronic list (S1000D IPD DM) type is created in TG Designer Name and Identification mandatory fields with indices are created automatically. When the catalog with indices is exported from TG Builder module all names and identifications are saved into a separate file so search in catalogs is performed faster than usual. To perform search in electronic catalogs perform the following: 1. Open Operation in TG Browser demonstrational project for viewing. For that purpose run TGBrowser.exe file in the folder with the demonstrational project. 2. In TG Browser window in the drop-down menu of Search button select Search in catalogs item (Fig. 3.46). Fig In the left part of TG Browser window next to Structure tab Search in catalogs tab will open (Fig. 3.47). Fig Before entering the parameters select the settings. For this purpose press Search options button select Search in catalogs item and select parameters for the search (Fig. 3.48). 100

101 Fig Return to Search in catalogs tab. Select the attribute name where search is performed in the first place. For this purpose in By attribute drop-down list select, for example, Name (Fig. 3.47). 6. In Find field enter symbols sequence for search switch. In the window the list of found positions will be displayed. 7. If one of the found positions is selected in the lower part of the window the code and the name of the electronic catalog data module where the selected position was found (Fig. 3.49). Fig In the lower right part of the tab press Go to data module button. In the viewing window to the right the electronic catalog content will be displayed. The selected position is highlighted in the catalog table (Fig. 3.50). 101

102 Fig To perform search in the found results to the right of Find input field press Show panel for search in found button and repeat the described above operations for Identification attribute (Fig. 3.51). Fig To prepare the search tab in the catalogs for new search, press Clear entry fields button to the right of By attribute entry field. 102

103 Remark: Search in found should not be performed if the symbols sequence for search in the first attribute is not set Maintenance planning data modules viewing The maintenance planning data modules give information to facilitate planning and management of aircraft maintenance. The data include operating conditions, scope, and sequence of operations Time limits information type data module viewing To start working: 1. Open Operation in TG Browser demonstrational project for viewing. For that purpose run TGBrowser.exe file in the folder with the demonstrational project. 2. In Structure tab in Scheduled/Unscheduled maintenance folder select [BR-A A-000A-A] Time limits Additional 8АТ fuel tanks DM (Fig. 3.52). Fig Service tables are displayed in the upper part of the viewing area if in Settings window ( tool) Add service tables parameter is selected. Under Time limit information heading there is a table containing the information about time limits of fuel system components. 103

104 Above the data module content viewing window there is an area containing the information about the viewed data module version. For information about this area see section 2.4 Data module information display area. Under the information area about the DM version there is a toolbar (Fig. 3.53). Fig For detailed information about the tools description see section Tools for data module content viewing Maintenance inspection type data module viewing In Structure tab in Scheduled/Unscheduled maintenance folder select [BR-A A- 000A-A] Periodic maintenance 300 flight hours DM (Fig. 3.54). Fig Remarks: 1. The reference table will be displayed in the document only if in Document tab of Settings window Add service tables and Show reference table in schedules ( tool) are selected. 2. References from the data module lead to procedures of the demonstrational project. In a real project these references shell lead to the procedures in which corresponding work performance is described. 104

105 In the upper part of the viewing area the following information is displayed: Task group name 27. Flight controls. Operation conditions 300 ± 50 flight hours. Description The operations are performed every 300 flight hours, unless unscheduled reloading operations were performed during this period. Below there is a table containing two columns: Data Module. Task. In Task column there is a list of required tasks. In Data module column there are references to the data modules of Procedure type, containing the information about task conditions and execution. All elements of Data module column are displayed as references regardless of the fact if there is such data module in the viewed publication or not. Left-click at the reference in Data module column to go to the data module, describing the task execution procedure. Above the data module content viewing window there is an area containing the information about the viewed data module version. For information about this area see section 2.4 Data module information display area. Under the information area about the DM version there is a toolbar (Fig. 3.55). Fig For detailed information about the tools description see section Tools for data module content viewing Procedure viewing Procedure is a document which contains the information necessary for maintenance tasks of the equipment. To start working: 1. Open Operation in TG Browser demonstrational project for viewing. For that purpose run TGBrowser.exe file in the folder with the demonstrational project. 2. In Structure tab in Procedures folder select [BR-A A-362A-A] Checking air pressure in landing wheel tire DM. In the right window the message with Warning or Caution units will be displayed (Fig. 3.56). 105

106 Remark: To view the DM content without showing this message in Settings window ( tool) uncheck the flag of Show warnings/cautions for the entire datamodule parameter. Fig To start data module content viewing press OK button to confirm the reading of the warnings. Then in the right window the data module content will be displayed (Fig. 3.57). 106

107 Fig Above the data module content viewing window there is an area containing the information about the viewed data module version. For information about this area see section 2.4 Data module information display area. Under the information area about the DM version there is a toolbar (Fig. 3.58). Fig For detailed information about the tools description see section Tools for data module content viewing. For convenient viewing of the data module content use Scale tool which allows setting the scale of the data module viewing in the display window. Scale value is selected from the drop-down list or typed from the keyboard. 107

108 In the upper part of the DM content viewing area there is a reference service table. Service tables are displayed if in Settings window ( tool) Add service tables parameter is selected. In the considered module there is one reference to the data module with information about fire safeties. To transit via the reference left-click at it. Further in the form of a table, preliminary requirements, containing the following data are displayed: Production management data. Required conditions. Required persons. Support equipment. Materials and expendables. Spares. Safety precautions. Under Procedure heading the maintenance procedure is described by steps. To go to the next task viewing use lower part of the window. Start-Back-Forward-End tools in the In the end of the DM the close-up actions are described. In the upper part of the viewing window there is a toolbar with the help of which the information included in the procedure in Preliminary requirements tab can be viewed (Fig. 3.59). Fig Brief description of the tools is given in Table 3-5. Table 3-5 Button Description Production management data. Displays the window with the item data. Required persons. Displays the window with the required persons data. Support equipment. Displays the window with the support equipment data. 108

109 Button Description Support equipment (optional). Displays the window with the optional support equipment data. This button is displayed on the panel if it is set in project properties. Materials and expendables. Displays the window with the consumables data. Spares. Displays the window with the spares data. The tools become active if the information is filled in the corresponding sections. Select the tool to open the window containing the data Data module of Fault isolation procedure type viewing General Information Data module Fault isolation procedure is a document containing: fault isolation procedure description; data necessary for fault isolation; references to fault isolation procedures. To start working: 1. Open Operation in TG Browser demonstrational project for viewing. For that purpose run TGBrowser.exe file in the folder with the demonstrational project. 2. In Structure tab in Fault isolation procedure folder select [BR-A A-428A-A] Fault isolation procedure landing gear wheel failure DM. In the right window the message with the warnings entered in preliminary requirements (or with all warnings, depending on the settings) will be displayed (Fig. 3.60). Fig

110 3. To start data module content viewing press OK button to confirm the reading of the warnings. Then in the right window the data module content corresponding to the on-line viewing mode will be displayed (Fig. 3.61). Remarks: To set the special units display while viewing the DM, in Settings window ( tool) in Document tab select Show warnings/cautions on datamodule opening parameter. If Show warnings/cautions for the entire datamodule parameter is selected then when the DM is viewed ALL Caution and Warning units including those specified in technology steps and search procedure are displayed. Fig If in the viewed data module the diagram is not created then text task description which should be performed at the first step is displayed. 110

111 Above the data module content viewing window there is an area containing the information about the viewed data module version. For information about this area see section 2.4 Data module information display area Interactive mode viewing In the upper part of the diagram the object corresponding to the actions at the first step of the fault isolation procedure is selected. Under the diagram the question is displayed which should be answered for fault isolation. Under the question the variants of answers are given. Double click the rectangular of the required answer to select it. Select Between 900 kpa and 950 kpa answer. Then a transition to the corresponding procedure step will be performed. In the upper part of the window the diagram object with the task description which should be performed at the first step will be highlighted, in the center part the question which should be replied for fault isolation will be highlighted, in the lower part possible answer variants will be highlighted (Fig. 3.62). 111

112 Fig

113 If Yes answer is selected you the transition to the corresponding procedure step will be performed (Fig. 3.63). Fig

114 From this step you can go to close-up actions viewing, to the selection variants at the first step or go to the failure description viewing. Right-click the diagram object to open the reference list (Fig. 3.64). Fig In the considered example step 4 has an external reference to the DM and the cross-reference to the illustration embedded in the viewed DM. Press the illustration reference to open the illustration viewing window. Press the external reference to go to the data module specified in the reference. To transit between the steps you can use the toolbar which is to the right in the upper part of the DM content display area (Fig. 3.65). Fig The panel tools description is given in the following table. Table 3-6 Tool Description Go to fault description. Back. List of viewed steps. Forward. End. 114

115 The tools allow performing transition between steps in both directions. The drop-down list of viewed steps allows returning to the previously viewed step. To the left in the upper part of the DM content area the failure code and the current step number are displayed (Fig. 3.66). Fig Above the display area of data module content there is a data module toolbar for the diagram display (Fig. 3.67). Fig The panel tools description is given in the following table. Table 3-7 Tool Description Zoom out button is used to minimize the size of illustration with increment of 25 %. Scale tool is intended to change the illustration scaling at viewing. It is selected from the drop-down list or typed manually. Zoom in button is used to increase the size of illustration with increment of 25 %. Navigator tool allows viewing large illustrations in parts with all details. When this tool is selected additional Navigation window will be displayed. The on-line mode of fault isolation procedure viewing provides a visual (graphical) representation of isolation procedure. For detailed consideration of actions at the certain procedure step it is convenient to go to the mode of fault isolation procedure viewing Fault isolation procedure viewing The mode of fault isolation procedure viewing is activated by double left-clicking at the diagram object or pressing Search procedure icon in the upper part of the window. In the considered example transition to this viewing mode from the first step of the fault isolation procedure is shown. In the upper part of the viewing window the description of actions at the first procedure step is displayed (Fig. 3.68). 115

116 Fig This viewing mode of the data module of Fault isolation procedure type is similar in many ways to the procedures viewing. In the fault isolation procedure description at the certain step remarks, 116

117 warnings, tables, illustrations and so on connected with this step are displayed. As for certain features cross-reference to procedure steps, for example in lines 2.1, 2.2, 2.3, should be noted. At setting cursor at the reference it will take a shape of forefinger. Left-click to go to the selected step. The line with the selected step will be visible after the transition. In the upper part of the viewing area which is visible at document scrolling there are the following tables (Fig. 3.69): Fault codes. References. Tables with the information about preliminary requirements. Fig

118 Service tables are displayed if in Settings window ( tool) Add service tables parameter is selected. Fault codes table contains the fault code and fault description. References table contains the list of all external references. In Preliminary requirements table group item data, required conditions and circuit breakers, support equipment, consumables and spare parts are entered. Further safety conditions during fault isolation procedure specified. Above the display area of data module content there is a toolbar (Fig. 3.70). Fig For detailed information about the tools description see section Tools for data module content viewing Additional data viewing In the upper part of the window there are tools which help to view the information concerning additional data (Table 3-8). The tools are available in any DM viewing mode. Table 3-8 Button Description Production management data. Required persons. Support equipment. Materials and expendables. Spares The tools become active if the information is filled in the corresponding sections. Select the tool to open the window containing the required data. 118

119 3.8. Viewing data modules taking into account their applicability General Information Applicability mechanism is used to create a set of documents for several configurations of the item. Various configurations are displayed during documentation viewing based on filtering rules regarding applicability. Applicability is data module property, consisting in relation to a particular group or nomenclature of items, or valid under the certain operational conditions. DM applicability is determined by specification of the following elements: final item serial numbers, which DM information covers, for example, item No , item No ; other information specifying DM application, for example, operational or any other conditions, effecting technical data, so as climatic conditions, atmosphere dust content, etc. You can specify applicability for DM version and its content paragraph, object (table, illustration and etc) or part of the object. Applicability specified for the whole data module is always applied to all parts of its content. However, it is necessary to specify applicability in more detail within content section, than for data module as a whole. Any remarks on applicability specified in content part shall be covered by applicability specified for data module. To enter applicability to the content section not covered by applicability, specified for data module, is prohibited Document display filtering regarding applicability At viewing the data modules with set applicability the system provides an option of hiding information which does not relate to the selected applicability that is to filter the information. To start working: 1. Open Operation in TG Browser demonstrational project for viewing. For that purpose run TGBrowser.exe file in the folder with the demonstrational project. 2. In Structure tab in Descriptive modules folder select BR-A A-040-A-A Descriptive DMs Hyperlink" DM. The data module content with set applicability s are shown in Fig

120 Fig On the shortcut with the data module version parameters there is indicating that applicability is set to this DM version. icon-cross In the upper right part of DM information area applicability (filter) for the viewed data module element display is displayed. All applicability is selected by default. In the data module content area text fragments corresponding to different item serial numbers are highlighted with different colors. The system provides an option of filtering the displayed elements by the item copy. To select the filter perform the following: 1. Press Change applicability button. Herewith Applicability settings window will open (Fig. 3.72). 120

121 Fig From the drop-down list of Item field select Test machine No. 2 item copy. In the list the item data book information is given. 3. Press button. The set applicability will be displayed above the DM viewing window (Fig. 3.73). Fig Applicability display format is the same as in the item copy data book [Name] ([Attribute]) [Description]. When such applicability filter is used the displayed data module content will change. In the considered example text fragments with applicability different from that selected in the filter are displayed (Fig. 3.74). 121

122 Fig If the applicability set for the current data module version does not correspond to the applicability set for this data module display filtering then system warning Version does not conform with selected applicability will be displayed above the DM viewing window Viewing of data modules during TG Browser run from TG Builder module For information about TG Browser run from TG Builder module see section TG Browser running from TG Builder module. When running TG Browser, select Operation in Browser project from the list of developed projects. Then TG Browser program window with Descriptive DMs Fire safeties data module will open (Fig. 3.75). 122

123 Fig The operation in data module viewing window is described in the previous sections of the guide. Now only possibility to go to viewed data module editing will be given. For this purpose press Edit version button on the project structure area toolbar or press F4 key on the keyboard. After that the editor of the data modules of corresponding types will be loaded. In the considered example it is the descriptive data modules editor (Fig. 3.76). Operation in the editors is given in the corresponding chapters of EOD software module 2.6 User Guide. Remark: The data module will be available for editing only if the user is considered as the originator. 123

124 Fig Enter the required changes and close the editor window. Then you will return to TG Browser window Multi-publication viewing The possibility of viewing of several interacted publications exported from TG Builder module in PDB format in one program is implemented in the program. This possibility is used when there are several publications from different originators which are interacted, including the references. If it is necessary it is possible to transit from one publication to another via references. multi-publication is a publication combination created according to certain rules allowing the possibility to operate with them as a whole one. To view several publications it is necessary to create an multi-publication using TGMultipubCreator.exe utility Multi-publication creation and editing Multi-publication creation Perform the following to create a multi-publication: 1. Create a folder on the hard disk. 124

125 2. Copy publications in PDB format which should be included in the multi-publication into this folder. 3. Run TGMultipubCreator.exe utility file. Then Multi-publication creation window will open (Fig. 3.77). Fig Select Specify a directory...command in File menu (Fig. 3.78). Fig In Browse window select the folder with the publications and press OK. Then the publication list will be displayed in Multi-publications creation window (Fig. 3.79). Fig Remark: If Code field for the publication is not filled it was received by project export. In this case the publication originator shall specify the publication code for its subsequent entry into the corresponding field (see section Publication parameters editing ). Publication code is required for creating references among publications included in the multi-publication. 6. To save the multi-publication in File menu select Save multi-publication (or press key combination CTRL+S on the keyboard). Herewith in multi-publication folder multipub.xml file is created which contains the information about publications (name, code, version number, development organization, user organization, issue date, security classification), and also about the folder where the publication is. 125

126 7. To exit Multi-publications creation window in File menu select Exit command. Multi-publications loading To load a multi-publication perform the following: 1. Run TGMultipubCreator.exe utility file. Then Multi-publication creation window will open. 2. In File menu select Open multi-publication (or press key combination CTRL+O on the keyboard). 3. In Browse window select the folder with the publication and press OK button. 4. Then the multi-publication will be loaded and in Multi-publications creation window the list of publications included in it will be displayed (Fig. 3.79). The information about the multi-publication is taken from the given metapub.xml file. If after multipublication creation a new publication is added to its folder then the information about it will not be displayed in the utility window after multi-publication opening. Multi-publication editing Perform the following to edit a multi-publication: 1. Run TGMultipubCreator.exe utility file. 2. Open a multi-publication. 3. Select Publication menu. Then drop-down menu opens (Fig. 3.80). Fig Let us consider the menu commands in detail. Publication addition To add the publication to the multi-publication: 1. In Publication menu select Add command (or press INS key on the keyboard). 2. In opened Folder selection window select the folder with the required publication and press OK button. Then the folder with the selected publication will be copied to the folder with the multi-publication, and the information about the publication will be added to Multipublications creation window. 3. To save changes in File menu select Save multi-publication command. 126

127 If the utility window is closed without preliminary data saving a request to confirm saving of changes will be displayed. If Yes is selected, the window will be closed and all changes will be saved. If No is selected, the window will be closed without saving changes. Cancel reply will enable to continue editing. Publication parameters editing To edit the parameters of the publication included in the multi-publication: 1. Select the publication parameters of which should be changed. 2. In Publication menu select Edit command. Then Publication parameters window will open (Fig. 3.81). Fig In Identification (code) entry field enter BU-C In Issue number entry field enter the publication issue number. 5. To confirm the changes press Apply button. Deletion the publication from the multi-publication To delete the publication from the multi-publication: 1. Select the publication to be deleted. 2. In Publication menu select Delete command (or press DEL key on the keyboard). Then a request to confirm deletion from the disk Do you want to erase directory containing the publication while deleting? will be displayed. Select Yes to delete physically the folder with the publication from the disk. Select No to delete the information about the selected publication from the multi-publication, but the folder with the 127

128 publication will remain on the disk. Select Cancel to keep the publication a part of the multipublication. If the publication was deleted from the disc by OS Windows tools, then after opening of the multipublication the deleted publication will be highlighted with color (Fig. 3.82). Fig When trying to save such a multi-publication the window with the message Some publications are not available in the directory. Do you want to save the multi-publication? will be displayed. Select Yes to save the multi-publication with the missing publication. Select No to close a warning window. Then you will return to Multi-publications creation window. To correct the situation delete the nonexistent publication from the multi-publication. Data modules list for the publication creation Let us return to Publication menu (Fig. 3.83). Fig When Create data modules list for the publication menu command is selected in the folder of the selected publication dmlist.txt file is created which contains the information about the data modules included in the publication. This file is required for transition via references from one publication included into the multi-publication to other ones. Without dmlist.txt file creation the reference mechanism will not work. For description of references transition refer to Sections Transition via references from publication data modules to other publications and Transition via references from publication data modules to other publications data modules. Data modules lists for all publications creation When Create data modules list for all publications menu command is selected in the folders of all publications included in the multi-publication dmlist.txt files are created. 128

129 If dmlist.txt file has already been created in the publication, the window with the request A list of data modules has been created for given publication. Do you want to create it anew? will be displayed. Select Yes reply to create dmlist.txt file for the publication again. Select No reply to keep the existing dmlist.txt file for the publication. Select Yes for all reply to create dmlist.txt files for all publications included in the multipublication (if they have already been created). Select No for all reply to keep dmlist.txt files for all publications included in the multi-publication (if they have already been created) Multi-publication viewing Perform the following to view a multi-publication: 1. Copy TGBrowser.exe file form any publication to any folder with multi-publication. 2. If any publication contains the data module of Fault isolation procedure type then for viewing it is required to copy Required folder on the upper level (where metapub.xml file is located). 3. Run TGBrowser.exe file to open Selection of publication to be loaded window (Fig. 3.84). Fig Select the publication for viewing and press Apply button. Then TG Browser window with the selected publication will open. Remark: In Selection of publication to be loaded window the columns width can be set. The system will save the settings and at next calling the columns will have the selected width. There are three differences from normal technical publication viewing: 1. The possibility of switching between the publications included in the multi-publication. 129

130 2. Transition via references from the data modules of one publication to other publications of the same multi-publication. 3. Possibility of transition via references from the data modules of one publication to the data modules of other publications of the same multi-publication. Publication switching To view another publication press Publication selection button which is displayed on the toolbar when the multi-publication is viewed or press the key combination CTRL+ALT+S. In the opened Selection of publication to be loaded window select the publication to be viewed and press Apply button (Fig. 3.84).). Transition via references from publication data modules to other publications There is a possibility of transition via reference from one publication data module to another publication. To perform the transition via reference: In publication data module a reference to another multi-publication publication shall be set. The reference is set when the data module in TG Builder module is created. The publication code specified in the reference and the code in the referenced publication parameters shall match. If an exported project is included in the multi-publication, the originator shall give the information about the code, which shall be entered in the publication parameters (see section Publication parameters editing ). In the publications data module lists dmlist.txt files shall be created (see sections Data modules list for the publication creation and Data modules lists for all publications creation ). To view another publication in data module content window left-click at the hyperlink. Then a window with a request to confirm the transition to the publication will be displayed. Select Yes reply to transit via hyperlink to another publication data module. Please, note that some time shall be required to load the publication especially if the publication is large and the computer where the operation is performed is not very high-power. Select No reply to return to the current data module viewing. Remark: Window with request to confirm the transition to another publication will be displayed only if in Settings window in Other tab a switch Ask for confirmation while switching to another publication is on (see subsection Ask for confirmation while switching to another publication of section ). Transition via references from publication data modules to other publications data modules There is a possibility of transition via reference from one publication data module to another publication data module. To perform the transition via reference: In publication data module a reference to another publication data module shall be set. The reference is set when the data module in TG Builder module is created. 130

131 In the publications data module lists dmlist.txt files shall be created (see sections Data modules list for the publication creation and Data modules lists for all publications creation ) Print-out In this section a program possibility to print out whole technical publication or its part is considered. The following can be printed from TG Browser dialog window: Whole publication. Publication structure element section, data module. Open print settings window by Print button pressing on the control panel. The window mode depends on the structure element which is selected for printing. If in the structure window the data module was selected, then the following print settings window will be displayed (Fig. 3.85). Fig If in the structure window an element different from the data module was selected the whole publication or section, then Batch print window with the possibility of language selection (Fig. 3.86). 131

132 Fig Press button in Batch print window to close it and cancel the printing. Press Print button to open Print window which is shown in Fig. 3.85, but without button. Print preview is possible only for the data module. Language selection in Batch print window affects the headers language and other service information required by ASD S1000D standard. Develop DMs in the selected language to print out DMs content in this language Print settings Print dialog window contains three tabs: Print Options. Headers Settings. Advanced Settings. Print Options Tab The general view of the tab is shown in Fig

133 Fig Logically and visually the tab is divided into three units: Select paper size. Print on both sides. Pages. Remark: Templates field and the buttons next to it are not active. In this program version they are not used. Let us consider the units of Print Options tab in detail. Select paper size Unit It is possible to select sheet format to be printed in Select paper size unit А3 and/or А4. For this purpose check the corresponding flags. You can select an individual printer from the list of available printers for each format. The list of available printers depends on the printers installed in your system. 133

134 Remarks: 1. The same printer cannot print sheets of different formats simultaneously. If the document contains А4 and А3 sheets, the individual printer shall be selected for each format or sheets of different format shall be printed in two steps. 2. Printing on sheets of А3 format is possible only for illustrations and tables with headings, if it is directly specified in their properties when technical documentation project was developed in TG Builder module. 3. But in all cases simultaneous printing of both formats sheets is possible. Each printer is set by corresponding button pressing. The printing can be performed as by physical printer (local or network), so by special built-in virtual PDF-printer, which is the last in the list of available printers (Fig. 3.88). The result of such printing is pdf-file created on disk. Fig If you apply built-in PDF-printer, special dialog of the printer properties setting is used. This dialog is activated by Properties button pressing to the right of the drop-down list with list of printers (Fig. 3.89). Fig This dialog allows setting the following parameters: Document resolution (DPI). Whether to open created pdf-document after creation in the program for viewing installed in the system. Whether to add data module codes to the sections names in pdf-document heading. 134

135 Dpi (resolution) parameter value effects quality of illustrations pasted to the document. The higher value of this parameter, the higher quality of illustrations, therefore it leads to increase of pdf-file size. If it is planned to print this document, the recommended value of dpi parameter = 300. Print on both sides Unit System provides the option of the document duplex printing. If the set printer supports duplex printing at the drivers level, check Print on both sides flag, and select the required settings in printer properties. If printer supports duplex printing at physical level, you need not specify Print on both sides parameter in print settings window; it is enough to set the printer properties. If the printer doesn t support duplex printing, proceed as follows for duplex printing: 1. In Print Options tab check Odd pages radio button. 2. Print-out all odd pages of the document. 3. Put all printed odd pages with blank sides up, without turning the sheets. 4. Check Even pages radio button and Reverse printing parameter. 5. Print-out all even pages of the document. Depending on the document binding type at duplex printing you can specify such parameters as headers mirror reflection, headers and footers printing for empty even pages before illustrations and headers and footers printing at the last even page. Let us consider these parameters in more detail. Mirror printing section contains two parameters: Page header. Page footer. Force header printing for section contains two parameters: Last even page. Empty even page before image. Flag checking at Use as specified chapter in headers leads to adding empty pages with headers after the last DM odd page. If Empty even page before image flag is checked then headers and the inscription The page is intentionally left blank in the middle of the pages will be printed on empty even pages before EC illustrations. If the flag is unchecked then headers and the inscription will be printed only on empty even pages after EC cards. Empty even pages before EC illustrations will remain entirely empty. To select and cancel all selected properties of duplex printing use and buttons. Pages Unit The name of the unit reflects its purpose: use its parameters to define the pages which are to be printed. All pages radio button is checked by default. 135

136 Selected pages radio button becomes available only at data module printing. You can set a range of page for printing in the input field. Odd pages and Even pages radio button were given when duplex printing was described. If Even pages radio button is checked Reverse printing switch becomes available. Setting of the data module pages numbering at printing, starting with the specified number is possible. For this purpose set the number starting with that, from which the pages will be numbered, in the lower right part of Number pages from section. It can be done in two ways: enter an initial number from the keyboard or use more-less arrows to the right of the entry field. Page Header Setup Tab In Print window go to Header Settings tab (Fig. 3.90). There is an option to enter required information in headers and footers for printed data modules. To get access to advanced settings check a flag at Use Advanced settings. Then Advanced settings button will become active (Fig. 3.90). Fig Press Advanced settings button to open Page Header Setup dialog window (Fig. 3.91). 136

137 Fig Window contains Options tab consisting of two sections: Header. Header parameters are set in this section. Footer. Footer parameters are set in this section. Header Header section contains 4 one-type control elements intended for input of information to the header (Fig. 3.92). Fig Two control elements of Running head section are shown in Fig If <Empty> value is selected from the upper field list, so the control element looks as shown in Fig Two control elements of Header section are shown in Fig. 3.91). Fig Two left control elements in Header section refer to two lines of the header, being centered, two right elements to two lines of the header, being aligned right. If you select <Empty> value for one or both central lines, a corresponding line, aligned right, can occupy all the space of the header. This gives an option to place long lines. Let us consider the control element in detail. It consists of four fields (Fig. 3.94). 137

138 Fig The button to call font style setting dialog. 2. Drop-down list for element type selection. 3. Text-help for field No Text input field or formatting lines. If Empty value is set in 2 field, so 1, 3 and 4 fields will be hidden. It is shown in Fig Let us consider all the fields of control element. Font style settings ( 1 field) If you press 1 field, which is the button actually, Element style window appears (Fig. 3.95). Fig All inscriptions are always printed with Arial font, and the name of font cannot be set. In Element style window you can perform the following: Set Arial Font size. In Font size entry field you can enter the font size from the keyboard with the range of 8 20 pt. If the entered value does not match the permissible range, an alert window will be displayed. Set font pattern style, having selected any combination of values Bold, Italic, Underline. You can select none of the values, so the corresponding line will be printed with standard font. To save changes press button. Pressing of button leads to window closing without saving changes. Information on current settings will be displayed on the button after closing the dialog as number font size and combination of Latin letters B, I, U, meaning the font pattern style semi-bold, italics, underlined. 138

139 Element type ( 2 field) Let us consider the next field of control element. After pressing button to the right of field 2, the elements drop-down list opens (Fig. 3.96). Fig Element type determines the value, which will be entered to the specified adjustable element. The list of available elements is the same for all lines both in header and in footer. The user is responsible for selected type value correct fitting in a corresponding header area. If the text is too long, it can lead to the header sizes transformation. As a result headers may fail to match the parameters given in ASD S1000D specification. It is recommended to perform printing test for sheet at a physical or virtual printer to make sure printing presentation is correct after selection of values in fields 2 of all header lines. Selection of element in field 2 determines handling mechanism for the value entered in field 4. Text-help, text or format input field (fields "3 and 4 ) Let us consider the following fields of the control element. Fields 3 and 4 values depend on the element selected in field 2. If Text element is selected, text-help (field 3 ) contains Text line, and text to be printed in the corresponding line of the header is entered to field 4. For all other elements field 3 contains Format line, and formatting line is entered in field 4. It will be used when printing the value selected in element field 2. Formatting line is interpreted as follows: 1. If formatting line contains %s macros, formatting line is used as element, where the selected value is substituted instead of the first macros inclusion. 2. If the line contains more than one %s macros, all macros starting from the second are substituted with empty lines. 3. If %s macros is not available in the line, output line is generated by concatenation (composition) of formatting line followed by object value (formatting line actually becomes a prefix). This variant is an equivalent of formatting line, in which %s macros is located at the very end. If formatting line is empty (default value), output line is element value selected in field

140 Examples: Project name value is selected in field 2 as object type. The current project has Test project name. Table contains variants of output line depending on formatting line. Remark: In the given examples inverted commas in formatting lines are used only to identify formatting line limits and are not the part of it. Table 3-9 Formatting line Output line (empty line) Test project %s Project:» Project: %s Project: (%s) Test project Project: Test project Project: Test project Project: (Test project) Project: (%s) (%s) (%s) Project: (Test project) () () Header section contains organization logotype, if it has been specified in the project template at the stage of its creation. Footer Footer section of Page Header Setup window contains two control elements similar to the elements of running head (Fig. 3.97). Fig One of control elements is located under the data module code. The line determined by this element is aligned right. The second control element is located in the bottom. The line determined by this element is centered. 140

141 Besides control elements the section contains fixed elements, for example, End of data module inscription. Customizing profiles Remark: Customizing profiles tool is not available when TG Browser is run from the folder of exported project. For more convenient operation with headers settings, the system provides an option of their saving. Headers customizing profile a combination of values of all customized elements of headers. Customizing profiles control elements are located in the lower left corner of Page Header Setup window (Fig. 3.98). Fig Customizing profiles are intended for quick settings customizing. Selection of any element from Customizing profiles drop-down list leads to corresponding settings loading. System and user profiles are available. System profiles The system profiles are as follows: By default. Contains settings according to ASD S1000D specification. Last used. Contains settings saved after the last pressing of button in Page Header Setup window. 141

142 Publication settings. This profile is available only at publications printing. Contains settings entered to the publication properties. Users cannot change or delete system profiles. The rest are user profiles. User profiles All user profiles are available for all projects within a specific database. Thus, you can set the required profiles once and use them in all projects. User profiles can be created, modified or deleted only by users with Administrator and Project manager privileges. Users with other privileges can use profiles in read only mode. Actions button is intended for operation with profiles. If you press it, drop-down menu is displayed (Fig. 3.99). Fig Remark: Items not available in the present situation are highlighted light grey. Save and Save as commands are used to save current settings to the user profile. When Save command is selected a request to confirm saving the changes will be displayed. Press Yes to save the profile with new values. When Save as command is selected a window for entering the name of the saved profile will be displayed (Fig ). Fig Delete command is used to delete the user profile. 142

143 Export and Import items are used to save and load the current settings to file (from file). At export xml file with the settings is created. This file can be used later for importing to the other database. Import leads to modification of current settings and does not change saved user profiles. Since modification of user profiles stored in database is available not for all users, but only to users with specific privileges, export/import mechanism can be used for creation of local library of user settings. Advanced Settings Tab In Print window go to Advanced Settings tab (Fig ). Fig It is recommended to select the following options in Advanced Settings tab for correct printing according to ASD S1000D standard (Fig ): Process Sub/Super scripts sequence: Sub/Super scripts sequence. Super/Sub scripts sequence. Additional spacing after every fifth row. 143

144 Additional binding fields parameter is disabled by default in the current version of the program according to the requirements of ASD S1000D standard. This switch is active, but its activation and deactivation results in no changes. This mode is used in some special cases upon customer s request. It will not be considered in the present guide. In case dangling headings are found in the document, check the flag at Additional footer area parameter. Herewith Area sizes (pixels) input field becomes available, in the field a value can be set directly from the keyboard or using more-less arrows. Print empty paragraphs flag is not checked by default, i.e. empty paragraphs are not printed. If for some reason empty paragraphs shall be printed, check the flag at Print empty paragraphs parameter. Swap Warning - Caution captions (russian) parameter should be used when documentation developed in EOD software module version 2.2 and earlier is printed. Print setting with service information forced reduction is possible. For this purpose select Don t print footers (page numbers only) parameter. If Check security parameter is selected: If all documents are unclassified, so classification will not be printed in the headers. If both classified and unclassified documents are available, classification will be printed in the headers Document preview To preview the data module press button in the lower part of Print window before printing. Herewith Viewing before Printing dialog window will open (Fig ). 144

145 Fig