TG Designer - CALS · TG DesignerTG DesignerTG Designer

TG DesignerTG DesignerTechnical Guide Designer 2.6

User Guide

TG Designer 2.6 User Guide

Contents

3

Contents

CHAPTER 1. INTRODUCTION .........................................................................................9

1.1. Software Requirements ............................................................................................................9

1.2. Hardware Requirements ........................................................................................................10

1.3. Template of Technical Documentation Project....................................................................10

1.4. Getting Started ........................................................................................................................11

1.5. New Template Generation .....................................................................................................13

CHAPTER 2. CODING SYSTEM DEVELOPMENT ........................................................16

2.1. Getting Started ........................................................................................................................16

2.2. New Coding Scheme Creation ...............................................................................................17 2.2.1. Coding Scheme Implementation........................................................................................18

2.3. Code Segments List Creation.................................................................................................20

2.4. Code Segments Structures Development ..............................................................................22 2.4.1. "Standard Numbering System Code" Code Segment Structure Development ..................22

"System difference code" code field addition..........................................................................22 "System code" code field addition ...........................................................................................27 "Sub-system code" code field addition ....................................................................................33 "Unit code" code field addition................................................................................................39 System difference code application .........................................................................................41

2.4.2. "Disassembly Code" Code Segment Structure ..................................................................42 2.4.3. "Information Code" Code Segment Structure....................................................................43

Primary code (PC)....................................................................................................................44 Secondary code (SC)................................................................................................................44 Secondary code 2 (SC2)...........................................................................................................46 Information code variant (ICV) ...............................................................................................51

2.5. Coding Scheme Structure Development ...............................................................................52 2.5.1. "Model Identification Code" Code Field Addition............................................................52 2.5.2. Code Segments Addition ...................................................................................................54

CHAPTER 3. DOCUMENT TEMPLATES EDITOR.........................................................56

3.1. Getting Started ........................................................................................................................56

3.2. Creation Of Document Template For Descriptive Data Module .......................................57 3.2.1. Document Template Creation ............................................................................................57

Coding schemes application ....................................................................................................58

Contents

4

3.2.2. Descriptive Data Module Document Template Editing.....................................................61

3.3. Document Template Export And Import .............................................................................63 3.3.1. Document Template Export ...............................................................................................63 3.3.2. Document Template Import...............................................................................................64

3.4. Creation Of "Illustrated Parts Data" Document Template ...............................................65 3.4.1. Structure Of Mandatory Data About Item According To The Standard ASD S1000D ....65 3.4.2. Creation of "Illustrated Parts Data" Document Template..................................................66

Rules for "Illustrated parts data" document template creation ................................................68 Catalog attributes parameters editing.......................................................................................69 Adding attribute to catalog.......................................................................................................71 Catalog pivot table view setting...............................................................................................76 Catalog card type creation .......................................................................................................77 Order parameters generation....................................................................................................78

3.5. Creation of "Procedural" Document Template...................................................................83

3.6. Templates of Documents for Item Maintenance Planning..................................................85 3.6.1. "Time Limits Information" Document Template Creation................................................85

Document template creation ....................................................................................................85 Print setup ................................................................................................................................87

3.6.2. "Inspection Definition" Document Template Creation......................................................91

3.7. Creation of "Fault isolation procedure" document template.............................................94

3.8. Maintenance Inspection Creation .........................................................................................95 3.8.1. Entering Inspection Definition Editor................................................................................95 3.8.2. New maintenance inspection creation ...............................................................................96 3.8.3. Creation of new record in maintenance inspection............................................................97

Periodic tasks ...........................................................................................................................98 Preparation for flights ............................................................................................................113 Perform once..........................................................................................................................114

CHAPTER 4. TEMPLATE STRUCTURE EDITOR........................................................116

4.1. Getting Started ......................................................................................................................116

4.2. Template structure development.........................................................................................117 4.2.1. Template structure elements ............................................................................................117 4.2.2. Template structure generation..........................................................................................118

"System" structure element creation......................................................................................119 "System" structure element editing........................................................................................122 "System" structure element development ..............................................................................123 "Sub-system" element structure development .......................................................................126 "Unit" element structure development...................................................................................131 "Part" element structure development....................................................................................133

Contents

5

CHAPTER 5. CATALOG INDICES ...............................................................................135

5.1. Getting started.......................................................................................................................135 5.1.1. "Indices" Window............................................................................................................136 5.1.2. "Templates And Attributes of the Current Index" Window ............................................136 5.1.3. "Available templates of the current design catalogs and their attributes" window .........137

5.2. Catalog index creation..........................................................................................................138

CHAPTER 6. IMAGE EDITOR ......................................................................................142

6.1. Getting Started ......................................................................................................................142

6.2. Organization Logotype Paste...............................................................................................143

6.3. Icons Data Book Creation ....................................................................................................144

CHAPTER 7. DICTIONARY EDITOR............................................................................147

7.1. Getting Started ......................................................................................................................147

7.2. Abbreviations Dictionary Creation .....................................................................................148 7.2.1. Abbreviations Dictionary Structure Creating And Editing..............................................148 7.2.2. Filling Abbreviations Dictionary With Information ........................................................150

Abbreviations addition...........................................................................................................150 Operations with abbreviations ...............................................................................................151

7.2.3. Abbreviations search........................................................................................................152

7.3. "Terms" and "Normative documents" Dictionaries Creation.........................................155

7.4. Working with "Service Inscriptions" Dictionary ..............................................................155

CHAPTER 8. CONCLUSION.........................................................................................159

Welcome

6

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 technical manual templates creation TG Designer system of EOD software module version 2.6. If you are a beginner in using TG Designer, then it is recommended to study the contents of this guide. This document will help you to know more about our program and to handle some difficult issues. Notation Agreements The following agreements are used in the document text to mark out different meanings in the text of the manual: Pattern Description

unseriffed Identification of chapters and section of this document

unseriffed Identification of chapters and sections in other documents

bold Names of dialog boxes, interface keys and menu items

SMALL CAPS Combinations of keys to be pressed Monospace Text typed from a keyboard

Besides the following agreements concerning abbreviation of identifications and names are assumed:

Abbreviation Description

Context menu Menu opened by right-click DM data module

EOD Electronic operational documentation

System TG Designer 2.6 system

TD Technical documentation This guide contains figures made as screen shots. The figures show different interface elements of TG Designer program module. The following terms are used for the interface elements:

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.

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

8

This document is delivered together with the product in electronic form as a reference system.

Introduction

9

Chapter 1. Introduction TG Designer program module is intended for designing templates used to create technical documentation for item. Operation in TG Designer module is based on principles given in standard ASD S1000D, issue 2.3. The standard materials can be found at internet-site www.S1000D.org in Downloads section. This chapter defines:

• software and hardware requirements for program operation;

• technical manual template and its purpose;

• data module (DM) coding system;

• initial stage of template generation.

1.1. Software Requirements A computer which is planned for module TG Designer operation shall meet some software and hardware 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).

3. SW for protection against unauthorized (unlicensed) usage: Guardant soft/hardware protection system is used in the system. The system can include several independent USB-dongles for 1 (one) license each or one (or several) network USB-dongle for several licenses. In the latter case the system comprises also a special software – license server. Detailed information on the system application can be found at address: http://www.guardant.ru/hotline/download/manual/ .

http://www.s1000d.org/

http://www.guardant.ru/hotline/download/manual/

Introduction

10

1.2. Hardware Requirements Computer configuration required for adequate operation is given in the table below.

Table 1-1

Device Possible options

CPU AMD Athlon 64 2800+ <Socket754> or Intel Pentium-4 2400A <533FSB, 1024Kb, Socket478>.

RAM Not less than 256 Mb (512 Mb is recommended) DDR400.

HDD Not less than 40 Gb (80 Gb is reccommended).

CD-drive DVD-R/CD-RW (electronic guide publications).

Monitor 17", with resolution of up to 1024х768@85Hz or better.

The following is required to install a copy of network version:

Network interface card

Not less than 100 Mbps at each computer.

A minimum computer configuration is given in the table below.

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

The following is required to install a copy of network version:

Network interface card

10 Mbps at each computer.

1.3. Template of Technical Documentation Project Before starting TD development it is necessary to define the rules of documentation structure and content development. These rules are called templates and include the following information:

• future project structure and its elements;

• project elements coding method;

• standard DM templates;

• icons data book;

Introduction

• abbreviations, terms, normative documents and service inscriptions dictionaries used to enter information to the project in TG Builder module.

Template is generated for each particular project.

1.4. Getting Started TG Designer is a module of EOD software module. After EOD software module installation on the computer a folder with system shortcuts is displayed in Programs menu of Windows operating system (Fig. 1.1).

Fig. 1.1

Click with the left mouse button on 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.

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 set. 2. When using a network version , select a server name additionally.

After Log-in button pressing Attention dialog window may appear, containing information regarding changed settings of code pages. It will be displayed in case code pages required for correct display of different languages font have been changed in the system. If you don’t want to

11

Introduction

read this warning at each TG Builder module start, check Do not show again flag. After ОК button pressing Welcome dialog window (Fig. 1.3) will be displayed.

Fig. 1.3

The following icons are available in top part of Welcome dialog window:

• Project Manager is a program module to create electronic documentation projects. Operation with the project is described in "EOD software module 2.6" User Guide.

• TG Browser is a program to view projects. Refer to its description in TG Browser User Guide.

• TG Admin is a utility program to register users, to connect and delete templates used to create projects. Refer to the utility detailed description in Administrator’s Manual.

• TG Designer is a program module to design electronic documentation templates.

• Help.

To enter TG Designer program module press TG Designer icon in Welcome dialog window (Fig. 1.3). Then TG Designer dialog window will be displayed (Fig. 1.4).

12

Introduction

Fig. 1.4

In the top part of the window there is a main menu which will be displayed in other main dialog windows of the system (Fig. 1.5):

Fig. 1.5

• Template menu is used to create, open and close templates and exit the program.

• View menu in intended for interface language selection.

• Help menu is used to view a reference guide for the program, the system and program information.

Under the menu there is a functional panel with the following tools: Create (new template), Open (template), Close (template).

1.5. New Template Generation The Guide describes an example of demo template generation for electronic documentation project for aircraft AIRCRAFT-2010. The example uses all program features. Proceed as follows to create a new template:

1. In TG Designer dialog window press Create a new template button.

2. In Browse window press Create a folder button and enter its name "AIRCRAFT-2010".

3. Press OK button. Then Technical manual template window will be displayed.

4. Enter template parameters into the corresponding boxes in the left part of the window (Fig. 1.6):

− Template development organization – "Company name".

− Documentation development organization – "Company name".

− Responsible organization – "Company name".

− Template name – "AIRCRAFT-2010".

− Identification/template version – "1.0".

13

Introduction

− Standard name – "ASD S1000D".

− Standard version – "2.3".

− Template description – "Template is intended to create technical documentation for aircraft AIRCRAFT-2010".

Fig. 1.6

The right part displays editor icons to create and edit template components:

• Codificaton is a coding scheme editor.

• Structure template is a technical manual structure template editor.

• Document templates is a data modules type templates editor.

• Catalog indices is a catalog indices editor.

• Images is an editor to enter organization logotype.

• Dictionary is an editor of terms, abbreviations, normative documents and service inscriptions dictionary.

• Inspection definition templates is a maintenance inspection editor. It ends the introduction part of the guide. When operating with template for technical documentation project the originator should:

• develop coding system;

• create templates for different types of data modules;

14

Introduction

15

• define a project template structure;

• compile a terms, abbreviations, normative documents dictionary and edit service inscriptions if necessary.

All the procedures are performed in the corresponding editors described in the following chapters of the Guide.

Coding System Development

Chapter 2. Coding System Development This chapter specifies creation of coding system for template "AIRCRAFT-2010" in the editor intended for this purpose.

2.1. Getting Started If you exited TG Designer module, proceed as follows to open the template:

1. Click TG Designer icon in Welcome dialog window.

2. Press button Open in TG Designer window.

3. In Browse window select the folder name "AIRCRAFT-2010", open it and press OK. Then Technical manual template dialog window will be displayed, it contains information about template "AIRCRAFT-2010".

To enter coding system editor press Codification icon in Technical manual template dialog window. Then Coding system dialog window (Fig. 2.1) will be displayed.

Fig. 2.1

16


The upper left window of Coding system editor is intended for listing coding schemes and their components – code segments. Coding scheme tab consisting of two windows is located in the right part of the editor window. Masks and code field names included in coding system are entered to the first window of the tab, the second window is used to display a code scheme. Other windows will be described during operation. The coding scheme is a code fields set with a definite input masks . The coding scheme editor allows:

• creating coding scheme variants;

• creating code fields groups;

• creating code fields sequences;

• entering lists of standards code values. The top left editor window consists of two sections:

• Coding. Here the list of coding schemes and their variants is generated.

• Code segments. Here the list of code segments (code fields groups) which forms coding scheme is generated.

A template coding system is developed in the following order:

1. Create coding scheme (or coding schemes list).

2. Create code segments list (code fields groups).

3. Develop structure of code segments

4. Develop the structure of coding scheme.

2.2. New Coding Scheme Creation To create a coding scheme:

1. Select Coding section in the top left editor window.

2. Press button in the upper part of the window. Then Coding scheme window will be displayed.

3. Enter parameters of coding scheme in "English" tab (Fig. 2.2):

• Identification – "AE".

• Name – "Aircraft and engine".

• Description – "The scheme of coding of the technical manual on aircraft AIRCRAFT-2010".

17


Fig. 2.2

4. Press button. Then the name of created coding scheme "Aircraft and engine" will be displayed in the list of Coding section.(Fig. 2.3).

Fig. 2.3

To change properties of the coding scheme:

1. Select its name.

2. Press Properties button.

3. Make all necessary changes in Coding scheme window. To delete the coding scheme use button.

2.2.1. Coding Scheme Implementation Coding scheme can have several implementations (versions). Implementations differ in field sets and dependence. An example of different implementations of data module code coding scheme is for aircrafts and ground equipment. Create one variant of coding scheme "Aircraft and engine":

1. Select "Aircraft and engine" coding scheme in the top left editor window.

2. Press button in the upper part of the window. Then Coding scheme implementation window is displayed (Fig. 2.4).

18


3. Enter a name of coding scheme: "Data module code" in "English" tab (Fig. 2.4):

Fig. 2.4

4. Press button . A name of its implementation: "Data module code" will be displayed in the list of "Aircraft and engine" scheme (Fig. 2.5).

Fig. 2.5

The first created variant of coding scheme becomes the default coding scheme. The default coding scheme is marked with sign (Fig. 2.5). The default coding scheme is used further in TG Builder module when importing data modules, which coding scheme differs from the current project data modules coding scheme. Such data modules will be automatically assigned a code according to the default coding scheme. If coding scheme has several variants, then it is possible to assign any variant as the default coding scheme. For this purpose:

1. Select a variant of coding scheme.

2. Press the button with flag . Then the coding scheme will be marked with a sign. To edit scheme variant properties select it and press Properties button , to delete use button. The coding scheme should meet the requirements of standard ASD S1000D. A coding scheme variant under creation "Data module code" will include three groups of code fields (code segments) (Table 2-1).

19


20

Table 2-1

Code group name Code field Code field identification

Code group identification

System difference code SDC Standard numbering system code

Standard numbering system code

SNS

SNS

Disassembly code DC Disassembly code

Disassembly code variant DCV

DC

Information code: Primary code Secondary code Secondary code 2

PC SC

SC2

Information code

Information code variant ICV

IC

System difference code (SDC) is artificially included in group of "Standard numbering system code". To develop coding scheme structure it is necessary to create code segments the coding scheme structure will consist of.

2.3. Code Segments List Creation Continue operation in coding system editor. A list of code segments is generated in Code segments section. To create "Standard numbering system code" code segment:

1. Select Code segments section in the top left editor window.

2. Press Add button in the upper part of the window. Code fields group window will be displayed (Fig. 2.6).

3. Enter code fields group identification – "SNS" (Fig. 2.6).

4. Enter the following in "English" tab:

• Name – "Standard numbering system code".

• Description – "The field group of code includes one symbol of system difference code and three pairs of the symbols partitioned by separators and designating a bunch "system code – sub-system code – unit code"".


Fig. 2.6

5. Press button . In this case "Standard numbering system code" name will be displayed in the code segment list (Fig. 2.7).

Fig. 2.7

Similarly create the following code segments: "Disassembly code" and "Information code" (Fig. 2.8).

Fig. 2.8

To edit code segment properties select it and press Properties button, to delete use button .

21


2.4. Code Segments Structures Development This section defines the following code segments structures development:

• Standard numbering system code.

• Disassembly code.

• Information code

2.4.1. "Standard Numbering System Code" Code Segment Structure Development

Code segment consists of several code fields. Let us study creation of "Standard numbering system code" code segment structure. This group of code fields includes one symbol "System difference code" and three pairs of symbols passing through separator and identifying a link "system code – sub-system code – unit code".

"System difference code" code field addition

To add a code field:

1. Select "Standard numbering system code" code segment in the top left editor window.

2. Press Add button in the left part of Coding scheme tab. Code field dialog window will be displayed (Fig. 2.9).

22


Fig. 2.9

3. Enter a code element identification – "SDC".

4. Enter a name of code element: "System difference code" in "English" tab (Fig. 2.12).

5. Enter a code element description – "Indicates alternative versions of the system and subsystem/sub-subsystem identified by the SNS without affecting the type, model or variant identity".

6. Open the list of permissible fields in Field type section (Fig. 2.10).

23


Fig. 2.10

Types of fields

The list includes the following types of fields:

• Code Part is used for such code fields as "System code", "Disassembly code" etc.

• Model Identification is used for "Model Identification code" code field».

• Difference Code is used for "System difference code" code field.

• Code Variant is used for "Information code variant" and "Disassembly code variant" code fields.

• Auto Enum is an automatic numbering field. When creating new DM the code is increased by 1 each time.

The first element that we create is a "System difference code". Select Difference Code in the Field type section in Code field dialog window (Fig. 2.11).

"Variable field length" option According to the standard ASD S1000D data module code can include from 17 to 37 alphanumeric symbols. Some fields that compose DM code can have variable length. For example, the standard sets from 2 to 14 symbols for Model identification code, and from 1 to 3 symbols for Disassembly code variant. To consider this possibility select Variable field length option and indicate minimum and maximum number of symbols. The variable length is used for code fields, if a template under creation will be used for several projects for which Model identification code and other data module code segments have different number of symbols. Moreover, it may be necessary to import data modules to the project from the related projects for which the templates are similar but Model identification code lengths are different. The option of variable field length allows considering possible variants for all occasions.

Remark: A number of symbols entered to Field mask field should match the maximum number of symbols entered to Before field.

24


This example uses fixed field lengths and Variable field length option will not be enabled.

Code fields masks In Code field dialog window Field mask window is intended for entering code mask (Fig. 2.11).

Fig. 2.11

The code field mask sets rules of code element value generation. For example, the code with "ХХХ" mask can take any three digit value, the code with "AAA" mask – any three letter combination of Latin letters. A mask length defines a number of symbols in code field, mask values define a type of symbols in field. The table specifies code masks and relative values.

Table 2-2

Mask symbol Description

A Latin letter

Y Latin letter or number

X Number

? Arbitrary symbol Enter mask "A" in Field mask window in Code field dialog window. An example of Code field window with entered parameters for "System difference code" code field is shown in Fig. 2.12.

25


Fig. 2.12

Later when all code fields are created, it is necessary to return to this dialog window to select code fields to which the system difference code will be applied (Applied to fields button). Press button in Code field window. Herewith you will return to Coding system dialog window (Fig. 2.13).

26


Fig. 2.13

Coding scheme tab displays mask and name of created field: System difference code. The right window of the tab displays the code segment scheme "Standard numbering system code" at the current stage of development (Fig. 2.13). To edit code field properties:

1. Select code field.

2. Press button Change in the left part of Coding scheme tab.

3. Enter necessary changes in Code field dialog window. To delete the code field always use Delete button. To divide code fields into visual sections add separators:

1. Select the "Standard numbering system code" code segment in the top left editor window.

2. To add separator-dash press Dash buttonin the left part of Coding scheme tab. To add separator-point use Point button.

"System code" code field addition To add the next code field to "Standard numbering system code" code segment:


2. Press Add button in the left part of Coding scheme tab. Code field dialog window will be displayed.

27


3. Enter code field identification: "SC" (system code) (Fig. 2.14).

4. Select Code Part type in Field type section.

5. Enter mask "YY" in Field mask section.

6. Enter a name of code field: "System code" in "English" tab.

7. Enter description: "First part Standard numbering system code". An example of Code field window with entered parameters for "System code" code field is shown in Fig. 2.14.

Fig. 2.14

Press button . Herewith you will return to Coding system dialog window (Fig. 2.15).

28


Fig. 2.15

There are masks and names of created code fields in Coding scheme tab. The right window of the tab displays a code segment scheme for this stage of development.

Development of fixed value lists for "System code" field To automate coding of electronic documentation project elements during its development in TG Builder module enter lists of standard code values with corresponding description. The standard ASD S1000D gives definitions of systems and subsystems used for aircrafts. The values of Standard numbering system code are specified in the chapter 8.2:

• Chapter 8.2.1 Maintained SNS - Generic.

• Chapter 8.2.5 Maintained SNS - Air vehicle, engines and equipment. To compile a list of standard code values for "System code" field:

1. Select "System code" code field in Coding system tab.

2. Select No condition is available in Condition column in the lower left editor window.

3. Press button in the lower right window. Herewith Fixed value dialog window (Fig. 2.16) will be displayed.

29


Fig. 2.16

4. This example for aircraft uses data from chapters 8.2.1 and 8.2.5 of the Standard ASD S1000D to fill fields of Fixed value dialog window. An example for one value is shown in Fig. 2.17. • A value for Fixed field value field is taken from System column – "00". • A value of Name field "Aircraft – General" is taken from Title column. An object

of this example is an aircraft. • A value of Description field is taken from Definition column.

Fig. 2.17

30


5. To enter the next field value press button . Fixed value dialog window will be cleared.

6. Enter all fixed values of "System code" code field sequentially to Fixed value dialog window. For aircraft enter values specified in tables (Table 2-3 and Table 2-4).

Table 2-3. Index of standard systems (Chapter 8.2.1 ASD S1000D)

System Title

00 Product – General

04 Worthiness (fit for purpose) limitations

05 Scheduled/unscheduled maintenance

06 Dimensions and areas

07 Lifting, shoring, recovering and transporting

08 Leveling and weighing

09 Handling and maneuvering

10 Parking, mooring, storing and return to service

11 Placards and markings

12 Servicing

14 Product loading and offloading

15 Crew information

16 Change of role

18 Vibration and noise analysis and attenuation

Table 2-4. Top Level Breakdown for Air vehicle, engines and equipment (Chapter 8.2.5 ASD S1000D)

System Title

20 Standard practices - Airframe systems

21 Environmental control

22 Auto flight

23 Communications

24 Electrical power

25 Equipment/furnishings

26 Fire protection

27 Flight controls

28 Fuel

31


System Title

29 Hydraulic power

30 Ice and rain protection

31 Indicating/recording systems

32 Landing gear

… …

After entering all standard values of "System code" code field to Fixed value window press button . Herewith you’ll be returned to Coding system dialog window, which lower right

window will display a list of entered code field values (Fig. 2.18).

Fig. 2.18

To edit code field fixed values properties select it and press button , for deletion use button . To change an order of code field values in the list use buttons Up and Down .

32


"Sub-system code" code field addition "System difference code" and "System code" code fields with a list of standard code values are created for "Standard numbering system code" code segment. Continue operation to create code fields for this code segment:


2. Add separator after the code field – "System code". For this purpose press Dash button in the left part of Coding scheme tab.

3. Press Add button in the left part of Coding scheme tab. The Code field dialog window will be displayed.

4. Enter parameters of code field (Fig. 2.19):

• identification – "SSC" (sub-system code); • select type of field Code Part; • mask – "XX"; • enter name: "Sub-system code" and description: "Second part standard

numbering system code" in "English" tab.

33


Fig. 2.19

5. Press button . Then you will return to Coding system window.

6. Add separator – dash in Coding scheme window. Coding scheme tab for this stage is shown in Fig. 2.20.

Fig. 2.20

34


Generation of fixed value effectivity conditions list for "Sub-system code" field In the previous section a list of standard code values was compiled without condition. To compile a list of standard code values with conditions proceed as follows:

1. Select "Sub-system code" code field in Coding scheme tab (Fig. 2.20).

2. Select New condition in Condition column in the lower left editor window.

3. Press button in the lower right editor window. Herewith Fixed valve dialog window will be displayed (Fig. 2.21).

Fig. 2.21

4. In this window press Add a field button in Effectivety conditions section. Condition: field value dialog window will be displayed (Fig. 2.22).

5. Select "SC: System code" from the drop-down list in Code field window (Fig. 2.22).

6. Select the fixed field value "00: Aircraft – General" from the drop-down list in Field value window (Fig. 2.22).

35


Fig. 2.22

7. Press button . It returns you to Fixed value window, the Effectivity conditions section window will display the assigned condition (Fig. 2.23).

Fig. 2.23

8. The Standard S1000D (Table 2-5) gives data to fill fields of Fixed value dialog window:

• A value for Fixed field value field is taken from Sub-system column – "00".

• A value of Name field "Aircraft – Description" is taken from Title column.

• A value of Description field is taken from Definition column - «General description with illustrations of the Product and its systems to include type of Product, its roles, accommodation, salient

36


constructional features, power system installation, systems and operational equipment».

9. To enter the next field value press button . The fields of Fixed value dialog window will be cleared.

10. In Fixed value dialog window sequentially enter all fixed values for "Sub-system code" field for system "00:Aircraft – General" specified in (Table 2-5).

Table 2-5. System 00 – Product - General (Chapter 8.2.1 ASD S1000D)

System Sub-system Title Definition 00 Product – General General information for the complete Product,

procedures for the Product safety and general Product maintenance, use of the Product safety and protective devices, information on the technical publication required to support the Product.

-00 Product – Description General description with illustrations of the Product and its systems to include type of Product, its roles, accommodation, salient constructional features, power system installation, systems and operational equipment.

-10 Product - General maintenance Those instructions necessary for the Product maintenance condition, electrical (static) grounding.

-20 Product – Safety Those specific or Product peculiar instructions necessary to make safe and prepare the Product for maintenance action. Includes instructions for returning the Product to its serviceable state.

-30 Safety and protective devices Those instructions necessary for the use or operation of devices such as safety pins, safety locks, safety pin flag assemblies, safety struts, safety strut extensions, etc. Instructions for removal and installation of protective covers, bungs, blanks etc are to be included.

-40 Technical publication Information on the technical publication required to support the Product (not a technical publication project in its own right) such as the Lists of Applicable Publications, Publication Guide, the coding system of technical publications, instruction for handling and updating technical publication.

… … … …

When entering all standard values of "Sub-system code" field for system "00: Aircraft – General" in Fixed value window press button . It returns to Coding system dialog window, the lower right window will display a list of entered code field values (Fig. 2.24).

37


Fig. 2.24

The left part of the window displays a list of conditions, the right one – a list of fixed code field values corresponding to the selected condition. This example shows that if "System code" (SC) code field has value "00", then "Sub-system code" code field has fixed values "00", "10", "20" etc. with the corresponding definitions. Sequentially enter all fixed values of "Sub-system code" field for other systems which values were entered earlier (Table 2-3 and Table 2-4). To create the next condition repeat procedures described in this section. Coding scheme tab has the appearance as shown in Fig. 2.25.

38


Fig. 2.25

There are masks and names of created code fields in the left window of Coding scheme tab. The right window of the tab displays a code segment scheme for this stage of development. The arrow indicates dependence of "Sub-system code" (SSC) code fields values from "System code" (SC) code fields values (Fig. 2.25).

"Unit code" code field addition The following code fields are created for "Standard numbering system code" code segment:

• "System difference code".

• "System code" with lists of standard code values.

• "Sub-system code" with lists of standard code values and effectivity conditions. Continue operation to create code fields for this code segment:

1. Select the "Standard numbering system code" code segment in the top left editor window.

2. Press Add button in the left part of Coding scheme tab. Code field dialog window will be displayed.

3. Enter parameters of code field (Fig. 2.26):

• identification – "UC" (unit code);

• select type of Code Part field;

• mask – "XX";

• enter name: "Unit code" and description: "Third part Standard numbering system code" in "English" tab.

39


Fig. 2.26

Press button . Herewith you will return to Coding system dialog window. It is possible to create a list of fixed code fields values for units only for the particular project, because there is a separate list of units requiring description and maintenance for each project. Field values for "Unit code" are assigned by the originator. Coding scheme tab for this stage of "Standard numbering system code" code segment development has the appearance as shown in Fig. 2.27.

40


Fig. 2.27

System difference code application The following four code fields are created for "Standard numbering system code" code segment:

• "System difference code".

• "System code" with lists of standard code values.

• "Sub-system code" with lists of code fields fixed values effectivity conditions.

• "Unit code".

Then proceed as follows:

1. Select "System difference code" code field in the left window of Coding system tab.

2. Press Change button.

3. Press button in Code field dialog window. Herewith Linked fields window will be displayed (Fig. 2.28).

4. Select fields to which "SC" and "SSC" configuration code is applied (Fig. 2.28).

41


Fig. 2.28

5. Press button . It returns you to Code field window.

6. Press button . Herewith you will return to Coding system dialog window.

A structure of "Standard numbering system code" code segment is developed (Fig. 2.29).

Fig. 2.29

The arrows in the upper part of the code segment scheme indicate that "System difference code" (SDC) is applied to "System code" (SC) and "Sub-system code" (SSC) (Fig. 2.29). It means that the system and sub-system can have different configurations: A, B etc. The arrow in the lower part of the scheme indicates a dependence of the code fields fixed values.

2.4.2. "Disassembly Code" Code Segment Structure Develop a structure of "Disassembly code" code segment similarly to "Standard numbering system code" code segment structure. Here there is no detailed description of this process, but a result is presented.

42


"Disassembly code" segment consists of the following code fields (Fig. 2.30): • Disassembly code. • Disassembly code variant.

Fig. 2.30

"Disassembly code" field has "Code Part" type and "YY" mask. A list of standard values for this code field is not created. "Disassembly code variant" field has "Code Variant" type and "Y" mask. A list of standard values for this code field is not created.

2.4.3. "Information Code" Code Segment Structure Information code indicates a type of information in data module. A value of Information code is formed by three numbers and a letter of variant:

1. The first number is Primary code.

2. The second number is Secondary code.

3. The third number is Secondary code 2.

4. A letter symbol is Information code variant. The standard S1000D gives definitions for Information codes used for aircrafts. The values of Information codes are specified in chapter 8.4. "Information code" (IC) segment consists of the following code fields:

• Primary code (PC). • Secondary code (SC). • Secondary code 2 (SC2). • Information code variant (ICV).

Let’s describe each code field included in "Information code" (IC) code segment.

43


Primary code (PC) Create "Primary code" code field as described in section “"System code" code field addition". "Primary code" code field has "Code Part" field type and "X" field mask. Generate a list of fixed code field values as described in section "Development of fixed value lists for "System code" field". The standard S1000D specifies the following values of the primary codes:

• 0 - Function, data for plans and description .

• 1 - Operation.

• 2 - Servicing.

• 3 - Examinations, tests and checks.

• 4 - Fault report and isolation procedures.

• 5 - Disconnect, remove and disassemble procedures.

• 6 - Repairs and locally make procedures and data.

• 7 - Assemble, install and connect procedures.

• 8 - Storage procedures and data.

• 9 - Miscellaneous. An example of standard primary code values list is shown in Fig. 2.31.

Fig. 2.31

Secondary code (SC) Create "Secondary code" (SC) code field as described in section “"System code" code field addition". "Secondary code" code field has "Code Part" type and "X" mask. It is necessary to enter a list of secondary code values for each value of the primary code. The procedures of entering code values with effectivity conditions are specified in section "Development of fixed value lists for "System code" field".

44


45

The values of secondary codes from standard S1000D with abbreviations are specified in table (Table 2-6). The secondary code is specified in the column of the same name by the second number of three digit code.

Table 2-6. Values of secondary Information code for primary code "0" (Chapter 8.4.2 ASD S1000D)

Primary code Secondary code

Definition

000 000 Function, data for plans and description. Code 000 data tells the user the function, operation, limits and location (if necessary) of the Product equipment or component. If the data is for more than one configuration or model, the differences are given. The code also includes more general data if this is necessary for operation and/or maintenance persons. This general data can be: - general warnings, cautions and related safety data - symbols and abbreviations used - all necessary material, ground equipment, software and special tools

…. …..

010 General data Code 010 gives general data necessary for the operation and/or maintenance persons. This general data can be: - general warnings, cautions and related safety data - the symbols and abbreviations used - lists of special and dangerous materials - a list of related data not in the common source data base. (When related data refer to available data it is to understand that the data must be available in all user countries)

… …

020 Configuration Code 020 gives data on configuration or model differences.

… …

030 Technical data Code 030 is a list of data on the Product, system, equipment or component. The data is equivalent to (but can be more or less than) the examples of data that follow: - identification: name, type, model, part No., NATO stock No., etc - dimension and mass - performance data and tolerances: rating, input/output, consumption, operation speeds, thrust range, turning radius, etc - environmental limitations/requirements: ambient temperatures, humidity limits, coolant requirements (air/oil/water flow), etc


Primary code Secondary Definition code

- power supply requirements - operation materials: oils, fuels, coolant, etc - capacities - identification of sub-assemblies: name, type, model, part No., NATO stock No., Etc

… …

040 Description of how it is made and its function Code 040 tells how the object was made and the material used: the code also gives all the related data about its functions.

… …

An example of secondary code standard values list with effectivity conditions (for primary code with value "0") is shown in Fig. 2.32.

Fig. 2.32

This example shows that if "Primary code" (PC) code field has value "0", then "Secondary code" code field has fixed values "0", "1", "2" etc. with the corresponding definitions.

Secondary code 2 (SC2) Create "Secondary code 2" (SC2) code field as described in section “"System code" code field addition". "Secondary code 2" code field has "Code Part" type and "X" mask.

It is necessary to enter two effectivity conditions of fixed values for Secondary code 2 by different code fields, because Secondary code 2 definition depends on combination of primary code and secondary code values.

The values of Secondary codes 2 from standard S1000D with abbreviations are specified in the table (Table 2-7). Secondary code 2 is specified in "Secondary code" column by the third number of the three digit code.

46


47

Table 2-7. Values of secondary Information code 2 for primary code "0" and secondary code "0"

(Chapter 8.4.2 ASD S1000D)

Primary code Secondary code

Definition

000 Function, data for plans and description Code 000 data tells the user the function, operation, limits and location (if necessary) of the Product equipment or component. If the data is for more than one configuration or model, the differences are given. The code also includes more general data if this is necessary for operation and/or maintenance persons. This general data can be: - general warnings, cautions and related safety data - symbols and abbreviations used - all necessary material, ground equipment, software and special tools

001 Title page Code 001 gives information on a set of information (publication or a volume of publication). This information can be eg: - the title - issue number and date - change number and date

002 List of pages or data modules Code 002 gives a list of pages or data modules in a set of information (publication or a volume of publication). The list can give eg: - document identifier - page number - page/document date - effectivity The code is used for List of Effective Pages (LOEP), and List of Effective Data Modules (LOEDM), see Chap 3.9.4. For separate codes for LOEP and LOEDM, see code 00R and 00S respectively.

003 Change record or highlights Code 003 gives information on the change state, including its history, of a set of information (publication or a volume of publication). It is also used for compilation of reason for changes of a set of information. The code is used for Change Record (CR) and Highlights. See Chap 3.9.4. For separate codes for Change record and Highlights, see code 00T and 00U respectively.

… …


To compile a list of standard Secondary code 2 values with two effectivity conditions (for Primary code "0" and Secondary code "0") proceed as follows:

1. Select Secondary code 2 line in Coding scheme tab (Fig. 2.33).

Fig. 2.33

2. Select New condition in Condition column in the lower left editor window (Fig. 2.33).

3. In the lower right editor window press button . Then Fixed value dialog window will open. (Fig. 2.37).

4. In this window in Effectivity conditions section press Add a field button. Herewith Condition: field value dialog window will be displayed (Fig. 2.34).

5. In Code field window select "PC: Primary code" from the drop-down list Fig. 2.34.

6. In Field value window select a fixed value of field "0: Function, data for plans and description" (Fig. 2.34).

Fig. 2.34

48


7. Press . Then you will return to Fixed value window.

8. To add the second condition press Add a field button in Fixed value window in Effectivity conditions section. Herewith Condition: field value dialog window will be displayed (Fig. 2.35).

9. In Code field window select "SC: Secondary code" from the drop-down list.

10. In Field value window select a fixed value of field "0: Function, data for plans and description" from the drop-down list (Fig. 2.35).

Fig. 2.35

11. Press button . Then you’ll return to Fixed value window, and Effectivity conditions window will display assigned conditions (Fig. 2.36).

Fig. 2.36

12. Fill in other fields of Fixed value window as shown in Fig. 2.37.Data for other fields of Fixed value dialog window filling are taken from S1000D standard (Table 2-7).

• A value of Fixed field value field is taken from the "Secondary code" column (the third number of three digit code).

• A value of Name field is taken from Definition column.

• A value of Description field is taken from Definition column.

49


Fig. 2.37

13. To enter the next fixed value press button and fill the cleared fields with new values.

14. Sequentially enter all fixed values Secondary code 2 for the current combination of the primary and secondary codes values.

15. Press button . Then you will return to Coding system window. The example of secondary code 2 standard values list with two effectivity conditions ("0" for Primary code, "0" for Secondary code) is shown in Fig. 2.38.

50


Fig. 2.38

In the considered example "Secondary code 2" (SC2) field has fixed values "1", "2", "3", "4" etc. with corresponding definitions under the following conditions:

1. "Primary code" (PC) code field has value "0".

2. "Secondary code" (SC) code field has value "0". To enter the fixed values of secondary code 2 for other combinations of Primary code and Secondary code values repeat procedures described in items 2–13.

Information code variant (ICV) Create "Information code variant" (ICV) code field as described in section “"System code" code field addition". This code field has "Code Variant" type and "A" mask. A list of standard code values for this code field is not created. A structure of "Information code" code segment is developed. Its scheme is shown in the right part of Coding system window (Fig. 2.39).

Fig. 2.39

51


2.5. Coding Scheme Structure Development The previous sections describe development of "Standard numbering system code", "Disassembly code" and "Information code" code segment structure. This section gives generation of "Data module code" coding scheme structure. Remember that a coding scheme under development will include the following code fields and code segments:

• "Model identification code" code field.

• "Standard numbering system code" code segment.

• "Disassembly code" code segment.

• "Information code" code segment.

• "Item location code" code field. Add code fields to "Data module code" coding scheme and attach code segments created before.

2.5.1. "Model Identification Code" Code Field Addition To add a code field to the coding scheme:

1. Select "Data module code" in the top left editor Coding system window.

2. Press Add button in the left part of Coding scheme tab. Code field window will be displayed (Fig. 2.40).

3. Enter a code element identification – "MI".

4. Select "Model Identification" from the list in Field type section.

5. The standard S1000D assigns from 2 to 14 symbols for Model identification code. This example enters a code consisting of 10 symbols. Enter mask "YYYYYYYYYY" in Field mask section. Variable field length option is described in section “"Variable field length" option".

6. Enter a name of code element: "Model identification code" in "English" tab (Fig. 2.40).

7. Enter description of code element: "Identifies a model or several models relating to the same type".

An example of Code field window with entered parameters for "Model identification code" code field is shown in Fig. 2.40.

52


Fig. 2.40

Press button. Herewith you will return to Coding system dialog window. Add a separator dash:

1. Select "Data module code" in the top left editor Coding system window.

2. Press Dash button in the left part of Coding scheme tab. Coding system window has the appearance as shown in Fig. 2.41.

53


Fig. 2.41

There are a mask and name of created code field in Coding scheme tab. The right window of the tab displays a coding scheme for this stage of development (Fig. 2.41). To edit created code field properties select it and press Change button, for deletion use Delete

button

2.5.2. Code Segments Addition Continue generation of "Data module code" coding scheme structure. To add "Standard numbering system code" code segment:

1. Select "Data module code" coding scheme in the top left editor window.

2. Press Group button in the left part of Coding scheme tab and select SNS in opened list (Fig. 2.42).

Fig. 2.42

The coding scheme tab after the performed procedures has the appearance as shown in Fig. 2.43.

54


Fig. 2.43

Add the following to the coding scheme:

1. "Disassembly code" (DC) code segment.

2. "Information code" (IC) code segment.

3. "Item location code" (ILC) code field. This code field has "Code Part" type and "A" mask.

Development of template "AIRCRAFT-2010" coding scheme is completed. It is shown in Fig. 2.44.

Fig. 2.44

55

Document Templates Editor

Chapter 3. Document Templates Editor This chapter defines creation of documents of the following types:

• S1000D Descriptive DM.

• S1000D IPD DM – Illustrated parts data.

• S1000D Procedural DM.

• S1000D Schedule/TimeLim DM – Time limits information.

• S1000D Schedule/DefInspec DM – Inspection definition.

• S1000D Fault/AFI DM – Fault isolation procedure.

The created document templates are used to develop technical documentation project in TG Builder module. Each project data module is assigned a document template type from the list of available ones in the template on the base of which the project is created. Continue working with "AIRCRAFT-2010" template.

3.1. Getting Started Perform the following procedures to open the template:

1. Start TG Builder module.


3. Press button in TG Designer window.

4. In Browse window select the folder name "AIRCRAFT-2010", open it and press OK. Then Technical manual template dialog window will be displayed, it contains information about template "AIRCRAFT-2010".

To enter data modules templates editor press Document templates icon in Technical manual template dialog window. Document templates dialog window will open (Fig. 3.1).

56


Fig. 3.1

The dialog window does not display information because no document template is created. The left editor window is intended for displaying the document templates list. When selecting a template name in the left window, the upper part of the right window displays its properties. Information about document template application in other elements of Publication and Section type manuals are saved in the lower part of the right window (see "Set element application"). It is possible to create unlimited number of document templates in TD project template.

3.2. Creation Of Document Template For Descriptive Data Module

3.2.1. Document Template Creation To create a new document template press Create a template buttonin the toolbar of the left window. Template dialog window will be displayed (Fig. 3.2).

57


Fig. 3.2

Proceed as follows in Template dialog window:

1. Select a type of template – S1000D Descriptive DM.

2. Enter template identification – "DescriptiveDM" (without spaces).

Remark A template identification shall include only Latin letters and numbers, it shall start with a letter.

3. Enter a template name – "Descriptive".

4. Define a coding scheme.

Coding schemes application Any document template may use a coding scheme developed in coding scheme editor beforehand. Coding scheme creation is described in the second chapter of the manual "Coding System Development". To use coding scheme:

1. Select Use codification option in Template dialog window.

58


2. To load the coding scheme press button in the right part of Coding scheme window. Then Coding scheme window will be displayed (Fig. 3.3).

Fig. 3.3

3. Open a list of coding scheme "Aircraft and engine" (Fig. 3.3).

4. Select a variant of scheme "Data module code".

5. Press button . Herewith you will return to Template dialog window (Fig. 3.4).

59


Fig. 3.4

Coding scheme field will display a scheme name and special fields to enter the code under it. Data module code of Description type will be entered to these fields during TD development in TG Builder module. When entering document template parameters to Template dialog window, press button. The created document template will be displayed in the template list in Document template window and will be immediately opened for editing (Fig. 3.5).

60


Fig. 3.5

3.2.2. Descriptive Data Module Document Template Editing To edit document template "Descriptive", use the same editor as for editing descriptive data modules content in TG Builder module. The editor makes possible:

• To format documents according to standard ASD S1000D.

• To enter and edit text, format it with different fonts and colors.

• To embed tables, illustration and multimedia objects to the document.

• To insert standard elements to the document. The editor properties are described in "EOD software module 2.6" User Guide. Enter information that should be presented in all documents of this template type into the descriptive data module template. It can be a text or an illustration. Exit the descriptive data module template editor. Then a window with a request to save the changes will be displayed.

"Yes" answer selection saves entered changes, "No" answer selection does not save them. Then you will return to Document templates dialog window (Fig. 3.6).

61


Fig. 3.6

The left part of Document templates window displays identification and name of created template (Fig. 3.6). The right part of dialog window displays information about selected template. Each type of document template has a sign on the left from its identification. Icons and corresponding names of template types are specified in the table (Table 3-1).

Table 3-1

Icon Template type

S1000D Descriptive DM

S1000D Procedural DM

S1000D IPD DM – Illustrated parts data

S1000D Schedule/DefInspec DM – Inspection definition

S1000D Schedule/TimeLim DM – Time limits information

S1000D Fault/AFI DM – Fault isolation procedure To edit template parameters:

1. Select a template name in the left window.

2. Press Properties button in the toolbar of the left window.

3. Make all necessary changes in Template dialog window. Use Delete the template button to delete the template.

62


To enter the editor of template corresponding to this type press Edit template button. All the above commands are available from the context menu activated by right click at the template name.

Remark The following template types are not edited:

• S1000D Procedural DM. • S1000D Schedule/DefInspec DM – Inspection definition. • S1000D Schedule/TimeLim DM – Time limits information. • S1000D Fault/AFI DM – Fault isolation procedure.

3.3. Document Template Export And Import

3.3.1. Document Template Export The program provides a possibility to export document templates of following types:

• S1000D Descriptive DM.

• S1000D IPD DM – Illustrated parts data.


• S1000D Schedule/TimeLim DM – Time limits information.

Let us study an example of "Descriptive" document template export. Export is made from Document templates window (Fig. 3.7).

63


Fig. 3.7

To export document template:

1. Select the template name in the left window and press button Export.

2. Select a folder for document template export in Browse window. If necessary create a new folder.

3. Press OK button. After that the program exports the template to the specified folder. In case of successful export the corresponding message will be displayed.

Similarly it is possible to create a document templates library.

3.3.2. Document Template Import It is possible to import only previously exported document template. Import is made from Document templates window. To import document template:

1. Press button Import in the left window.

2. Select the folder containing the template in Browse window. Then OK button will become active. If attempting to select a folder not containing the template, OK button will not be active.

3. Press OK button. Then the program imports the template. In case of successful import the corresponding message will be displayed. If any errors occur during import the window with warning will be displayed.

4. In case of successful import the left window of the document template editor will display a name of imported template.

64


65

3.4. Creation Of "Illustrated Parts Data" Document Template

3.4.1. Structure Of Mandatory Data About Item According To The Standard ASD S1000D

The standard ASD S1000D describes the structure of mandatory and not mandatory data about items included in the catalog. This section describes creation of catalog template containing only mandatory data about item. A structure of mandatory data about item is shown in the table.

Table 3-2

Data element name Text element identifier

Remarks

Item number and item number variant.

ITEM Identifies a position number (and variant of position number, if any) of parts or assembly in illustration (for illustrated catalogs).

Quantity per next higher assembly. QNA Quantity of items in next higher assembly

NATO supply code for manufacturers.

MFC NATO supply code for commercial and state companies (NCAGE). Consists of 5 alphanumeric symbols. E.g. KZ999. It is possible to use other codes for organizations instead of NCAGE, e.g. All Russian Classification of Enterprisers and Organization code.

Part number. PNR Used to identify item assigned by originator.

Description. DFP Used for item description. It should include a noun defining the item, and corresponding definition

NATO stock number. NSN

Generated according to the rules: − The first group of numbers (4 symbols) – code classifying delivery. The first two symbols designate a group of product (NSG), all four symbols – a class of product (NSC) according to NATO supply items classifier. − The second group of numbers (2


66

Data element name Text element Remarks identifier

symbols) – a country code. − The third group (7 symbols) is a unique identifier assigned to the item. e.g. NSN: 1620-57-109-8165 It is possible to use Federal stock number (FSN) instead of NSN.

There are two more mandatory catalog attributes according to ASD S1000D. When developing a parts catalog in TG Builder module these mandatory attributes are not intended for entering by user, they are created automatically by the software (Table 3-3).

Table 3-3

Data element name Text element Identifier

Remarks

Indenture. IND This numeric code represents an item hierarchy level in specification for illustration and can be equal from 1 to 9.

Item sequence number. ISN The first two symbols contain a serial number starting with "00" and then with step 5. The third symbol contains an alphanumeric code of variant. It is possible to see ISN value when viewing XML file of the parts catalog if corresponding viewing styles are available.

"IND" and "ISN" attributes are not entered to the catalog template. Information about them is given to understand a process of catalog development.

3.4.2. Creation of "Illustrated Parts Data" Document Template Continue working in Document templates dialog window. To create "Illustrated parts data" document template:

1. Press Create a template button in the toolbar of the left window. Template dialog window will be displayed (Fig. 3.8).

2. Enter a template identification: "IpdDM" and a name: "Illustrated parts data".


Fig. 3.8

3. Indicate a type of "S1000D IPD DM – Illustrated parts data" template.

4. Select Use codification option. Load "Data module code" coding scheme similar to the "S1000D Descriptive DM" document template (see subsection "Creation Of Document Template For Descriptive Data Module" section 3.2).

5. Press button . The created document template will be displayed in a template list in Document templates window and will be immediately opened for editing (Fig. 3.9).

67


Fig. 3.9

The electronic catalog template editor window includes three parts:

• The top left window is intended for adding and editing catalog (attribute) fields.

• The lower window displays a catalog pivot table type separately for printing (Print tab) and viewing on PC screen (Viewing tab).

• The top right window is used to create a type of catalog card. The electronic catalog is a list of items of similar attribute set presented as a table. Each column contains cells with certain type of field (attribute). The catalog template editor automatically creates four mandatory attributes of electronic catalog (Fig. 3.9):

• Description.

• Part number.

• Code.

• Item number These fields can not be deleted. Fields order in the list defines an order of columns in the pivot table. User creates other attributes (fields) for columns in electronic catalog editor.

Rules for "Illustrated parts data" document template creation Then TG Builder module develops parts and assemblies catalog based on the created catalog template. To perform correct export from the TG Builder module in XML format it is required to develop a catalog template according to the particular rules.

68


A rule for catalog template development is the following: a name of catalog attribute should begin with text identifier of attribute according to ASD S1000D and continue by its name in brackets. E.g. "DFP (Description)". Edit parameters of four automatically created mandatory attributes of electronic catalog. Assign names for them according to the rules:

• Replace the name "Description" with "DFP (Description)".

• Replace the name "Part number" with "PNR (Part number)".

• Replace the name "Code" with "NSN (NATO stock number)".

• Replace "Item Number" with "ITEM (Item number)".

Catalog attributes parameters editing Continue working in List setting window:

1. Select Description attribute in List setting window (Fig. 3.9). 3. Press button in the toolbar. Then Record attribute window shown in

Fig. 3.10 will be displayed. 4. Change the attribute name into "DFP (Description)" in Name field in "English" tab

(Fig. 3.10). 5. In Description field enter an attribute description: "It is used to hold a detailed

Description For a Part (DFP). This should be the identifying noun of the item followed by and appropriate adjective and further details if necessary".

6. To display the attribute and its value in the catalog table when viewing and printing it use Use in the list pivot table option. This option is available in Viewing and Print tabs. This option is enabled by default for automatically created mandatory attributes. In Inscription in the table headline section Name field automatically displays names entered to Name field for the attribute. If necessary it is possible to change these values. Viewing and Print tabs (in the lower part of the window) display the attribute name when viewing and printing catalog – Description. Leave it without any changes.

7. Set a width of column in the pivot catalog table in Viewing and Print tabs.

69


Fig. 3.10

8. Press button . Then you will return to List setting window.

Similarly edit the attributes:

• For Part Number attribute enter name "PNR (Part number)", when viewing and printing a name in table headline – "Part number".

• For Code attribute enter name "NSN (NATO stock number)", when viewing and printing a name in table headline – "NSN".

• For Item number attribute enter name "ITEM (Item number)" when viewing and printing a name in table headline – "Item number".

After editing the catalog attribute parameters the electronic catalog template in List setting window will have the appearance as shown in Fig. 3.11.

70


Fig. 3.11

Adding attribute to catalog The mandatory data about item include two more attributes: "QNA (Quantity per next higher assembly)" and "MFC (NATO supply code for manufacturers)". Let us study addition of new attributes to the catalog by the example of attribute "QNA (Quantity per next higher assembly)". To add an attribute (field):

1. Press Add an attribute button in the toolbar of the top left window. Record attribute dialog window will be displayed.

2. Enter a name of attribute "QNA (Quantity per next higher assembly)" and its description "Quantity per next higher assembly" in "English" tab.

3. Open the drop-down list in Attribute type window (Fig. 3.12).

71


Fig. 3.12

Type of catalog attribute (field) There are 7 types of attributes for selection:

• Ordinal number type specifies that the field value will be number in pivot table in series.

• Position on the diagram type sets correspondence of catalog elements with positions on illustrations and callouts in 3D models.

• Line type indicates that the field value is a line.

• The field value will be set of lines for Text type.

• Figure type indicates that the field value is an illustration in supported formats.

• Reference type indicates that the field value is a reference to document.

• Code type designates the field value as code by selected coding scheme.

Perform the following procedures in Record attribute dialog window:

1. Select a type of Line attribute.

2. A part of catalog data is intended for visualization, another part performs service functions and further will be hidden from user. To see the attribute and its values when viewing and printing catalog select Use in the list pivot table option separately for each tab: Viewing and Print. In Inscription in the table headline section of the "English" tab Name field automatically displays names entered to Name field for the attribute. Change these values into "Quantity".

3. Enter a width of column in the catalog pivot table.

An example of Record attribute dialog window is shown in Fig. 3.13.

72


Fig. 3.13

Let us study several parameters in Record attribute window.

• Key attribute is intended for preventing repetition of information entered to the catalog fields when developing catalog in TG Builder module.

• Displayed attribute. When selecting this parameter the catalog field content is displayed when setting references from data module to catalog position. Creation of such references is described in "EOD software module 2.6" User Guide. Name, Identification and Code attributes are displayed by default.

• Value list. This parameter selection allows entering several values from the set list to the catalog field.

It is not necessary to create a value list for the attribute under study. Creation of value list will be further necessary for other catalog attributes. To create a value list:

73


1. Press button Possible attribute values under the option name. Herewith Fixed values window (Fig. 3.14) will be displayed.

Fig. 3.14

2. When selecting Use only specified values option it will be possible to enter only values from the list to the catalog field. If the option is not selected, than it is allowed to enter random values as well as values from the list.

3. Press Add button in the right part of the window. Herewith Fixed value window will be displayed. Enter a value and its code in "English" tab (Fig. 3.15).

Fig. 3.15

4. Press button .

5. Create the whole value list.

6. Press button in Fixed values window. Herewith you will return to Record attribute dialog window (Fig. 3.13).

7. Press button in Record attribute dialog window. Then you will return to the catalog template editor window (Fig. 3.16).

74


Fig. 3.16

The field list of the top left window will display "QNA (Quantity per next higher assembly)" catalog attribute. To edit attribute properties use button , for deletion of attribute use button .

Similarly create catalog attribute:

"MFC (NATO supply code for manufacturers)", attribute type – Line, enable Use in the list pivot table switch, when viewing and printing name in table headline – "Manufacturer". In Print tab enable Maximum width option. It is required for one attribute in the template.

Change the order of attributes according to the standard ASD S1000D:

• ITEM (Item number).

• QNA (Quantity per next higher assembly).

• MFC (NATO supply code for manufacturers).

• PNR (Part number).

• DFP (Description).

• NSN (NATO stock number). To change position of catalog attribute in the left hand window list use mouse and drag a rectangle containing its name to the desired place. The electronic catalog template in List setting window will be displayed as shown in Fig. 3.17.

75


Fig. 3.17

The created electronic catalog template will be used further to develop a parts catalog in TG Builder module. Similarly it is possible to create a full catalog template containing mandatory and optional attributes according to the standard ASD S1000D.

Catalog pivot table view setting The lower editor window displays a catalog pivot table separately for viewing on the PC screen and printed representation (Fig. 3.17). For selection left-click at the corresponding shortcut. A catalog attribute column width in the pivot table is set when creating the corresponding attribute in Record attribute dialog window. It is possible to change a width of displayed columns in the catalog pivot table. For this purpose drag the separator on the table headline. A column width is displayed with blue digits between dimensional callouts. It is also possible to rearrange columns of the pivot table. For this purpose set mouse cursor to the column heading, press left mouse button and move the heading (and the whole column) to the other place.

Catalog printing setting The lower part of Print tab displays the current settings for printing. To change them press button

in the right bottom corner of the tab. Then Catalog print options dialog window (Fig. 3.18) will be displayed.

76


Fig. 3.18

The window has one Print tab. Parameters of print setting are given in three sections:

• Table format. It is possible to select format and orientation of sheet on which the catalog table will be printed. When selecting А4W option (wide) table will be printed without fields.

• Table of specification. It is possible to set printing of catalog specification heading.

• Empty back pages. It is possible to disable printing of empty pages when printing catalog specification or illustration at duplex printing. Options are selected by default.

Catalog card type creation A type of catalog card is generated in the top right editor window. A catalog card consists of catalog fields set and is a usual document that can be edited using tools located above the catalog card content window. The editor is similar to the descriptive data module editor (see "EOD software module 2.6" User Guide). Let us study creation of catalog card. To send catalog fields to the card:

1. In the top right window editor in "English" tab enter the text: "Description – ".

2. In the top left window move the cursor to icon in the catalog attribute rectangle .

3. Use the left mouse button, press the icon, hold it and drag the rectangle to the top right window. Herewith the window will display a field with catalog attribute name.

4. Send necessary attributes to the catalog card. An example of the catalog card generated according to the requirements of the standard ASD S1000D is shown in Fig. 3.19.

77


Fig. 3.19

An example of catalog card when viewing the catalog in TG Browser system is shown in Fig. 3.20.

Fig. 3.20

Order parameters generation In TG Builder module electronic catalog is developed based on a catalog template. The created catalog can be viewed in TG Browser module. This module provides a user-friendly system of

78


component items order from the viewed catalog and generation of order form in electronic form. A filling of order form depends on attributes set for order at the stage of electronic catalog template creation in TG Designer module. To generate order parameters:

1. Press button in the toolbar of the top left window. Order parameters editing dialog window will be displayed (Fig. 3.21).

Fig. 3.21

2. The order parameters are a set of catalog attributes.

79


3. Select attribute "DFP (Description)" in Attributes available window in "English" tab and

press Add the attribute to order button. In this case the specified attribute will be transferred to Order attributes window.

4. Select attribute "DFP (Description)" in Order attributes window. It enables By default and Enter options in Column parameters section in item 1. Name specified in order form (Fig. 3.22).

5. Enter radio button is activated by default. Enter "Description" in the corresponding field (Fig. 3.22).

Fig. 3.22

6. In Column parameters section in item 2. Column type the drop down list displays the types available for selection (Fig. 3.23). Leave type Line (by default).

80


Fig. 3.23

7. In Column parameters section in item 3. Column width select Automatically select column width option. When selecting Width (in characters) option a column width is entered in the window manually.

8. Similarly transfer the following attributes to the order attributes: • PNR (Part number) – enter "Part number" to Enter field. • NSN (NATO stock number) – "NATO stock number". • MFC (NATO supply code for manufacturers) – "Manufacturer". • QNA (Quantity per next higher assembly) – "Quantity".

9. Select Quantity element in the right column.

10. In Column parameters section in item 2. Column type select "Quantity" type in the drop down list.

11. Check the flag in Sum up by column option.

An example of entered into Order parameters editing window parameters is shown in Fig. 3.24.

81


Fig. 3.24

Example of order form generated in TG Browser module is shown in Fig. 3.25.

Fig. 3.25

82

Press Apply button in Order parameters editing dialog window.


Exit the electronic catalog editor saving document changes. Then you will return to Document templates dialog window (Fig. 3.26).

Fig. 3.26

The left part of Document templates window displays identification and name of created template "Illustrated part data".

To change the template use Edit template button. Use Delete the template button to delete the template. To move templates in the list use Move Up and Move Down buttons.

3.5. Creation of "Procedural" Document Template Continue working in Document templates dialog window. To create "Procedural" document template:

1. Press Create a template button in the toolbar of the left window. Herewith Template dialog window will be displayed (Fig. 3.27).

2. Enter a template identification: "ProceduralDM" and a name: "Procedural".

3. Specify a type of "S1000D Procedural DM" template.

83


Fig. 3.27

4. Select Use codification option and load coding scheme as described in subsection "Coding schemes application" section 3.2.

5. Press button . Then you will return to Document templates dialog window.

The left part of Document templates window displays identification and name of created "Procedural" template (Fig. 3.28).

Fig. 3.28

A content of "Procedural" document template is not edited. It is possible to edit template properties using Template properties button. Use Delete the template button to delete the template.

84


3.6. Templates of Documents for Item Maintenance Planning

When creating documents for item maintenance planning the following document templates types are used:

• S1000D Schedule/TimeLim DM – Time limits information;


3.6.1. "Time Limits Information" Document Template Creation

Document template creation Continue working in Document templates dialog window. To create "Time limits information" document template:

1. Press Create a template button in the toolbar of the left window. Herewith Template dialog window will be displayed.

2. Enter a template identification: "TimeLimDM" and a name: "Time limits information" (Fig. 3.29).

3. Specify a type of template "S1000D Schedule/TimeLim DM – Time limits information" (Fig. 3.29).


85


Fig. 3.29

5. Press Apply button. Herewith Print setup dialog window will open (Fig. 3.30).

86


Fig. 3.30

Print setup Print setup window contains 2 tabs:

• Columns.

• Options.

"Columns" tab The tab contains 3 windows:

• Displayed columns.

• Available columns.

• Page width.

87


In Displayed columns window the columns which are visible in the printed document are displayed. Required columns which cannot be deleted from the list are marked with "+" sign. It is possible to move from Available columns window to Displayed columns window all columns

using button or selected column using button .

Use and buttons to move the columns added in Displayed columns window back to Available columns window. Use and buttons to change relative position of the columns in the window. The changes are displayed in the lower window where table printed representation is displayed. Use button to enter or change the column name in table printed representation, for example, enter a shortened name to provide table arrangement on the sheet of required format. Let us study entering the shortened column name, for example for "Identification" column:

1. Select "Part number" name in Displayed columns window.

2. Press button . Then Name change window will be displayed (Fig. 3.31).

Fig. 3.31

3. In Name change window enter the shortened name, for example "PN". Respectively, the column name in table printed representation will be changed (Fig. 3.32).

88


Fig. 3.32

Use button to restore the column name set by default. This button is not active for columns with unchanged name. Use button to change the column width. When it is pressed Column width change window is displayed (Fig. 3.33).

Fig. 3.33

Enter the value to Enter column width field from the keyboard. To confirm the entered value press OK button. The entered changes are displayed in the lower window where table printed representation is displayed. It is possible to change the columns width in the printed representation by dragging boundaries between columns headings in the lower window. Use Page width radio buttons group to set the size and sheet location on which the table will be printed. All changes are displayed in the lower window.

Remark: Name column width is highlighted with red (Fig. 3.32). It cannot be changed using Width button or dragging its right boundary in Page width window. This column fills all page width remaining after other columns. The width of this column can be changed only by changing the width of other columns.

"Options" tab In Print settings window go to Options tab (Fig. 3.34).

89


Fig. 3.34

The tab contains 3 sections for parameters entry:

• Show sections. Checking/unchecking of any flag leads to printing/unprinting of the corresponding section.

• Table name. Leave the standard table name or enter your name.

• Lead In Text. Short text can be entered. When being printed lead in text is located between the main section name and the main table.

The buttons in the lower part of the window allow loading parameters from the file or saving the selected settings to file. After entering all parameters press button. Then all settings will be saved and you will

return to Document templates window. Press button to close Print settings window without saving the changes. The left part of Document templates window displays identification and name of created "Time limits information" template (fig. 3.35).

90


Fig. 3.35

To edit print settings select "Time limits information" document template name and press button

. A content of "Time limits information" document template is not edited. It is possible to edit template properties using Template properties button. Use Delete the template

button to delete the template.

3.6.2. "Inspection Definition" Document Template Creation Continue working in Document templates dialog window. To create "Inspection definition" document template:

1. Press Create a template button in the toolbar of the left window. Herewith Template dialog window will be displayed

2. Enter a template identification: "DefInspecDM" and a name: "Inspection definition" (Fig. 3.36)

3. Specify a type of "S1000D Schedule/DefInspec DM – Inspection definition" template (Fig. 3.36).

91


Fig. 3.36


5. Press button. Inspection definition print options dialog window will be displayed (Fig. 3.37).

92


Fig. 3.37

6. Inspection definition print options window displays settings which allow including contents, table list and inspection names in printed document; setting a table name with task list. Here user creates settings which will be used by default when calling this dialog window in TG Builder module.

7. Press button . Then you will return to Document templates dialog window. The left part of Document templates window displays identification and name of created template "Inspection definition" (Fig. 3.38).

Fig. 3.38

To edit print settings select "Inspection definition" document template name and press button

. Inspection definition print options window will open, here it is possible to edit print settings. A content of "Inspection definition" document template is not edited. It is possible to edit template properties using button Template properties . Use Delete the template button to delete the template.

93


3.7. Creation of "Fault isolation procedure" document template

Continue working in Document templates dialog window. To create "Fault isolation procedure" document template:

1. Press Create a template button in the toolbar of the left window. Herewith Template dialog window will be displayed.

2. Enter a template identification: "FaultDM" and a name: "Fault isolation procedure" (Fig. 3.39).

3. Specify a type of "S1000D Fault/ AFI DM – Fault isolation procedure" template (Fig. 3.39).

Fig. 3.39

3.2.

The left part of Document templates window displays identification and name of created template "Fault isolation procedure" (Fig. 3.40).

94

4. Select Use codification option and load coding scheme as described in subsection "Coding schemes application" of section 3.2.

5. Press Apply button. Then you will return to Document templates dialog window.


Fig. 3.40

Content of "Fault isolation procedure" document template is not edited. It is possible to edit template properties using Properties button. Use Delete the template button to delete the template. Exit Document templates editor saving the changes. Then you will return to Technical manual template window.

3.8. Maintenance Inspection Creation

3.8.1. Entering Inspection Definition Editor The program is provided with an option to create maintenance inspections in the project template. To enter the inspection definition editor press Inspection definition templates icon in Technical manual template window (Fig. 3.41). Then Inspection definition editor window will be displayed (Fig. 3.42).

Fig. 3.41

95


Fig. 3.42

The editor consists of two windows:

• The left window is intended for operation with maintenance inspections.

• The right window is used to create type of operation and operation conditions included in the maintenance inspection.

3.8.2. New maintenance inspection creation To create a new maintenance inspection:

1. Press Add button in the left Inspection definition editor window. Then New form window will open (Fig. 3.43).

Fig. 3.43

2. Enter a name of created inspection, e.g. "Inspection А".

3. Press OK button. Then it will return to Inspection definition editor window, left window of which will display a name of created maintenance inspection (Fig. 3.44).

96


Fig. 3.44

Pressing button displays Form editing window where it is possible to edit a name of inspection. Button deletes the inspection. Before deleting the inspection the system displays a window with a confirmation request shown in Fig. 3.45.

Fig. 3.45

3.8.3. Creation of new record in maintenance inspection To create a new record in maintenance inspection:

1. Select a name of maintenance inspection "Inspection А" in the left editor window.

2. Press Add button in the right window. Then Record addition dialog window will be displayed (Fig. 3.46).

97


Fig. 3.46

This window sets a type of operation and conditions of operation. There are three operation types for selection:

• Perform periodically.

• On condition.

• Perform once. Subject to the selected type of operation the following data are entered:

• Regularity.

• Preparation type.

• Text description. Task type selection is performed by activating of the corresponding radio button.

Periodic tasks If Perform periodically task type is selected the threshold interval is set in Threshold input field and interval limits are set in "+" and "-" fields. The required values are entered from the keyboard or set with buttons. In Unit of measurement field the interval unit of measurement is set. Enter a value of interval "1000,00" and limits "+100" and "-200".

98


Remark Unit of measurement field is active to enter data when changing default data "0,000" in Threshold field.

"Unit of measurement" field Unit of measurement of threshold interval is entered in this field. Name of unit of measurement may be entered from the keyboard. If the system "recognizes" such a unit, the window with units of measurement containing entered symbol(s) will be displayed. In Fig. 3.47 shows an example when symbol "h" is entered to Unit of measurement field. The system suggests all known units of measurements starting with "H". It is possible to agree with the suggested selection clicking the desired unit of measurement with left mouse button or continue entering name of unit of measurement, if it differs from those suggested by the system.

Fig. 3.47

Unit of measurement window may also be called by pressing button to the right of Unit of measurement field.

Units of measurement window Let us study options provided by units of measurement window. A general view of the window is shown in Fig. 3.48.

99


Fig. 3.48

Unit of measurement list display mode may be changed. For this purpose add Display as a tree option. Then units of measurement window will have the appearance as shown in Fig. 3.49.

Fig. 3.49

100


Threshold editor If a required unit of measurement is not available it may be created in the interval editor. Press Open Threshold editor button in the units of measurement window to activate interval editor. Then Threshold editor dialog window will be displayed (Fig. 3.50).

Fig. 3.50

A window for language selection is provided in the bottom of the dialog window. A list of available languages is displayed by button pressing. Select "en English" language. Then information concerning units of measurement will be displayed in the selected language.

Remark

A sign on the right from heading of Description column indicates that ascending sorting is selected. It is possible to select ascending or descending sorting by any column. For this purpose click the column heading.

Tools for settings export and import are provided in the top of the dialog window:

• Global settings export.

• Global settings import.

• Export of project settings.

• Import of project settings.

101


Interval editor dialog window contains three tabs:

• Units of measurement.

• Unit types.

• Dictionary of replacements. Load default data button is located in the right top part of Threshold editor window. This tool enables returning to the values of measurement units preset in the system by default. When pressing the button the system displays a window with request (Fig. 3.51).

Fig. 3.51

Selecting "Yes" restores default settings.

Tools for Settings Export and Import When Global settings export or Export of project settings button is pressed, Enter file name for export of settings window opens. XML-file with the entered name is saved in a selected folder. The difference of the tools is that when Global settings export button is pressed, all units or measurement (from the left window of Measurement units tab) are exported, and when Export of project settings button is pressed, only project units of measurement (from the right window) are exported. When Global settings import or Import of project settings button is pressed, Open window opens where a file with previously saved settings can be selected. When Global settings import button is pressed, import of all units of measurement to the left window of Units of Measurement tab is performed, while when Import of project settings is pressed, project units of measurement are imported to the right window.

"Measurement units" tab The general view of the tab is shown in Fig. 3.52.

102


Fig. 3.52

All units of measurement are given in the left window, and units of measurement of the current project are given in the right window. It is possible to transfer a unit of measurement from the left window to the right one using drug&drop mechanism or Add tool. Group transfer operation is allowed. In Fig. 3.53 shows Measurement units of the project window filled with units of measurement.

Fig. 3.53

Tools enabling performing operations with units of measurement are located to the right of each window. Tools of All units window and their short description are given in the table below.

Table 3-4

103


Button Description

Add tool is used to create a new unit of measurement.

Edit tool is used to change features of a unit of measurement.

Delete tool is used to delete a unit of measurement. The system either issues a request to confirm the selected element deletion or disables deletion. Grouped delete operation is allowed.

Type tool is purposed to select a type of measurement unit from the drop-down list.

The above tools are duplicated by contex menu commands activated by right-click at the selected unit of measurements. Tools of Measurement units of the project window and their short description are given in the table below.

Table 3-5

Button Description

Add tool is used to transfer a unit of measurement from All units window to Measurement units of the project.

Delete tool is used to delete a unit of measurement from the project.

Edit tool is used to change features of a unit of measurement.

Move up tool is used to move a selected unit of measurement up in the list of measurement units.

Move down tool is used to move a selected unit of measurement down in the list of measurement units.

Find the unit tool is used to find a selected project measurement unit in the global list of units of measurement.

The above tools are duplicated by contex menu commands activated by right-click at the selected unit of measurements.

104


"Unit of measurement" window When creating or editing units of measurement their characteristics are entered to Unit of Measurement window. Unit of measurement window is called from Measurement units tab by Add or Edit tools. Let us study an example of editing unit of measurement "years". In Measurement units tab select unit of measurement "years" and press Edit button. Then Unit of measurement window will be displayed (Fig. 3.54).

Fig. 3.54

Editor tab displays the following parameters of units of measurement:

• Identifier. ID of unit of measurement is displayed in Identifier field. User cannot change a value assigned by the system.

• Type. It is possible to change value of Type field selecting other value from the drop down list when pressing button on the right from the input field.

105


• Unit of measurement description in different languages. To enter or change description of unit of measurement description in some language, double left-click at a respective language line.

• Display of unit of measurement for numerals ending with 1; except 11.

• Display of unit of measurement for other numerals.

• Display of unit of measurement for numerals ending with 2, 3, 4; except 12, 13, 14.

To edit unit of measurement description in English:

1. In Unit of measurement window in Edit section select a line of parameters for English (Fig. 3.54).

2. Double left-click at the selected line or press Edit… button. Then Unit of measurement – English window will open (Fig. 3.55).

Fig. 3.55

3. Check Differentiate text messages for different values flag.

106


4. Enter display of unit of measurement for different numerals (Fig. 3.56).

Fig. 3.56

The unit of measurement can be displayed either as text or as mathematic formula. An editor similar to MS Word formula editor is purposed for input of units of measurement in a form of formulas. Values entered in the editor upper field get in formula numerator. The bottom field is available for values input if the flag is checked on its left. The bottom field values get in the formula denominator.

5. Press Apply button in Unit of measurement – English window for unit of measurement "years". Then you will return to Unit of Measurement window where entered parameters will be displayed (Fig. 3.57).

107


Fig. 3.57

6. Press Apply button. Values entered in Description, Type, and Display fields are shown in Description, Type, and Visualization columns in Measurement units tab (Fig. 3.58).

108


Fig. 3.58

"Units types" tab Go to Units Types tab in Threshold Editor dialog window (Fig. 3.59).

Fig. 3.59

Units types tab is purposed to create and edit the units types. The right part of the window contains tools enabling to carry out operations with untis types:

• Pressing Edit button results in Type window opening, parameters of a selected element are entered in the window.

• After Delete button pressing the system generates a request to confirm deletion of a selected element or elements. Group delete operation is allowed.

109


• Relative position of elements of measurement units types list can be changed with the use of Move up and Move down buttons.

• Pressing Add button results in Type window opening where parameters of a new type of units of measurement are entered (Fig. 3.60).

Fig. 3.60

A value of the created type of units of measurement, e.g. Maintenance time, becomes an element of the drop-down list of Type field of Unit of measurement window discussed in the previous section (Fig. 3.61).

110


Fig. 3.61

The value of a new type of units of measurement Maintenance time will be also displayed in the list of measurement units types in All units window (Fig. 3.62).

Fig. 3.62

"Dictionary of replacements" tab Go to Dictionary of replacements tab in Threshold Editor dialog window (Fig. 3.63).

111


Fig. 3.63

Dictionary of replacements tab is purposed to replace unit of measurement values. The right part of the window contains tools enabling to carry out operations with untis of measurement:

• After Delete button pressing the system generates a request to confirm deletion of a selected element or elements. Group delete operation is allowed.

• Relative position of elements in units of measurement values list can be changed with Move up and Move down buttons.

• Pressing Add and Edit buttons results in Replaced unit window opening which is empty in the first case and filled with parameters of a selected element in the second case (Fig. 3.64).

Fig. 3.64

Exit from the threshold editor To close Threshold editor window press Х in the right upper corner of the window. Then request to confirm changes saving will be displayed. After confirming saving of changes or canceling the changes you will return to Record addition window. Press Apply button in Record addition window. Then you will return to Inspection definition editor window. Then in Limits window the entered data about periodic operations will be displayed (Fig. 3.65).

112


Fig. 3.65

Preparation for flights Let us return to creation of a new entry in maintenance inspection. To create a new entry in maintenance inspection:

1. Select a name of maintenance inspection "Inspection А" in the left Inspection definition editor window.


Fig. 3.66

3. When selecting On condition task types Preparation type field becomes active for data entering. A type of preparation is selected from the drop down list opened after pressing button on the right from the field (Fig. 3.66).

113


4. Press button in Record addition window. Then you will return to Inspection definition editor window Then in Limits window the entered data will be displayed (Fig. 3.68).

Perform once To create a new entry in maintenance inspection:

1. Select a name of maintenance inspection "Inspection А" in the left Maintenance inspection editor window.


3. When selecting Perform once task type the text input window and text editing tools will be available (Fig. 3.67).

Fig. 3.67

4. Upon record editing completion in Record addition window press Apply button. Then you will return to Inspection definition editor window. In Limits window the entered data will be displayed (Fig. 3.68).

114


Fig. 3.68

The Limits window shows types of tasks and specified conditions (Fig. 3.68).

Using tools located on the right from the Limits window it is possible:

• To add new conditions.

• To edit the existed conditions.

• To delete undesired conditions.

• Change position of conditions relative to each other. The created maintenance inspection can be used to develop maintenance inspections in TG Builder module. Close Inspection definition editor selecting a required answer in displayed Confirmation window. Then you will return to Technical manual template window.

115

Template Structure Editor

Chapter 4. Template Structure Editor A structure of technical manual project is defined by the selected template. This chapter describes creation of technical manual template structure. A template structure is developed in Structure template editor and includes:

• definition of elements types included in the template and their possible number,

• setting hierarchy of elements in the structure and their order,

• selections for coding scheme elements. Continue working with "AIRCRAFT-2010" template.

4.1. Getting Started Proceed as follows to open a template:




4. In Browse window select the folder name "AIRCRAFT-2010", open it and press OK. Then Technical manual template dialog window will be displayed, it contains information about "AIRCRAFT-2010" template.

To enter structure template editor press Structure template icon in Technical manual template dialog window. Structure template dialog window will open (Fig. 4.1).

Remark

Using icons in the left part of Structure template window it is possible to switch quickly between this window and other opened windows.

116


Fig. 4.1

The structure template editor window is separated into two parts and consists of several toolbars.

• The left window displays structure tree of technical manual.

• The right window is intended for adding and deleting template structure elements.

4.2. Template structure development Before starting template structure generation let us study the elements of which it is created.

4.2.1. Template structure elements The template structure is a complex of hierarchically structured elements which can contain other elements. Technical manual is always on the top level (Fig. 4.2).

Fig. 4.2

The technical manual may include the following elements (Fig. 4.3) ):

• Publication is an electronic technical publication which is an analog of book in paper package of documentation. The publication can include sections and data modules.

• Section can include other sections and data modules.

• Data module is an electronic document that is smallest independent information unit, as part of electronic documentation.

117


Fig. 4.3

A project template is a structured combination of Publications, Sections and Data modules. Beside template element creation it is named and assigned with a coding scheme.

Beside the elements the structure includes indicators of SGML language defining a number of possible child elements for a structure element. Description of indicators is shown in table.

Table 4-1

Icon

Description

Indicator of "zero or one" type. Availability of indicator shows that structure element can contain one child element or not contain it.

Indicator of "zero and more" type. Indicator shows that structure element can contain any number of child elements or not contain them at all.

Indicator of "one and more" type. This indicator shows that structure element may contain a number of child elements not less than one.

4.2.2. Template structure generation Let us return to Structure template dialog window (Fig. 4.4).

Fig. 4.4

118


119

The structure template editor automatically creates a root template element – Technical manual. During generation of template structure the following elements are added to it: publications, sections and data modules. Technical manual may comprise the following:

• The first case. One manual, for example, operation manual.

• The second case. Several manuals, for example, Operation Manual, Troubleshooting Manual, Manual on non-destructive test methods.

The template structure depends on Technical manual composition. In the first case the template structure will include the following elements:

• System (structure element type – Section).

• Sub-system (structure element type – Section).

• Unit (structure element type – Section).

• Part (structure element type – Section).

• Data module (structure element type – Data module). In the second case the template structure will include the following elements:

• Manual (structure element type – Publication).

• System (structure element type – Section).

• Sub-system (structure element type – Section).

• Unit (structure element type – Section).

• Part (structure element type – Section).

• Data module (structure element type – Data module).

Let us study creation of template structure for the first case when Technical manual consists of one technical manual, e.g. operation manual.

"System" structure element creation To add the first structure element to Technical manual:

1. Select the root element Technical manual in the left window.

2. Press Add element button in the toolbar of the right window. Herewith Element Properties dialog window will be displayed (Fig. 4.5).


Fig. 4.5

3. Select a type of element Section. In this case fields for entering identification and name of element become active.

4. Enter element identification "system". Identification should include the Latin letters (Fig. 4.7).

5. Enter element identification "System".

6. Select Use coding option.

7. To load the coding scheme press button in the right part of Coding scheme window. Then Coding scheme window will be displayed (Fig. 4.6).

120


Fig. 4.6

8. Select "Standard numbering system code" in Coding scheme window (Fig. 4.6).

9. Press Apply button. Herewith you will return to Element properties dialog window (Fig. 4.7).

Fig. 4.7

121


10. Coding scheme field will display a scheme name and special fields to enter code under it. When developing electronic documentation project in TG Builder module a code of structure element System will be entered to these fields.

11. Select a possible number of child elements from the drop-down list in Quantity window – indicator of "one and more type" (Fig. 4.8). Technical manual should include at least one system.

Fig. 4.8

12. Press Apply button. Herewith you will return to Structure template editor window (Fig. 4.9).

Fig. 4.9

The left editor window displays System element appeared in the template structure tree. The right editor window displays the current element structure, i.e. Technical manual. System element was added to it.

"System" structure element editing To edit structure element properties click at its name two times with the left mouse button in the left editor window. Section/Publication Properties dialog window (Fig. 4.10) will be displayed.

122


Fig. 4.10

Make all necessary changes in Section/publication properties window and press button .

"System" structure element development This element will include data module element and Sub-system element.

"Data module" structure element addition 1. In the left window select System element.

2. Press Add element button in toolbar of the right window.

3. Select a type of element Data module (Fig. 4.11) in displayed Element properties dialog window.

4. A window for coding scheme selection for this element type is not available. Coding schemes for data modules are selected when creating document templates. This information is given the third chapter.

5. Select a possible number of child elements from the drop-down list in Quantity window – indicator of "zero and more" type (Fig. 4.11).

123


Fig. 4.11

6. Press button . Then you will return to Structure template editor window.

"Sub-system" structure element addition Add one more element to System structure element:

1. In the left window select System element.

2. Press Add element button in toolbar of the right window. Element Properties dialog window will be displayed.

3. Select a type of element Section. In this case fields for entering identification and name of element become active.

4. Enter element identification "subsystem". Identification should include the Latin letters (Fig. 4.13).

5. Enter element name "Sub-system".

6. Select Use coding option. To load the coding scheme press button in the right part of Coding scheme window. Then Coding scheme window will be displayed (Fig. 4.12).

124


Fig. 4.12

7. Select Sub-system code code field from "Standard numbering system code" group in Coding scheme window (Fig. 4.12).

8. Press button . Herewith you will return to Element properties dialog window.

9. Select a possible number of child elements in the open list in Quantity window – indicator of "zero and more" type (Fig. 4.13).

Fig. 4.13

125


10. In Element properties window (Fig. 4.13) press button . Herewith you will return to Structure template editor window (Fig. 4.14).

Fig. 4.14

The left window in structure tree displays branch till the second sublevel, i.e. tree is divided into modules per two levels. Structure shown in Fig. 4.14 represents the following:

• Technical manual includes System element. • System includes the following elements Data module and Sub-system.

The right editor window displays the current element structure, i.e. System element (Fig. 4.14). The section becomes current after selecting it in the left window.

Remark

In the left window only one section can be current, it should be able to contain or already contains subsections. It is impossible to select a section in the second level of this unit branch.

"Sub-system" element structure development Sub-system element will include the following elements:

• Data module

• Section named "Sub-system" (similar to created before).

• Section named "Unit".

"Data module" structure element addition Add Data module element to Sub-system element similarly to section ""System" structure element development".

126


"Sub-system" structure element addition Add the following element to Sub-system element:

1. In the left window select Sub-system element.

2. Press Add element button in toolbar of the right window. Element Properties dialog window (Fig. 4.15) will be displayed.

Fig. 4.15

Set element application Sub-system element is already created when developing System element structure. In such cases a new element is created as Set element. Set elements are publications, sections, data modules and document templates which were created before and already included in the structure or list of document templates. To enter a set element:

1. In Element properties dialog window select a type of element Set element (Fig. 4.15).

2. Open the list of set elements (Fig. 4.16).

127


Fig. 4.16

3. Select Sub-system element from the list.

To complete filling element properties select a possible number of child elements in Element properties window in Quantity field – indicator of "zero and more" type (Fig. 4.17).

Fig. 4.17

Press Apply button. Then you will return to Structure template editor window. Elements Data module and Sub-system are added to Sub-system element as set element (Fig. 4.18).

128


Fig. 4.18

Add the third element to Sub-system.

"Unit" structure element addition 1. In the left window select Sub-system element (Fig. 4.18).

2. Press Add element button on toolbar of the right window. Element Properties dialog window will be displayed.

3. Select Section element type. In this case field for entering identification and name of element are active.

4. Enter element identification "unit". Identification should include the Latin letters (Fig. 4.20).

5. Enter element identification "Unit".

6. Select Use coding option. To load the coding scheme press button in the right part of Coding scheme window. Then Coding scheme window will be displayed (Fig. 4.19).

Fig. 4.19

129


7. Select Unit code code field from "Standard numbering system code" group in Coding scheme window.

8. Press Apply button. Herewith you will return to Element properties dialog window.

9. Select a possible number of child elements in the open list in Quantity window – indicator of "zero and more" type (Fig. 4.20).

Fig. 4.20

10. Press Apply button. Herewith you will return to Structure template editor window (Fig. 4.21).

130


Fig. 4.21

Structure shown in the left window represents the following (Fig. 4.21):

• Technical manual includes System element.

• System includes the following elements Data module and Sub-system.

• Sub-system includes elements Data module, Sub-system and Unit. The right editor window displays the current element structure, i.e. Sub-system element.

"Unit" element structure development Unit element will include Data module and Part elements.

"Data module" structure element addition Add Data module element similar to section ""System" structure element development".

"Part" structure element addition To add Part element to Unit element:

1. In the left window select Unit element (Fig. 4.21).

2. Press Add element button in toolbar of the right window. Element Properties dialog window will be displayed.

3. Select a type of Section element. In this case fields for entering identification and name of element are active.

4. Enter element identification "part". Identification should include the Latin letters (Fig. 4.23).

5. Enter element identification "Part".

6. Select Use coding option. To load the coding scheme press button in the right part of Coding scheme window. Herewith Coding scheme window will be displayed (Fig. 4.22).

131


Fig. 4.22

7. Select Disassembly code code field in Coding scheme window (Fig. 4.22).

8. Press Apply button. Herewith you will return to Element properties dialog window.

9. Select a possible number of child elements from the drop-down list in Quantity window – indicator of "zero and more" type (Fig. 4.23).

Fig. 4.23

10. Press Apply button. Then you will return to Structure template window (Fig. 4.24).

132


Fig. 4.24

Structure shown in the left window represents the following (Fig. 4.24):

• Technical manual includes System element.

• System includes the following elements Data module and Sub-system.

• Sub-system includes Data module, Sub-system and Unit elements.

• Unit includes Data module and Part.

The right editor window displays current Unit element structure.

"Part" element structure development Part element will include Data module.

"Data module" structure element addition Add Data module element similar to section ""System" structure element editing" As a result we have a structure shown in (Fig. 4.25).

133


Fig. 4.25

A structure of "AIRCRAFT-2010" template is developed (Fig. 4.25): • Technical manual includes System element. • System includes the following elements: Data module and Sub-system. • Sub-system includes Data module, Sub-system and Unit elements. • Unit includes Data module and Part elements. • Part includes Data module element.

The right editor window displays the current section structure, i.e. Part element. There is no possibility to view the whole template structure in Structure template editor. It is possible in TG Builder module when a project based on the developed template will be developed. The template structure as a whole looks like that shown in Fig. 4.26.

Fig. 4.26

Exit Structure templates editor saving the changes. .

134

Catalog indices

135

Chapter 5. Catalog Indices

TG Browser electronic technical publications viewing module provides an option of information quick search in all data modules of "S1000D IPD DM – Illustrated parts data" type. To perform such search it is required to preliminary create special indices for searching in TG Designer module.

This chapter defines creation of search indices in Catalog indices editor intended for this purpose. The electronic catalog is a list of items of similar attribute set presented as a table. Each column contains cells with certain type of field (attribute). Attributes (fields) for columns are created when document template is created (see section 3.4.2 Creation of "Illustrated Parts Data" Document Template). When creating search indices attributes (fields) used for search are included in them. Continue "AIRCRAFT-2010" template creation.

5.1. Getting started Proceed as follows to open a template:


2. Click TG Designer icon in the Welcome dialog window.

3. Press Open button in TG Designer window.


To enter catalog indices editor press Catalog indices icon in Technical manual template dialog window. Herewith Catalog indices dialog window will open (Fig. 5.1).

Catalog Indices

Fig. 5.1

Catalog indices dialog window consists of three windows: • Indices • Templates and attributes of the current index • Available templates of the current design catalogs and their attributes

5.1.1. "Indices" Window The left editor window displays a list of indices for search created by default – Name, Identification and Code. These indices can not be deleted. New indices are created in the editor window.

5.1.2. "Templates And Attributes of the Current Index" Window The top right window is intended for displaying attributes of the current index. The current is an index selected in the left Indices window. When selecting in the left window any index, the right window will display information about it. Select Identification index in the left window. In this case the right window will show information that this automatically created index is matched with attribute "Identification (PNR)" from all electronic catalogs of "S1000D IPD DM – Illustrated parts data" type contained in this template of technical manual (Fig. 5.2).

136

Catalog indices

Fig. 5.2

5.1.3. "Available templates of the current design catalogs and their attributes" window

The right lower window lists available templates of electronic catalogs (Fig. 5.3).

Fig. 5.3

Available templates are templates of electronic catalogs included in the current template of the technical manual. In this example there is one available template with corresponding attributes – "Illustrated part data" (Fig. 5.3). Attributes (fields) of each available template are given in a form of subtree of elements in template tree. Name of available "Illustrated parts data" catalog template is colored with green. Name column gives names of electronic lists and names of attributes. ID column:

• each catalog has its Identification which is assigned when creating catalog in Document templates editor.

• each attribute has a number assigned when creating attribute in catalog template editor.

137

Catalog Indices

5.2. Catalog index creation To create a new catalog index

1. Press Add index button in the toolbar of the top left window. In this case the index list of left window will display "New index" (Fig. 5.4).

2. Enter index name "MFC (NATO supply code for manufacturers)" above the right window of Name window (Fig. 5.4).

Fig. 5.4

3. The left window updates index name after left mouse button click at any other index name.

4. Select index "MFC (NATO supply code for manufacturers)" in the left window (Fig. 5.5).

5. Specify an attribute corresponding to the selected index in subtree of "Illustrated parts data" template in the right lower window. It is recommended to select attribute of the same name or equivalent. Specify attribute "MFC (NATO supply code for manufacturers)" (Fig. 5.5).

6. Press Add an attribute button in toolbar of the right window. After it the current index in the right top window displays a name of attribute and name of catalog from which it is selected (Fig. 5.5). In ID column there are catalog identification and attribute number set when creating attribute in catalog template editor.

138

Catalog indices

Fig. 5.5

It is allowed and required to add equivalent attributes from different catalogs to one index to perform further search per all catalog types with this attribute. Button deletes incorrectly created or unnecessary attribute/template. For this purpose: Sometimes the attribute of one catalog is equivalent to several attributes of "Illustrated parts data" template NSN (NATO stock number) code is formed from three attributes "NSC (NATO supply class), "NCB (national codification bureau)" and "NIN3TO9 (NATO item identification number)" (Fig. 5.6). In this case it is necessary to add all three attributes to catalog index "NSN (NATO stock number)" (Fig. 5.6).

139

Catalog Indices

Fig. 5.6

Format field is intended for setting a method of attribute display for searching: dash, brackets etc. when searching in catalogs of TG Browser module per complex indices. E.g. enter a value of Format/Type "%s-%s-%s" for the complex NSN index consisting of attributes NSC, NCB and NIN3TO9. It means that to set search line in TG Browser module it is necessary to enter values of required attributes through dash in the search line (Fig. 5.7).

140

Catalog indices

Fig. 5.7

When completing catalog indices generation exit from Catalog indices editor saving changes.

141

Image Editor

142

Chapter 6. Image Editor The system is provided with an option to save frequently used images e.g. organization logotype in the special storage. Any image is saved in the editor one time and inserted into data modules as needed. This chapter describes illustration saving in the editor intended for this purpose. Continue "AIRCRAFT-2010" template creation.



2. Click at TG Designer icon in Welcome dialog window.

3. Press Open button in TG Designer window.


To enter Image editor press Images icon in Technical manual template dialog window. Figures, images and icons dialog window will open (Fig. 6.1).

Image Editor

Fig. 6.1

6.2. Organization Logotype Paste

To load illustration with logotype of organization press button , located on the right from File name field. Select a file in this displayed Open window and press Open button. An organization logotype will be displayed in Enterprise logotype window (Fig. 6.2).

143

Image Editor

Fig. 6.2

It is necessary to follow recommendations and limitations displayed on green background.

6.3. Icons Data Book Creation The image editor is provided with a possibility to create an icon data book for two categories:

• For publication references. Icons are used for descriptive reasons as additional information in publication references. They indicate different properties of publications, e.g. protection against unauthorized viewing, PDF-format of publication file etc.

• For warnings. Icons indicates properties of special units "Caution" и "Warning" in data modules, e.g. radiohazard sign, high voltage sign etc.

Let us study creation of icon data book.

1. Select a category for which image is created, e.g. "For references" in the image editor in Categories window (Fig. 6.3).

144

Image Editor

Fig. 6.3

2. Press button in the toolbar of the left window. Image window will be displayed (Fig. 6.4).

Fig. 6.4

3. Enter data in the following fields:

• Image identifier is a unique identification for image. The field is mandatory for filling in.

• Image description is an unformalized description of image. The field is not mandatory for filling in.

• Control number is a field that is not mandatory for filling in.

4. Press button . Select a file in displayed Open window and press Open button.

145

Image Editor

5. Selected image and its size in pixels will be displayed in Image window. 6. Press button . In this case the right lower editor window will show image

parameters (Fig. 6.5).

Fig. 6.5

To edit an image:

1. Select the image in the right lower editor window.

2. Press button in the toolbar.

3. Change data in Image window.

4. Press button .

To delete icons from the icons data book select it and press button . In the appeared dialog window confirm deletion.

146

Dictionary Editor

Chapter 7. Dictionary Editor This chapter describes dictionary creation in the editor intended for this purpose. The dictionaries are storage objects for abbreviations, terms, names of normative documents and service inscriptions used to created TD project in EOD software module. Dictionaries significantly simplify operations on filling technical manual with information. Dictionary editor creates a dictionary structure and fills it with information. Continue "AIRCRAFT-2010" template creation.






To enter Dictionary editor press Dictionary icon in Technical manual template dialog window. In this case Terms, abbreviations, normative documents, service inscriptions dialog window will open (Fig. 7.1).

Fig. 7.1

Terms, abbreviations, normative documents, service inscriptions dialog window consists of four tabs:

147

Dictionary Editor

• Abbreviations.

• Terms.

• Normative documents

• Service inscriptions Each tab is intended for creating and editing dictionary with corresponding name. There are four types of dictionaries:

• Abbreviations dictionary stores abbreviations and decryptions.

• Terms dictionary is used to store terms and definitions.

• Normative documents dictionary is intended for storing identification and names of normative documents.

• Service inscriptions dictionary is used to store and change inscriptions for dialog windows and commands of TG Builder module.

The first three tabs of Terms, abbreviations, normative documents, service inscriptions dialog window consists of two windows (Fig. 7.1). The left window includes a field of dictionary structure display. The right window is used for dictionary filling with information and its editing.

7.2. Abbreviations Dictionary Creation

7.2.1. Abbreviations Dictionary Structure Creating And Editing Let us study creation of Abbreviations dictionary.

1. Open Abbreviations tab.

2. Press Add a category button in the toolbar of the left window. Category Properties window will be displayed.

3. Enter a name of dictionary "Conventional abbreviations" (Fig. 7.2).

Fig. 7.2

4. Press button . In this case the left editor window will display a name of dictionary (Fig. 7.3).

148

Dictionary Editor

Fig. 7.3

5. To add a section to dictionary select its name in the left window and press Add a category button.

6. Select a name of section "Kvitok-3H" in Category properties window.

7. Add the second section "Briz-PL" to the dictionary. A structure of dictionary will look as shown in Fig. 7.4.

Fig. 7.4

Remark Nesting level of dictionary categories is not limited.

To edit a category name perform the following:

1. Select the category.

2. Press Change category properties button in the toolbar of the left window.

3. Change the category name in Category properties window.

4. Press button . To delete a category from the dictionary structure select is and press Delete the category button. In the appeared dialog window confirm deletion.

Remark When deleting the category its embedded categories and their content are deleted without warning.

149

Dictionary Editor

7.2.2. Filling Abbreviations Dictionary With Information

Abbreviations addition To add abbreviations in the dictionary:

1. Select a category to which it is necessary to add an abbreviation.

2. Press Add abbreviation button in the toolbar of the right window. Enter abbreviation "AUTO" and its decryption in languages that will be used in the project (Fig. 7.5) to Element properties window. Further when viewing project in TG Browser module when setting the cursor to the abbreviation its decryption in corresponding language will be displayed.

Fig. 7.5

3. Press button .

4. Enter the next abbreviation. The right editor window displays a list of entered abbreviations (Fig. 7.6).

Fig. 7.6

It is possible to create several similar abbreviations with different decryptions.

150

Dictionary Editor

To set one more variant of decryption for abbreviation "AUTO":

1. Select a category to which it is necessary to add an abbreviation.

2. Press Add an abbreviation button in the toolbar of the right window. Enter abbreviation "AUTO" and descryption in languages that will be used in the project (Fig. 7.7) to Element properties window.

Fig. 7.7

3. Press Apply button. Then the window with message about available abbreviation "Auto" and request of entered value saving will be displayed.

If "Yes" is selected, Element properties window will be closed and all changes will be saved. If "No" is selected, the window will close without saving entered values. "Cancel" closes the window with request and leaves Element properties window open.

4. Press "Yes" button. The right editor window displays the entered abbreviation (Fig. 7.8).

Fig. 7.8

Operations with abbreviations To change abbreviation properties:

1. Select a name of abbreviation in the right window.

151

Dictionary Editor

2. Press Change the abbreviation definition button in the toolbar of the right window.

3. Make all necessary changes in Element properties window. To delete abbreviations from the list select its name and press Delete the abbreviation button . Group delete operation is allowed. To move or copy one or more abbreviations from one category into another:

1. Select the names of abbreviation in the right window.

2. To move abbreviations press Cut button in the toolbar of the right window or keys combination CTRL+X, SHIFT+DELETE. To copy abbreviations press Copy button or keys combination CTRL+С, CTRL+INSERT.

3. Select a category in the left window to which is required to be move or copy abbreviations and press Paste button or keys combination CTRL+V, SHIFT+INSERT. If the category already has the pasted abbreviations then the window with message about available abbreviations and request of paste will be displayed. "Yes" adds the pasted abbreviations to the list, "No" cancels the past operation.

You can sort abbreviations alphabetically by any column (ascending or descending) having left-clicked at the heading of the column. Sorting mode is indicated by the sign on the left of column heading. To cancel sorting mode press button Cancel sorting . Then an order of abbreviations will match the order of their addition into the list. At disabling mode of sorting and selecting any name of abbreviation Up and Down buttons become active. These buttons allow the user to change an order of abbreviations in the list. Beside the buttons it is possible to use keys combinations CTRL+↑ of CTRL+↓ respectively.

7.2.3. Abbreviations search The dictionary is provided with an option of abbreviations search by the name or decryption. It is possible to search:

• Only in Abbreviations dictionary;

• Selecting search area, i.e. including searching in Terms and Normative documents dictionaries.

To search abbreviations in Abbreviations dictionary.

1. Deselect in category tree, clicking the right mouse button in the left window.

2. Press Search button in the toolbar of the left window or keys combination CTRL+F. Find dialog window will be displayed (Fig. 7.9).

152

Dictionary Editor

Fig. 7.9

3. Set search parameters in Find window:

• Enter abbreviation text or its definition in Find area. If search of this text was performed, it is possible not to enter it, but to select in open list of field.

• In Search section you can select a particular area to be searched: in names, definitions and both areas.

• Search area section in this type of search is not available. Search is performed in all categories of Abbreviations dictionary.

4. Press Find button located to the right of the set parameters. Search results will be displayed in the lower part of the window (Fig. 7.10).

Fig. 7.10

153

Dictionary Editor

To go to one of found abbreviations select it among search results and press Go to button (Fig. 7.10). In this case you will return to the dictionary editor window where selected abbreviation and its category will be selected. When pressing button you will return to the dictionary editor window. To find abbreviations with search area:

1. Select a category in the left window.

2. Press Search button in the toolbar of the left window or keys combination CTRL+F. Find dialog window will be displayed (Fig. 7.11).

Fig. 7.11

This type of search activates Search area section in Find window; there are three radio buttons in the section:

• In selected category and its subcategories. Pressing radio button means that search will be performed only in the selected category and embedded categories in the left window.

• In the current section. Pressing radio button means that search will be performed in all categories of the current dictionary (in this example it is Abbreviations dictionary).

• In all sections. Pressing radio button means that search will be performed in all categories of Abbreviations, Terms and Normative documents dictionaries.

3. Enter parameters of search.

4. Press button Find. Search results will be displayed in the lower part of the window (Fig. 7.12).

154

Dictionary Editor

Fig. 7.12

To go to one of found abbreviations select it among results and press Go to button (Fig. 7.12). In this case you will return to the dictionary editor window and corresponding tab where selected abbreviation and its category will be selected. Pressing Close button in Find window returns you to the dictionary editor window to the tab from which the window was called.

7.3. "Terms" and "Normative documents" Dictionaries Creation

Terms and Normative documents dictionaries creation is performed similarly to creation of Abbreviations dictionary.

Remark Normative documents library can contain only identification of normative document and its name, but not the document itself or references.

7.4. Working with "Service Inscriptions" Dictionary Go to Service inscription tab (Fig. 7.13).

155

Dictionary Editor

Fig. 7.13

This tab includes a list of service inscriptions for dialog windows and commands of TG Builder module and toolbar. To change a service inscription:

1. In Language window select a language of service inscription to be edited from the list of available languages.

2. Click the right mouse button at the service inscription name.

3. Select Change command from the context menu. Value change window will open (Fig. 7.14).

Fig. 7.14

156

Dictionary Editor

4. Edit the service inscription and press button . The changed service inscription will be marked with color (Fig. 7.15).

Fig. 7.15

It is possible to perform different operations with the service inscriptions. Right-click at the changed inscription. The context menu is displayed where all commands will be available (Fig. 7.16).

Fig. 7.16

Commands of context menu and description are given in the table below.

157

Dictionary Editor

Table 7-1

Command

Description

Change Service inscription value change

Reset from the design Return of value of selected service inscription to its value at a moment of template opening.

Reset language from the design Return of values of all service inscriptions for this language to their values at a moment of template opening.

Reset all from the design Return of values of all service inscriptions for all languages to their values at a moment of template opening.

Inscription "by default". Return of selected service inscription to the default value.

Inscription "by default" for the language

Return of all service inscriptions for this language to the default values.

Inscription "by default" for all Return of all service inscriptions for all languages to the default values.

Commands of context menu duplicate buttons of the toolbar (Fig. 7.17). When setting the cursor to the button an inscription with name of tool is displayed.

Fig. 7.17

When completing service inscriptions editing exit the dictionary editor saving the changes.

158

159

Chapter 8. Conclusion The guide describes an example of "AIRCRAFT-2010" template creation. When a template is created it is necessary to register it in the system. Registration is performed in TG Admin module. This operation is described in "EOD software module 2.6" Administratior’s Manual. An example of technical documentation project creation based on the developed "AIRCRAFT-2010" template is specified in "EOD software module 2.6" User Guide.

Conclusion