Schneider Electric XTEL User Guide
Schneider Electric XTEL is a versatile documentation management tool designed to streamline the creation, customization, and printing of application documentation for a range of Schneider Electric products, including PL7, XBTL940, XTEL-CONF, XTEL-SDBASE, and XTEL-MOD. With its comprehensive set of features, XTEL enables users to efficiently manage documentation files, ensuring accuracy, consistency, and ease of access.
Advertisement
Advertisement
________________________________________________________ XTEL-DOC Option Preface ___________________________________________________________________________ The main enhancements to XTEL-DOC TXT L DCT V5 over the previous version, XTEL-DOC TXT L DCT V42 comprise: Support for the documentation produced by new X-TEL V5 functions XTEL-DOC V5 supports new X-TEL and MINI X-TEL V5 functions for creating the application documentation file: • PL7-PMS2: for implementing and using a complete library of process control application algorithms and their related calculations along with the man-machine interface for PMX7 V5 process control PLCs, • XBTL940: for implementing and using an XBT operator console, • XTEL-CONF: for creating the local rack and remote I/O configuration and generating the application structure for TSX/PMXV5 PLCs, • XTEL-SDBASE: to manage the symbol data base, • XTEL-MOD: to manage the module data base. Compatibility with installed systems TXT L DCT V5 software can only be installed on an X-TEL or MINI X-TEL V5 system. XTEL-DOC V5 can: • Read a documentation file generated by XTEL-DOC V4 or V42, • Regenerate a documentation file created by XTEL-DOC V4 or V42, • Generate a file from the documentation files generated by V4 or V42 level applications. F ___________________________________________________________________________ P /1 ___________________________________________________________________________ XTEL-DOC Option Preface ___________________________________________________________________________ F ___________________________________________________________________________ P/2 ________________________________________________________ XTEL-DOC Option Contents Divider F ___________________________________________________________________________ Section Page _______________________________________________________________________________________ 1 XTEL-DOC Reference Manual _______________________________________________________________________________________ Contents 1/1 _______________________________________________________________________________ 1.1 Presentation 1.2 XTEL-DOC Program Features 1.3 Print-out Examples _______________________________________________________________________________________ 2 Building and Generating Documentation Files with XTEL-DOC _______________________________________________________________________________________ Contents 2/1 _______________________________________________________________________________ 2.1 XTEL-DOC General Principles 2.2 Generating .DOC Files with PL7 Functions and X-TEL Tools 2.3 Integrating and Managing Documentation Files in XTEL-DOC _______________________________________________________________________________________ 3 XTEL-DOC Operating Modes _______________________________________________________________________________________ Contents 3/1 _______________________________________________________________________________ 3.1 Hardware Description 3.2 Software Installation 3.3 General 3.4 Contents 3.5 Footer 3.6 Title Page 3.7 General Information 3.8 Source Documents 3.9 Documentation File 3.10 Error Messages _______________________________________________________________________________________ 4 Appendix _______________________________________________________________________________________ Contents 4/1 _______________________________________________________________________________ 4.1 Printer Driver Installation and Configuration 4.2 Courier Font Installation 4.3 Generating Text Files in Word 5.0 or Word for Windows 4.4 Storing Documentation Files on Diskette ___________________________________________________________________________ F/1 F ___________________________________________________________________________ F ___________________________________________________________________________ F/2 ________________________________________________________ XTEL-DOC Reference Manual 1 XTEL-DOC Reference Manual Section 1 ___________________________________________________________________________ ___________________________________________________________________________ Sub-section Page _______________________________________________________________________________________ 1.1 Presentation 1/2 _______________________________________________________________________________________ 1.1-1 Program Presentation 1/2 _______________________________________________________________________________ 1.1-2 Building Application Documentation Files 1/3 _______________________________________________________________________________ _______________________________________________________________________________________ 1.2 XTEL-DOC Program Features 1/4 _______________________________________________________________________________________ 1.2-1 Basic Functions 1/4 _______________________________________________________________________________ 1.2-2 Customizing the Documentation File 1/4 _______________________________________________________________________________ 1.2-3 Using Documentation Files Generated by other Programs 1/4 _______________________________________________________________________________ 1.2-4 Accessing the Documentation File 1/5 _______________________________________________________________________________ 1.2-5 Printing the Documentation File 1/5 _______________________________________________________________________________ _______________________________________________________________________________________ 1.3 Print-out Examples 1/6 _______________________________________________________________________________________ This section ends on page 1/16 F ___________________________________________________________________________ 1/1 ___________________________________________________________________________ 1.1 Presentation _______________________________________________________________________________________ 1.1-1 Program Presentation XTEL-DOC is an optional X-TEL Software Workshop program. It is used to manage the application documentation B file, in single and multiple station applications. This program can be accessed at two levels: PROJECT XTEL-DOC STATION 1 XTEL-DOC PL7-3 STATION n PL7-COM PL7-AXE PL7-PCL XTEL-MEM PL7-2 PL7-MMI PL7-OSI PL7-MMS PL7-PMS The XTEL-DOC program is based on the various documentation files generated by the PL7-X specialized function programs and the station tools. XTEL-DOC, will also integrate imported ASCII, semi-graphic or Postscript files in order to generate a coherent and complete A4 or A3 format documentation file. PROJECT FACTORY PROJECT FILE: XTEL-DOC Final Format-Integration STATIONS F TSX 17 CONV UNITELW DIALOG TSXV4 OVEN3 Generate PL7-X documentation Generate XTEL-MEM documentation MAPWAY FACTORY Generate PL7-NET documentation Generate PL7-2 documentation NET External files Specification descriptions ___________________________________________________________________________ 1/2 1 XTEL-DOC Reference Manual ___________________________________________________________________________ 1.1-2 Building Application Documentation Files The documentation file generated by XTEL-DOC can be: Printed, it is generated in landscape (horizontal) format and can be printed-out in A4 or A3 size, depending on the ability of the connected Postscript printer: • Configuration and program are condensed, • Each page is split into two A5 format sheets and includes a footer, • A single page combines a number of contact networks, • The Grafcet framework, transitions and associated actions are displayed on the same pages. Accessed on line: • Paragraph selection, browsing the pages, • Automatic updating of revisions and changes, • Zoom on part of the displayed window. XTEL-DOC can generate two types of documentation file laid out in sections and paragraphs: Project file, comprising: • Title page • List of revisions • Contents • General information • Project configuration • A title page, • A list of revisions, • A table of contents, • General information, • The project configuration, • The station files (station files must be generated at individual station level). Station 1 File Station n File F Station file, comprising: • A title page, • A list of revisions, • A table of contents, • General information, • The station configuration, • The PL7 program, • The axis control program, • The communication program, • The process control program, • The man-machine interface program, • The network program. • Title page • List of revisions • Contents • General information • Station configuration PL7-2/3 AXE OSI ___________________________________________________________________________ 1/3 ___________________________________________________________________________ 1.2 XTEL-DOC Program Features _______________________________________________________________________________________ 1.2-1 Basic Functions Customize B Print .DOC Use File Access . PSC . TXT _______________________________________________________________________________________ 1.2-2 Customizing the Documentation File XTEL-DOC lets the user enter the following documentation file components: • Documentation file contents, • The footer to placed at the bottom of each page, • Title page, • General information pages using the OS/2 text editor. F _______________________________________________________________________________________ 1.2-3 Using Documentation Files Generated by other Programs XTEL-DOC allows the user to build the application documentation file from .DOC files generated by specialized application programs or by standard X-TEL tools. ___________________________________________________________________________ 1/4 XTEL-DOC Reference Manual 1 ___________________________________________________________________________ XTEL-MEM TSX/PMX V4 station configuration, XTEL-CONF TSX/PMX V5 station configuration, XTEL-SDBASE Symbol data base management, XTEL-MOD Program module management, PL7-NET Project configuration, PL7-2 PL7-2 program documentation file, PL7-3 PL7-3 program documentation file, PL7-AXE Axis control program, PL7-COM Communication program, PL7-PCL TSX process control program, PL7-PMS PMX process control program, PL7-PMS2 PMX process control program, PL7-MMI Man-Machine Interface program, PL7-OSI OSI network program, PL7-MMS MMS program and symbols, XBTL940 XBT terminal configuration. XTEL-DOC Also supports the integration of text, Postscript or Encapsulated Postscript files generated by other programs and accepted as general information. _______________________________________________________________________________________ 1.2-4 Accessing the Documentation File XTEL-DOC displays the contents of the application documentation file on-screen. The documentation file can therefore be accessed on-line: • For application debug operations (access to cross-references and to the table of symbols, etc.), • For maintenance operations (configuration display, general information, etc.). F XTEL-DOC provides fast access via the table of contents. XTEL-DOC provides an overall view (displaying a chart with actions and associated conditions) or a detailed view (Zoom function). _______________________________________________________________________________________ 1.2-5 Printing the Documentation File XTEL-DOC can print-out all or part of the documentation file (a single section, a single paragraph or a part of a paragraph) to a Postscript laser printer. XTEL-DOC manages the different versions of the application file. ___________________________________________________________________________ 1/5 ___________________________________________________________________________ 1.3 Print-out Examples _______________________________________________________________________________________ Title Page Date : 11/21/90 Author : xtel Page : 2-1 F. LE ROY Documentation Title Page Trial TSX 47400 F Station conf2_3 VMK File Rev. : 02 Paragraph Rev. : 02 B ___________________________________________________________________________ 1/6 ** 01 ** ** ** ** ** ** ** ** Contents General Information Station Configuration Configuration header I/O configuration I/O wiring Mnemonics PL7 functions General information Software configuration Functions blocks Configuration of OFBs Constant words Network information Program Program structure Grafcet structure 3 4 5 5.1 5.2 5.3 5.4 6 6.1 6.2 6.3 6.4 6.5 6.6 6.7 6.8 6.9 6.10 Xref by variable 6.11 Xref by mnemonics 6.12 Xref program 6.13 Occupation grid Trial TSX 47400 Station ** 01 ** 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 02 01 02 List of Revisions 2 01 02 01 02 Title Page 1 11/21/90 11/21/90 01 02 Documentation List of Revisions conf2_3 Date Revision F. LE ROY VMK xtel xtel Author Comment Page : 2-1 Date : 11/21/90 Author : xtel Paragraph Rev. : 02 File Rev. : 02 XTEL-DOC Reference Manual 1 ___________________________________________________________________________ List of Revisions F ___________________________________________________________________________ 1/7 1p 1p 0p 1p 1p 4p 11 p 4p 2p 3p 0p 1p 0p List of Revisions Contents General Information Station Configuration Configuration header I/O configuration I/O wiring Mnemonics PL7 functions General information Software configuration Functions blocks Configurations of OFBs Constant words Network information Program Program structure Grafcet structure Xref by variable Xref by mnemonics Xref program Occupation grid 3 4 5 5.1 5.2 5.3 5.4 6 6.1 6.2 6.3 6.4 6.5 6.6 6.7 6.8 6.9 6.10 6.11 6.12 6.13 Contents Documentation TSX 47400 Trial conf2_3 1p Title Page 2 Station F 1 F. LE ROY VMK Page : 3-1 Date : 11/21/90 Author : xtel Paragraph Rev. : 01 File Rev. : 01 ___________________________________________________________________________ Contents (Station Documentation File) B ___________________________________________________________________________ 1/8 Trial TSX 27 47 RESUME AUX. GRAFCET INITIALIZATION PLC I/O FAULT CHECK GRIDING WHEEL ROTATION GRIDING WHEEL ROTATION FAULT LUBRICATION FAULT SENSOR FAULT ROLLER MOTER TEMP. SENSOR FAULT LUBRICATION LEVEL FAULT GENERAL FAULT MOTION CONTROL DIAMOND TRAVEL ERROR POSITION ERROR AUX. RESET CYCLE SELECTION AUX. CYCLE CONDITIONS AUTOMATIC CYCLE CONDITIONS AUX. MULTIPLEXER AUX. MULTIPLEXER AUX. MULTIPLEXER AUX. MULTIPLEXER AUX. MULTIPLEXER AUX. MULTIPLEXER AUX. MULTIPLEXER AUX. PB START CYCLE AUX. PB DIAMOND LOAD AUX. PB STOP GRINDER AUX. PB START GRINDER AUX. PB STOP ROLLER AUX. PB START ROLLER AUX. PB PULSE REV. DIAMOND AUX. PB PULSE FWD. DIAMOND AUX. PB FAST REV. DIAMOND AUX. PB FAST FWD. DIAMOND AUX. PB RETURN DIAMOND → AUX. PB ADVANCE DIAMOND → AUX. PB RETURN DIAMOND (RUN) AUX. PB ADVANCE DIAMOND (RUN) AUX. PB PULSE FWD. DIAMOND (0.01) AUX. PB PULSE REV. DIAMOND (0.01) AUX. PB PULSE FWD. DIAMOND (0.001) AUX. PB PULSE REV. DIAMOND (0.001) AUX. PB FWD. DIAMOND AND ROLLER AUX. PB ADVANCE ROLLER (RUN) AUX. PB RETURN ROLLER (RUN) AUX. PB PULSE FWD. ROLLER (0.01) AUX. PB PULSE REV. ROLLER (0.01) AUX. PB PULSE FWD. ROLLER (0.001) AUX. PB PULSE REV. ROLLER (0.001) AUX. RETURN DIAMOND AND ROLLER RESUME STORE RTA1 B0 B1 B2 B3 B4 B5 B6 B8 B10 B11 B12 B13 B14 B15 B27 B28 B30 B31 B32 B33 B34 B35 B36 B41 B42 B43 B44 B45 B46 B48 B49 B50 B51 B52 B53 B55 B56 B57 B58 B59 B60 B61 B62 B63 B64 B65 B66 B67 B68 B69 Station COMMENT INTERNAL BITS VARIABLE Customer Application General Information conf2_3 B70 B71 B72 B73 B74 B75 B76 B77 B78 B79 B80 B81 B82 B83 B84 B85 B86 B87 B88 B89 B91 B92 B93 B94 B95 B96 B97 B98 B99 B100 B101 B102 B103 B104 B105 B106 B107 B109 B110 B111 B112 B113 B114 B115 B116 B120 B123 B130 B131 B132 B133 VARIABLE F. LE ROY VMK Page : 6.1-1 Date : 11/08/90 Author : xtel Paragraph Rev. : 01 File Rev. : 01 RESUME STORE RTA2 TRANSFERT OUTPUT WORDS TRANSFERT OUTPUT WORDS TRANSFERT OUTPUT WORDS TRANSFERT OUTPUT WORDS TRANSFERT OUTPUT WORDS TRANSFERT OUTPUT WORDS TRANSFERT OUTPUT WORDS TRANSFERT OUTPUT WORDS TRANSFERT OUTPUT WORDS TRANSFERT OUTPUT WORDS AUX. SHIFT AUX. SHIFT AUX. SHIFT AUX. SHIFT AUX. STORE RTA1 AUX. STORE RTA2 AUX. COND. PB DIAMOND FWD. (RUN) AUX. COND. PB DIAMOND REV. (RUN) AUX. CORRECT POSITION ERROR COMPUTE GRINDER STAR-TRIANGLE AUX. INTERVAL DIAMOND LOAD INTERVAL DIAMOND LOAD (T2-DONE) AUX. DRAIN MACHINE AUX. DRAIN MACHINE (T2-DONE) COUNT PASSES COUNT DONE ANTI-REPETITION START INDEX RTA1 ANTI-REPETITION START INDEX RTA2 AUX. PB START CYCLE AUX. PB DIAMOND LOAD AUX. PB START GRINDER AUX. PB START ROLLER AUX. PB PULSE REV. DIAMOND AUX. PB PULSE FWD. DIAMOND AUX. PB RETURN DIAMOND → AUX. PB ADVANCE DIAMOND → LUBRICATION SETUP AUX. SHIFT AUX. SHIFT AUX. SHIFT AUX. ROLLER EMERGENCY ROLLER BACK OFF AUX. ROLLER EMERGENCY AUX. SHIFT AUTOMATIC CYCLE RESUME DIAMOND COMMANDS AUX. TRANSFERT OUTPUT WORDS AUX. STORE RTA1-2 UNITS AUX. STORE RTA1-2 HUNDREDS AUX. GRAFCET PGM. RTA1-2 COMMENT INTERNAL BITS XTEL-DOC Reference Manual 1 ___________________________________________________________________________ General Information F ___________________________________________________________________________ 1/9 ___________________________________________________________________________ PL7-3 Program F Page : 4-1 Author : xtel Date : 11/29/90 General Information Paragraph Rev. : 03 Station n126s2 File Rev. : 03 B ___________________________________________________________________________ 1/10 MNEMONIC Sb20 Sa21 Sa22 Sa23 Sb24 Sb25 Sb26 Sa27 Sb28 Sb29 Sb2a Sa2b Ka2c Xx2d Xx2e Xx2f Sq30 Sq31 Sq32 Sq33 MNEMONIC Sq34 Sq35 Sq36 Sq37 Sq38 Sq39 Sq3a Sq3b Sq3c Sq3d Xx3e Xx3f Xx40 Xx41 Xx42 Xx43 Ka44 Ka45 Ka46 Xx47 VARIABLE 12,0 12,1 12,2 12,3 12,4 12,5 12,6 12,7 12,8 12,9 12,A 12,B 12,C 12,D 12,E 12,F 13,0 13,1 13,2 13,3 VARIABLE 13,4 13,5 13,6 13,7 13,8 13,9 13,A 13,B 13,C 13,D 13,E 13,F 14,0 14,1 14,2 14,3 14,4 14,5 14,6 14,7 Station CONT. MEASUREMENT BAD CONT. MEASUREMENT OK CONT. MEASUREMENT BAD + PART READY FOR MEASUREMENT TRANSFER REV. TRANSFER FWD. MEASUREMENT UP MEASUREMENT DOWN REV. EXIT HATCH FWD. EXIT HATCH HOIST UP HOIST DOWN CHECK HOOK ROTATION COMMENT EJECT BAD PART EJECT GOOD PART PART IN HOIST PART READY TO TRANSFER TSX 27 47 Trial COMMENT conf2_4 MNEMONIC Hl5c Hl5d Hl5e Xx5f Hl60 Hl61 Hl62 Hl63 Hl64 Hl65 Hl66 Xx67 Xx68 Xx69 Xx6a Xx6b Ka6c Ka6d Ka6e Xx6f VARIABLE 05,C 05,D 05,E 05,F 06,0 06,1 06,2 06,3 06,4 06,5 06,6 06,7 06,8 06,9 06,A 06,B 06,C 06,D 06,E 06,F Customer Application F. LE ROY VMK MNEMONIC Ka48 Ka49 Ka4a Ka4b Ka4c Ka4d Ka4e Ka4f Km50 Km51 Xx52 Yv53 Yv54 Yv55 Yv56 Yv57 Xx58 Xx59 Xx5a Xx5b VARIABLE 14,8 14,9 14,A 14,B 14,C 14,D 14,E 14,F 05,0 05,1 05,2 05,3 05,4 05,5 05,6 05,7 05,8 05,9 05,A 05,B List of Mnemonics EMERGENCY STOP SELECT : 0 END CYCLE/ 1 CONTINUOUS SELECT MANUAL MODE SELECT AUTOMATIC MODE PB HOIST PB START HOOK PB STOP HOOK SELECT TRANSFER PART : 0 FWD./ 1 REV. PB UP MEASUREMENT PB DOWN MEASUREMENT PB START CYCLE SELECT BRAKING : 0 YES/ 1 NO BRAKE RELEASED COMMENT Page : 5.4-1 Date : 11/07/90 Author : xtel Paragraph Rev. : 01 File Rev. : 01 MEASUREMENT ORDER CALIBRATION ORDER AUTOMATIC ORDER INITIAL STEP MEASUREMENT NO PART CHOKE SENSOR ERROR CYCLE ERROR BAD CALIBRATION CCG20 AUTOMATIC OPERATION CHOKE SERIOUS PROBLEM COMMENT RAISE HOIST FWD. TRANSFER RAISE MEASUREMENT LOWER MEASUREMENT CLOSE EXIT HATCH ROTATE HOOK RELEASE HOOK BRAKE CONT. UNDER POWER CONT. ADJUST CONT. MEASUREMENT DONE CONT. AUTOMATIC CONT. CALIBRATION CONT. BAD CALIBRATION XTEL-DOC Reference Manual 1 ___________________________________________________________________________ PL7-3 Program F ___________________________________________________________________________ 1/11 12,0 12,1 12,2 12,3 12,4 12,5 12,6 12,7 12,8 12,9 12,A 12,B 12,C 12,D 12,E 12,F I12,0 I12,1 I12,2 I12,3 I12,4 I12,5 I12,6 I12,7 I12,8 I12,9 I12,A I12,B I12,C I12,D I12,E I12,F Ter.Blk. BLK7 - 1 -- 2 -- 3 -- 4 -- 5 -- 6 -- 7 -- 8 -- 9 -- 10 -- 11 -- 12 -- 13 -- 14 -- 15 -- 16 -- 17 -- 18 -- 19 -- 20 -- 21 -- 22 -- 23 -- 24 -- 25 -- 26 -- 27 -- 28 -- 29 -- 30 -- 31 -- 32 -- 33 -- 34 -- 35 -- 36 -- Wire 101 --------------12,0 -------------12,1 -------------12,2 -------------12,3 -------------12,4 -------------12,5 -------------12,6 -------------12,7 -------------12,8 -------------12,9 -------------12,A -------------12,B -------------12,C -------------12,D -------------12,E -------------12,F -------------I12,0 -------------I12,1 -------------I12,2 -------------I12,3 -------------I12,4 -------------I12,5 -------------I12,6 -------------I12,7 -------------I12,8 -------------I12,9 -------------I12,A -------------I12,B -------------I12,C -------------I12,D -------------I12,E -------------I12,F --------------100 -------------- Customer Application Trial conf2_4 101 --------------I3,0 -------------I3,1 -------------I3,2 -------------I3,3 -------------I3,4 -------------I3,5 -------------I3,6 -------------I3,7 -------------I3,8 -------------I3,9 -------------I3,A -------------I3,B -------------I3,C -------------I3,D -------------I3,E -------------I3,F -------------I13,0 --------------------I13,8 ---------------------100 -------------- Wire I/O WIRING Station MULTIPLEXER - COL. 1 MULTIPLEXER - COL. 2 MULTIPLEXER - COL. 3 MULTIPLEXER - COL. 4 MULTIPLEXER - COL. 5 MULTIPLEXER - COL. 6 MULTIPLEXER - COL. 7 ROLLER MOTOR TEMP. SENSOR THERMAL CUTOFF TRIGGERED LOW OIL LEVEL OIL FILTER BLOCKED OIL OVERHEAT READY TO START ROLLER HOOK OIL SUPPLY AXIS BOARD OK GRINDER TURNING POS - PART OK DIAMOND FWD. DIAMOND REV. DIAMOND REV. OVERRUN DIAMOND FWD. OVERRUN NO PART SUPPLY CHOKE NO PART LUBRICATED POS - PRE-TRAVEL NEG. POS - PRE-TRAVEL POS. POS - DEVIATION NEG. POS - DEVIATION POS. RTA1 NOT EXECUTED RTA2 NOT EXECUTED ROLLER EMERGENCY Comment Rack 0 Mod 3 Task : MAST TSX 27 47 Mnemonic Code : 56 F 100 I/O bit Module : Rack 0 Mod 2 Task : MAST BLK7 - 1 -- 2 -- 3 -- 4 -- 5 -- 6 -- 7 -- 8 -- 9 -- 10 -- 11 -- 12 -- 13 -- 14 -- 15 -- 16 -- 17 -- 18 -- 19 -- 20 -- 21 -- 22 -- 23 -- 24 -- 25 -- 26 -- 27 -- 28 -- 29 -- 30 -- 31 -- 32 -- 33 -- 34 -- 35 -- 36 -- Ter.Blk. Module : F. LE ROY VMK Page : 5.3-2 Date : 11/08/90 Author : xtel Paragraph Rev. : 01 File Rev. : 01 REPLACE YES I13,8 Comment SUPPLY YES GRINDER RUNNING STAR GRINDER RUNNING TRIANGLE PART INSERT YES AUTOMATIC CONTROL MANUAL CONTROL LUBRICATE DIAMOND CONTINUOUS REPLACE YES RESTART AFTER REPLACE YES RESTART AFTER REPLACE NO MANUAL SELECTOR NO MANUAL SELECTOR YES ALTERNATE REPLACE SELECTORS CLOSED PUMP MOTOR BACK-UPS ROLLER STATUS OIL LEVEL Mnemonic B I3,0 I3,1 I3,2 I3,3 I3,4 I3,5 I3,6 I3,7 I3,8 I3,9 I3,A I3,B I3,C I3,D I3,E I3,F I/O bit Code : 56 ___________________________________________________________________________ Cross References ___________________________________________________________________________ 1/12 106 105 Trial TSX 27 47 B50 : AUX. AUTOMATIC HOOK ROTATION B54 : AUX. HOOK FAIL/ROTATION SENSOR T2,D : END TIME-OUT MEASUREMENT UP M,P : 10 MODIF : Y TB : 100 ms $106 BLINKER S^ M0 M0,R : MONOSTABLE 0 RUNNING B254 : BLINKER OUTPUT M,P : 10 MODIF : Y TB : 100 ms $105 BLINKER S^ M1 M1,R : MONOSTABLE 1 RUNNING B255 : TRASH AUTOMATIC HOOK ROTATION ** LABEL M1,R / BLINKER ** LABEL M0,R / BLINKER R R Station ) ) 149 X63 X62 $149 ROTATE HOOK B54 / T2,D Customer Application PROG : MAST/POST Sb25 = I2,5 Km51 = 05,1 B50 Km50 150 F. LE ROY Sa2b / B54 / Xx2d Km51 = I2,D Ka2c Page : 6.7-29 Date : 11/07/90 Author : xtel Paragraph Rev. : 01 File Rev. : 01 Sa2b = I2,B Km50 = 05,0 $150 ROTATE HOOK Xx2d Sa2b = I2,6 = I2,C VMK Sb26 Ka2c Sb26 / I2,B : SELECT BRAKE HOOK : 0 YES/1 NO B51 : AUX. RELEASE BRAKE I2,5 : PB MOVE HOOK B54 : AUX. HOOK FAIL/ROTATION SENSOR I2,6 : PB STOP HOOK I2,C : CONT. BRAKE RELEASED I2,D : CONT. MOTOR THERMAL CUTOUT 05,0 : CONT. HOOK ROTATION COMMAND 05,1 : CONT. BRAKE RELEASE COMMAND T0,D : END TIME-OUT HOOK ROTATION COMMAND B50 : AUX. AUTOMATIC HOOK ROTATION ROTATE HOOK ** LABEL Sb25 conf2_4 ( B254 ( B255 X5 ** LABEL X4 ) ) ( ) B51 ( Km50 ( B255 XTEL-DOC Reference Manual 1 ___________________________________________________________________________ Cross References F ___________________________________________________________________________ 1/13 ___________________________________________________________________________ PL7-MMI Man-Machine Interface B F ___________________________________________________________________________ 1/14 V 8 V 9 19 20 9 10 V 11 18 17 8 7 6 5 V 4 29 Trial TSX 27 47 V 0 11 V 10 Station V 31 conf2_4 Sq33 = I3,3 Hl65 = 06,5 ** X7 → X9 Sq33 Sq3c Sq32 = I3,2 Hl64 = 06,4 ** X7 → X8 Sq32 Sq33 Customer Application PROG : MAST CHART / PAGE 2 X20 : WAIT X10 : WAIT X19 : YV57 X18 : YV54/YV57 X9 : C0 X8 : YV53 X17 : YV57 X6 : YV56/YV57 /MEASUREMENT X5 : KM50/KM51/HL61 = I3,C Hl64 / = I3,3 = 06,5 Hl63 / F. LE ROY VMK Sq3c Hl63 / Sq33 Hl65 Sq3c Hl65 / Hl64 / Hl63 Sq3c Hl64 Hl63 = 06,4 = 06,3 Page : 6.7-17 Date : 11/07/90 Author : xtel Paragraph Rev. : 01 File Rev. : 01 = 06,3 = I3,C Hl65 / (#) (#) XTEL-DOC Reference Manual 1 ___________________________________________________________________________ PL7-MMI Man-Machine Interface F ___________________________________________________________________________ 1/15 I4,5 I4,6 Ka45 Ka46 I4,8 I4,9 I4,A I4,B I4,C I4,D 06,C 06,D 06,E Ka48 Ka49 Ka4a Ka4b Ka4c Ka4d Ka6c Ka6d Ka6e VARIABLE I2,C I4,4 Ka2c Ka44 MNEMONIC 0,6 VARIABLE PRL PRL PRL CHART CHART PRL PRL PRL PRL POST POST POST POST POST POST POST TASK POST POST POST POST CHART CHART POST PRL PRL PRL PRL PRL PRL PRL PRL PRL TASK LABEL TSX 27 47 Station p10 p11 p10 X63 → X64 0/8 /1 X5 → X6 2/2 /1 p10 p15 p30 p35 p157 p182 p176 p182 p183 p183 p184 BITS Trial LABEL p162 p163 p164 p176 X0 → X3 1/2 /2 X0 → X1 1/2 /1 p150 p11 p30 p35 p11 p30 p35 p11 p30 p35 BITS F Hl66 MNEMONIC conf2_4 I2,1 Sa21 Sa27 Sa2b Sa23 Sa22 MNEMONIC Customer Application I2,7 I2,B I2,3 I2,2 CHART CHART PRL POST POST POST POST CHART CHART POST PRL PRL POST POST CHART CHART TASK POST POST POST POST POST PRL CHART CHART CHART CHART CHART PRL POST POST POST POST TASK F. LE ROY VMK VARIABLE I2,2 05,1 Km51 Sa22 05,0 VARIABLE Km50 MNEMONIC XREF BY MNEMONICS BITS SYMBOL -|/|-|/|-|/|-|/|-|/|-|/|-| |-| |-| |-| |-| |-| |-( )- (S) - (R) -( )- -|/|-|/|-| |-( )-|/|-|/|-| |-|/|-|/|-| |-| |-|/|-| |-|/|-|/|-| |- SYMBOL LABEL LABEL SYMBOL SYMBOL -|/|-|/|-| |-|/|-|/|-|/|-|/|-|/|-| |-| |-|/|-| |-|/|-| |-| |-|/|- -| |-| |-( )-| |-( )-| |-| |-| |-| |-|/|-|/|-|/|-| |-| |-| |-| |- Page : 6.11-2 Date : 11/07/90 Author : xtel Paragraph Rev. : 01 File Rev. : 01 X60 → X61 0/2 /1 X11 → X31 2/12 /7 p15 p153 p154 p155 p156 X60 → X61 0/2 /1 X11 → X31 2/12 /7 p154 p15 p15 p150 p150 X6 → X7 2/4 /1 X6 → X7 2/4 /1 BITS p50 p150 p150 p150 p151 p15 X11 → X31 2/12 /7 X9 → X8 2/10 /0 X9 → X10 2/10 /1 X9 → X10 2/10 /1 X11 → X0 2/12 /6 p15 p153 p154 p155 p156 BITS ___________________________________________________________________________ PL7-MMI Man-Machine Interface Program B ___________________________________________________________________________ 1/16 ________________________________________________________ Building and Generating Documentation Files with XTEL-DOC 2 Building and Generating ___________________________________________________________________________ Section 2 Documentation Files with XTEL-DOC ___________________________________________________________________________ Sub-section Page _______________________________________________________________________________________ 2.1 XTEL-DOC General Principles 2/2 _______________________________________________________________________________________ _______________________________________________________________________________________ 2.2 Generating .DOC Files with PL7 Functions and X-TEL Tools 2/3 _______________________________________________________________________________________ 2.2-1 Generating a .DOC File in PL7-NET 2/3 _______________________________________________________________________________ 2.2-2 Generating a .DOC File in XTEL-MEM 2/3 _______________________________________________________________________________ 2.2-3 Generating a .DOC File in PL7-3 2/4 _______________________________________________________________________________ 2.2-4 Generating a .DOC File in PL7-2 2/4 _______________________________________________________________________________ 2.2-5 Generating a .DOC File in PL7-AXE 2/5 _______________________________________________________________________________ 2.2-6 Generating a .DOC File in PL7-COM 2/6 _______________________________________________________________________________ 2.2-7 Generating a .DOC File in PL7-PCL or PL7-PMS/PMS2 2/7 _______________________________________________________________________________ 2.2-8 Generating a .DOC File in PL7-MMI 2/8 _______________________________________________________________________________ 2.2-9 Generating a .DOC File in PL7-OSI or PL7-MMS 2/8 _______________________________________________________________________________ 2.2-10 Generating a .DOC File in PL7-CONF 2/9 _______________________________________________________________________________ 2.2-11 Generating a .DOC File in PL7-SDBASE 2/9 _______________________________________________________________________________ 2.2-12 Generating a .DOC File in PL7-MOD 2/10 _______________________________________________________________________________ 2.2-13 Generating a .DOC File in XBTL940 2/10 _______________________________________________________________________________ _______________________________________________________________________________________ 2.3 Integrating and Managing Documentation Files in XTEL-DOC 2/11 _______________________________________________________________________________________ 2.3-1 Customizing the Documentation File 2/11 _______________________________________________________________________________ 2.3-2 Generating and Using General Information Files 2/11 _______________________________________________________________________________ 2.3-3 Using Files Generated with PL7 Functions and X-TEL Tools 2/12 _______________________________________________________________________________ 2.3-4 Generating Documentation Files 2/12 _______________________________________________________________________________ 2.2-5 Managing Documentation Files 2/12 _______________________________________________________________________________ F This section ends on page 2/12 ___________________________________________________________________________ 2/1 ___________________________________________________________________________ 2.1 XTEL-DOC General Principles _______________________________________________________________________________________ The same principles apply to the creation and generation of Project or Station documentation files: B Generate .DOC files with PL7 functions and X-TEL tools (refer to 2.2-1 to 2.2-9) Generate the General Information text using a text editor (if required) (*) Using XTEL-DOC Customize the file: . Contents . Title page . Footer Generate or use the General Information text files Use the .DOC files generated by PL7 and X-TEL software F Generate the file Print Access (*) General information can also be entered directly into XTEL-DOC using the OS/2 text editor. ___________________________________________________________________________ 2/2 Building and Generating Documentation Files with XTEL-DOC 2 ___________________________________________________________________________ 2.2 Generating .DOC Files with PL7 Functions and X-TEL Tools _______________________________________________________________________________________ 2.2-1 Generating a .DOC File in PL7-NET (Project File) Select the "Documentation" operating mode and select "XTEL DOC output" item from the documentation menu. The ARCHITECT.DOC project layout file that is generated can be included in the project documentation file. (Refer to PL7-NET program documentation, section 4) File tree Project Stations FACTORY5 OVEN3 HOPPER1 Networks NET ARCHITECT.NET ARCHITECT.DOC _______________________________________________________________________________________ 2.2-2 Generating a .DOC File in XTEL-MEM (Station File) Select the "Document/Print" menu and select the Print action. Select the following parameters from the dialog box that is displayed: • Print-out: File • Type of Printer: Semi-Graphic OK starts generation of the .DOC file that can be integrated into the station documentation file. (Refer to X-TEL documentation: TXT DM TLS V5E, Divider D, Sub-section 2.5) File levels Station XTEL-MEM OVEN3 APP OVEN3. APP OVEN3. TIT OVEN3. DOC AXIS ___________________________________________________________________________ 2/3 F ___________________________________________________________________________ 2.2-3 Generating a .DOC File in PL7-3 (Station File) From the Document/Print screen: • Call-up the Listing Contents screen and select the headings that will be used in the documentation file. By default, all headings are selected, • Select the print parameters "Type of printing: LL or SL", B • Select the "Print Listing" action and validate the selection. Answer [YES] to the XTEL-DOC? prompt. The .DOC file will then be generated by PL7-3. It comprises all of the selected headings and can be included in the application file using XTEL-DOC. Note: When the listing is generated for the first time, all headings must be selected. File tree Station OVEN3 PL7_3 APPLI MOD OVEN3. BIN OVEN3. COM OVEN3. DOC OVEN3.XR1 OVEN3.XR2 APP Important: If the user requires cross-references in the XTEL-DOC documentation file, it is necessary to store .XRi files (refer to the PL7-3 Operating Modes documentation, TXT DM PL7 3 V5E, Divider A, Sub-section 3.10). _______________________________________________________________________________________ 2.2-4 Generating a DOC File in PL7-2 (Station File) F From the Document/Print screen: • Call-up the Listing Contents screen and select the headings that will be used in the documentation file. By default, all headings are selected, • Select the print parameters "Type of printing: LL or SL", • Select the "Print Listing" action and validate the selection. Answer [YES] to the XTEL-DOC? prompt. The .DOC file will then be generated by PL7-2. It comprises all of the selected headings and can be included in the application file using XTEL-DOC. (Refer to PL7-2 Operating Modes documentation, TXT DM PL7 V5E, Section 14). File tree Station OVEN2 PL7_2 APPLI OVEN2. BIN OVEN2. COM OVEN2. DOC MOD ___________________________________________________________________________ 2/4 Building and Generating Documentation Files with XTEL-DOC 2 ___________________________________________________________________________ 2.2-5 Generating a DOC File in PL7-AXE (Station File) From the Operating Modes Selection screen: • Select the TSX working memory (the terminal must be connected to a PLC that supports TSX AXM 172/182 modules with applications to document). • To document all applications for all axes, enter "*" as the axis number and "*" as the application number: AXIS = * APPLI = * • Select the "Documentation" operating mode and set the parameters listed below via the dynamic soft keys that can be accessed in the selection screen for this mode: [PRI/FILE] Print to disk file, [FILE] Enter the name that the .DOC file will be stored under, [GRA Y/N] Graphic printing: Yes, [DIR Y/N] Print directory: Yes. <Enter> Starts generation of the .DOC file. (Refer to the PL7-AXE axis control software documentation: TXT DM PL7 AXS V5E, Section 9). Note: The message "XTEL-DOC compatible" is displayed opposite the graphic print-out item. File tree Station OVEN3 AXIS APPLI PALET. BIN PALET. DOC MOD F ___________________________________________________________________________ 2/5 ___________________________________________________________________________ 2.2-6 Generating a .DOC File in PL7-COM (Station File) From the Operating Modes Selection screen: • Select the TSX FILE memory to work off-line in Local mode or select TSX memory to work on-line with the terminal connected to a PLC that supports TSX SCM modules with applications to document. B • To document all applications for all modules, enter "*" as the module number and "*" as the channel number: COM = * CHANNEL = * • Select the "Documentation" operating mode and set the parameters listed below via the dynamic soft keys that can be accessed in the selection screen for this mode: [PRI/FILE] Print to disk file, [FILE] Enter the name that the .DOC file will be stored under, [GRA Y/N] Graphic printing: Yes, [DIR Y/N] Print directory: Yes. <Enter> Starts generation of the .DOC file. (Refer to the PL7-COM Operating Modes documentation: TXT DM CMM V5E, Section 9). Note: The message "XTEL-DOC compatible" is displayed opposite the graphic print-out item. File tree Station OVEN3 COM APPLI CONF1. BIN CONF1. DOC MOD F AXIS PL7-3 APP ___________________________________________________________________________ 2/6 Building and Generating Documentation Files with XTEL-DOC 2 ___________________________________________________________________________ 2.2-7 Generating a .DOC File in PL7-PCL or PL7-PMS/PMS2 (Station File) From the Operating Modes Selection screen: • Select the TSX FILE (PMX FILE for PL7-PMS or PL7-PMS2) memory to work off-line in Local mode or select TSX (PMX for PL7-PMS or PL7-PMS2) memory to work online with the terminal connected to a PLC. • To document all applications for all TSX AEM modules, enter "*" as the module number and "*" as the application number: AEM = * APPLI = * • Select the "Documentation" operating mode and set the parameters listed below via the dynamic soft keys that can be accessed in the selection screen for this mode: [PRI/FILE] Print to disk file, [FILE] Enter the name that the .DOC file will be stored under, [GRA Y/N] Graphic printing: Yes, [DIR Y/N] Print directory: Yes. <Enter> Starts generation of the .DOC file. (Refer to the PL7-PCL (TXT DM PL7 PCL V5E), PL7-PMS (TXT DM PL7 PMS V5E) or PL7-PMS2 (TXT DM PL7 PMS2 V5E) documentation. Note: The message "XTEL-DOC compatible" is displayed opposite the graphic print-out item. File tree Station OVEN3 PCL(*) APPLI REG1. BIN REG1. DOC MOD AXIS F PL7-3 APP (*) PMS for PL7-PMS or PL7-PMS2 software ___________________________________________________________________________ 2/7 ___________________________________________________________________________ 2.2-8 Generating a DOC File in PL7-MMI (Station File) • From the PL7-MMI program primary window, select "Documentation" from the "Utilities" menu. • Once the "Application Documentation" window is open, select "Station Documentation" from the "Print" B menu. • Select all of the tasks from the dialog box and click on "OK" to confirm, the documentation file is generated. (Refer to PL7-MMI documentation, Divider C, Sub-section 2.6) Note: Documentation must be generated for each PCM module in the application. PL7-MMI generates a single MMI.DOC file that contains all documentations. File tree Station OVEN3 MMI APPLI MMI. BIN MMI. DOC DOP1 DOP2 AXIS DOPi PL7-3 APP _______________________________________________________________________________________ 2.2-9 Generating a .DOC File in PL7-OSI or PL7-MMS (Station File) From the PL7-OSI or PL7-MMS primary window, select the "Document/Print" menu, then select the Print action. Select the following parameters from the dialog box that is displayed: F • Print-out: File • Type of Printer: Semi-Graphic OK starts generation of the .DOC file that can be integrated into the station documentation file. File tree Station OVEN3 OSI(*) APPLI OVEN3. BIN OVEN3. DOC MOD AXIS PL7-3 (*) MMS for PL7-MMS software APP ___________________________________________________________________________ 2/8 Building and Generating Documentation Files with XTEL-DOC 2 ___________________________________________________________________________ 2.2-10 Generating the .DOC in XTEL-CONF (Station File) • From the XTEL-CONF primary window, pull-down the "Documentation" menu and select "Generate". (Refer to the TXT DM TLS V5E documentation, Divider D, Sub-section 1.8). Station OVEN3 ∆ File tree APP oven3.DOC _______________________________________________________________________________________ 2.2-11 Generating the .DOC File in XTEL-SDBASE (Station File) From the XTEL-SDBASE primary window, pull-down the "Documentation" menu and select "Generate". In the dialog box that is displayed, select the following parameters. OK starts generation of the .DOC file that can be integrated into the station documentation file. (Refer to the TXT DM TLS V5E documentation, Divider D, Sub-section 3.8). Station OVEN3 ∆ File tree SDBASE DOC docpl7.DOC ___________________________________________________________________________ 2/9 F ___________________________________________________________________________ 2.2-12 Generating a .DOC File in XTEL-MOD (Project and Station Files) • From the XTEL-MOD primary window, pull-down the "Documentation" menu and select "Generate". From the dialog box displayed, select the parameters. OK Starts generation B of the .DOC file that can be integrated into the station documentation file. (Refer to TXT DM MDD V5E documentation, Divider E, Sub-section 3.6). Project OVEN ∆ File tree OVEN3 (station) APP PL7-3 MOD mod .DOC _______________________________________________________________________________________ 2.2-13 Generating the .DOC File with XBTL940 (Station File) F • Pull-down the "Documentation" menu and select the "Edit" command. Generate the title page and the footer. • Pull-down the "Documentation" menu once again and select the "Print" command. From the dialog box displayed, select the following parameters: - Listing output: File, - Type of printer: Semi-Graphic. • "OK" starts generation of the .DOC file that can be integrated into the station documentation file. (Refer to XBTL940 documentation: Divider A, Sub-section A7). File tree Station XBTL940 function Application active XBTK8 XBTL940 APPLI1 APPL1.CRT APPLI1.TIT APPLI1.DOC ___________________________________________________________________________ 2/10 Building and Generating Documentation Files with XTEL-DOC 2 ___________________________________________________________________________ 2.3 Integrating and Managing Application Files in XTEL-DOC _______________________________________________________________________________________ Customize Generate .DOC Use Current File Final File . PSC . TXT Gen. Info. _______________________________________________________________________________________ 2.3-1 Customizing the Documentation File Customizing the documentation file comprises: • Generating the table of contents of the application (refer to sub-section 3.4), • Entering footer information (refer to sub-section 3.5), • Entering title page information (refer to sub-section 3.6). _______________________________________________________________________________________ 2.3-2 Generating and Using General Information Files For general information: • Use the general information type files previously generated using other text processor applications (refer to sub-sections 3.7 and 4.2), • If necessary, create new files with the OS/2 editor that can be directly accessed from XTEL-DOC (refer to sub-section 3.7). ___________________________________________________________________________ 2/11 F ___________________________________________________________________________ 2.3-3 Using Files Generated with PL7 Functions and X-TEL Tools For configuring PL7 ... programs: • Select the files generated by PL7 functions Bor X-TEL tools (refer to subsection 3.8). The file levels shown opposite, illustrate the transfers performed by the XTEL-DOC program. FACTORY NET ARCHITECT.BIN ARCHITECT.DOC DOC OVEN3 APP OVEN3.BIN OVEN3.DOC PL7_3 APPLI OVEN3.BIN OVEN3.DOC MOD AXIS APPLI PALET.BIN PALET.DOC MOD COM APPLI CONF1.BIN CONF1.DOC MOD DOC _______________________________________________________________________________________ 2.3-4 Generating Documentation Files F All of the above operations are only taken into account in the final documentation file when the file generation command is confirmed. Until this command is executed, any operations in progress are stored in a "file in progress" disk file. _______________________________________________________________________________________ 2.3-5 Managing Documentation Files The XTEL-DOC program automatically manages the documentation file versions and the versions of each paragraph (refer to the list of versions in sub-section 1.3). When the documentation file is generated, XTEL-DOC increments the version (revision) level of the generated sections and paragraphs and that of the complete documentation file (it does not take into account modification of the title page, table of contents or footer). Note: If a section is not regenerated when the selected .DOC files imply an update of this section, a star is displayed in place of the version number (revision level). ___________________________________________________________________________ 2/12 ________________________________________________________ XTEL-DOC Operating Modes 3 XTEL-DOC Operating Modes Section 3 ___________________________________________________________________________ ___________________________________________________________________________ Sub-section Page _______________________________________________________________________________________ 3.1 Hardware Description 3/3 _______________________________________________________________________________________ _______________________________________________________________________________________ 3.2 Software Installation 3/4 _______________________________________________________________________________________ 3.2-1 Fitting the Software Key Module 3/4 _______________________________________________________________________________ 3.2-2 Initial Preparations 3/4 _______________________________________________________________________________ 3.2-3 Installation Conditions 3/4 _______________________________________________________________________________ 3.2-4 Installation Procedure 3/5 _______________________________________________________________________________ 3.2-5 Installing the Printer Driver 3/7 _______________________________________________________________________________ _______________________________________________________________________________________ 3.3 General 3/8 _______________________________________________________________________________________ 3.3-1 Accessing XTEL-DOC 3/8 _______________________________________________________________________________ 3.3-2 Primary Window Menu 3/9 _______________________________________________________________________________ _______________________________________________________________________________________ 3.4 Contents 3/10 _______________________________________________________________________________________ 3.4-1 Contents Icon Commands 3/10 _______________________________________________________________________________ 3.4-2 Contents Dialog Box 3/10 _______________________________________________________________________________ 3.4-3 Contents Example 3/11 _______________________________________________________________________________ _______________________________________________________________________________________ 3.5 Footer 3/12 _______________________________________________________________________________________ 3.5-1 Footer Icon Commands 3/12 _______________________________________________________________________________ 3.5-2 Footer Dialog Box 3/12 _______________________________________________________________________________ 3.5-3 Footer Example 3/13 _______________________________________________________________________________ _______________________________________________________________________________________ 3.6 Title Page 3/14 _______________________________________________________________________________________ 3.6-1 Title Page Icon Commands 3/14 _______________________________________________________________________________ 3.6-2 Title Page Dialog Box 3/14 _______________________________________________________________________________ 3.6-3 Title Page Example 3/15 _______________________________________________________________________________ _______________________________________________________________________________________ 3.7 General Information 3/16 _______________________________________________________________________________________ 3.7-1 General Information Icon Commands 3/16 _______________________________________________________________________________ 3.7-2 General Information Dialog Box 3/16 _______________________________________________________________________________ 3.7-3 Import General Information Dialog Box 3/18 _______________________________________________________________________________ 3.7-4 Export General Information Dialog Box 3/19 _______________________________________________________________________________ ___________________________________________________________________________ 3/1 F ________________________________________________________ XTEL-DOC Operating Modes Section 3 ___________________________________________________________________________ ___________________________________________________________________________ B Sub-section Page _______________________________________________________________________________________ 3.8 Source Documents 3/20 _______________________________________________________________________________________ 3.8-1 .DOC Source Files Icon Commands 3/20 _______________________________________________________________________________ 3.8-2 Source Documents Dialog Box 3/20 _______________________________________________________________________________ _______________________________________________________________________________________ 3.9 Documentation File 3/22 _______________________________________________________________________________________ 3.9-1 Final Doc File Icon Commands 3/22 _______________________________________________________________________________ 3.9-2 Select Paragraphs to Generate Dialog Box 3/22 _______________________________________________________________________________ 3.9-3 Access Window 3/26 _______________________________________________________________________________ 3.9-4 Select Paragraphs to Print Dialog Box 3/28 _______________________________________________________________________________ 3.9-5 Select Paragraph to Print Dialog Box 3/29 _______________________________________________________________________________ _______________________________________________________________________________________ 3.10 Error Messages 3/30 _______________________________________________________________________________________ This section ends on page 3/36 F ___________________________________________________________________________ 3/2 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ 3.1 Hardware Description _______________________________________________________________________________________ A terminal with OS/2 and the X-TEL or MINI X-TEL Software Workshop installed, is required to use the XTEL-DOC program. This means using one of the hardware configurations recommended below: • An FTX 507 or FTX 417 with: • 6 to 8 MB of RAM, • A 40 MB hard disk (120 MB recommended for large or multiple station applications), • OS/2 version 1.3 or 2.1 operating system software, • A mouse (recommended). • An IBM PS/2 or PC compatible configuration, comprising: • At least an 80386 microprocessor based microcomputer, • 6 to 8 MB of RAM, • A 40 MB hard disk (120 MB recommended for large or multiple station applications), • OS/2 version 1.2, 1.3 or 2.1 operating system software, • A high resolution VGA monitor and the appropriate national or international keyboard, • A mouse (recommended). To print out the documentation files, a graphics capable Postscript printer is required (refer to sub-section 3.2-5). The complete XTEL-DOC software package comprises: • A 3 1/2" program diskette, • A software key module, • This manual, ref. TXT DM DCT V5E. † Documentation TXT DM DCT V5E Software Key Module Diskettes XTEL-DOC Project and Station Documentation F † Insert in the X-TEL documentation binder X-TEL Software Workshop † ___________________________________________________________________________ 3/3 ___________________________________________________________________________ 3.2 Software Installation _______________________________________________________________________________________ 3.2-1 Fitting the Software Key Module Fit the software key module into the empty location in the software key module holder. B Ensure that the microcomputer is powered-down before inserting the software key module. Note: The software key module contains the right of use required to run the XTEL-DOC program. The Key Manager, part of the X-TEL or MINI X-TEL Software Workshop, lets the user transfer this right of use to the work key module, freeing a software key module holder slot. For further information on using the Key Manager, refer to the X-TEL Software Workshop documentation (TXT DM XTEL V5E), Divider C, Section 9 or the MINI X-TEL Software Workshop documentation (TXT DM BJR V5E), Divider C, Section 2. _______________________________________________________________________________________ 3.2-2 Initial Preparations Before installing the XTEL-DOC program on the hard disk, it is recommended that the user: • Make a copy of the program disk and that this disk be used for all installation procedures to avoid accidental damage to the original. Once it has been copied, the original disk should be kept in a safe place, • Carefully read the licence and guarantee certificates that come with this program and that detail the conditions of use and the restrictions that apply to copying and installing the program. Important: The XTEL-DOC program diskette is supplied write protected. Do not change the position of the write protect tab on the diskette. F Important: To install XTEL-DOC on an FTX 507 terminal, first update the Operating System version as described in the Information Sheet (W9 1329 098 01.01.A01) supplied with the terminal. _______________________________________________________________________________________ 3.2-3 Installation Conditions XTEL-DOC is run in the X-TEL or MINI X-TEL Software Workshop environment. The appropriate Software Workshop must already be installed on the microcomputer. Once XTEL-DOC is installed, ensure that at least: • 1 MB of free space is available on the XTEL-DOC target hard disk, • 5 MB of free space is available on the application file hard disk partition. ___________________________________________________________________________ 3/4 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ 3.2-4 Installation Procedure The following operations must be performed before the XTEL-DOC program is installed: 1. Ensure that the X-TEL or MINI X-TEL Software Workshop is already installed (refer to the corresponding documentation): If so, proceed with the XTEL-DOC installation procedure described below. If not, first install the X-TEL (TXT L BASE V5E) or MINI X-TEL (TXT L BJR V5E) Software Workshop (refer to the coresponding documentation). 2. Close all work sessions in progress (refer to the corresponding documentation). XTEL-DOC program installation • Open an OS/2 full screen session, to do so: • Insert the XTEL-DOC diskette into the diskette drive, • Type the drive identification letter (a: or b:), where the diskette is located and press <Enter> to confirm, • Once a new prompt is displayed on-screen (e.g. [A:\] or [B:\]) type install and press <Enter> to confirm, • Follow the prompts displayed on-screen and press <Enter> to confirm the entries made, • Once the installation procedure is complete, and if this is the last program to install, run the configuration check as prompted on-screen, • Remove the XTEL-DOC diskette from the drive and return to the Software Workshop by pressing <Ctrl> <Esc>. When the installation procedure is started, the first screen displayed is: INSTALLATION LOGICIEL XTEL-DOC XTEL-DOC SOFTWARE INSTALLATION (C) TELEMECANIQUE 1990, V5 Press <Enter> to continue: Note: To use XTEL-DOC version 5, a Software Workshop version 5 or higher is required. ___________________________________________________________________________ 3/5 F ___________________________________________________________________________ Once the installation procedure is started by pressing <Enter>, the XTEL-DOC program files are copied to the appropriate Software Workshop sub-directories. Once this is complete, the following screen is displayed: B CONFIGURATION CHECK... The installation procedure can perform a check on the program configuration of the XTEL Software Workshop installed under OS/2. If you have just completed the last program installation required before starting the XTEL Software Workshop, you can run a complete check on the program configuration. If not, run the complete check once you have installed all XTEL software. 1 2 Last installation completed, run configuration check. Run check later, other programs still waiting to be installed in the XTEL Software Workshop. Your choice : The user can select: 1 to run the X-TEL installation check procedure. 2 to skip the installation check. In both cases the XTEL-DOC installation procedure is completed and the following screen displayed: INSTALLATION COMPLETE... The installation procedure is complete. The tool XTEL-DOC is now installed on the X-TEL software workshop of Telemecanique. F Press <Enter>: <Enter> Returns the user to the OS/2 full screen window. ___________________________________________________________________________ 3/6 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ 3.2-5 Installing the Printer Driver A Postscript printer able to print out in landscape mode, in A4 or A3 format, is required. The printer interface can be serial or parallel. In order to print an XTEL-DOC documentation file, the printer driver must first be installed in the system. The following printer parameters must be selected: • From the Printers List, select the appropriate Postscript printer driver for your printer, • From the Papers List, select "Letter", • From the Fonts List, select "Courier", • Select "Landscape" layout mode • Select 100% scaling. These selections are made: • From the Print Manager in OS/2 1.2 and 1.3 (refer to Sub-section 4.1), • From the printer object for OS/2 2.1 (refer to the OS/2 2.1 documentation). F ___________________________________________________________________________ 3/7 ___________________________________________________________________________ 3.3 General _______________________________________________________________________________________ 3.3-1 Accessing XTEL-DOC In X-TEL, XTEL-DOC can be run at: B • Project level, when preparing the Project file: X-TEL Select the volume Select the project Select XTEL-DOC from Project Tools • Station level, when preparing the Station file: X-TEL Select the volume Select the project Select the station Select XTEL-DOC from Station Tools In MINI X-TEL, XTEL-DOC is invoked from the primary window: MINI X-TEL Primary Window Select XTEL-DOC from the Primary Window Primary window F The primary window displays the icons of the functions that available for preparing the application file. These functions are named to match the functions they perform. ___________________________________________________________________________ 3/8 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ 3.3-2 Primary Window Menu doc Window Select About... Quit Define All None Help Reinitialize Copy Paste Window menu command Select → All Simultaneously selects all icons. Select → None Simultaneously deselects all icons. About... Displays the program information screen. Quit Quits XTEL-DOC. Define menu command Reinitialize Reinitializes all selected icons (clears the actions performed with each of the icons). Copy Copies the selected element to the clipboard. Paste Pastes the contents of the clipboard to the selected element. The Copy/Paste actions let the user exchange elements (footer, title page, general information) between two stations or two projects. Help Selects on-line help. ___________________________________________________________________________ 3/9 F ___________________________________________________________________________ 3.4 Contents _______________________________________________________________________________________ 3.4-1 Contents Icon Commands Contents B Configure Next Previous Select Help Configure Lets the user access the Contents icon. Next Activates the next icon (Footer icon). Previous Activates the previous icon (File icon). Select Selects the icon. Help Calls-up the on-line help screen. _______________________________________________________________________________________ 3.4-2 Contents Dialog Box This dialog box displays the contents of the documentation file. When the documentation file is created, a standard table of contents is offered to the user. The table of contents is built by selecting or deselecting the sections and paragraphs available. It is not possible to change the number of paragraphs or their order. For a paragraph assigned to a function or a tool to be available, the function or the tool must first be installed and defined. The sections and paragraphs can be enabled or not, selected or not. F Color Enabled Selected Grey on White No - Black on White Yes No Grey on Black Yes Required White on Black Yes On Request ___________________________________________________________________________ 3/10 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ Current version Displays the contents of the current documentation file. File version Displays the contents of the last documentation file generated. Standard version Displays the standard table of contents, where all enabled paragraphs are selected. OK Quits the function and saves the selections made. Cancel Quits the function without saving the selections made. Help Calls-up the on-line help screen. _______________________________________________________________________________________ 3.4-3 Contents Example Refer to sub-section 1.3. ___________________________________________________________________________ 3/11 F ___________________________________________________________________________ 3.5 Footer _______________________________________________________________________________________ 3.5-1 Footer Icon Commands B Footer Configure Next Previous Select Help Configure Lets the user access the Footer icon. Next Activates the next icon (Title Page icon). Previous Activates the previous icon (Contents icon). Select Selects the icon. Help Calls-up the on-line help screen. _______________________________________________________________________________________ 3.5-2 Footer Dialog Box This dialog box lets the user enter footer information. File revision: Automatically generated by XTEL-DOC. Cannot be modified, F Author: Automatically generated by XTEL-DOC from the user name entered in X-TEL. Can be modified, Four comment fields of up to 20 characters each can be entered, Number: This line starts with N˚ and will normally accept 15 characters (up to 20 if "N˚:" is deleted), Property of: This line lets the user specify a company name of up to 30 characters. The name entered becomes part of the copyright line printed below the footer, as shown in the example on the next page. ___________________________________________________________________________ 3/12 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ Current version Displays the contents of the current documentation file. File version Displays the contents of the last documentation file generated. OK Quits the function and saves the selections made. Cancel Quits the function without saving the selections made. Help Calls-up the on-line help screen. _______________________________________________________________________________________ 3.5-3 Footer Example Comment 1 Comment 4 File Rev.: 02 PROJECT: C:CELL-I1 Paragraph Rev.: 02 Author: XTEL Project: 67989756 PROG: CHART/PAGE 1 Dept. R&D Company: MMI Stage 1 N° : 2437654 Date : 11/01/90 This document cannot be distributed without agreement of Comment 2 Property of: Page : 3-1 Telemecanique Comment 3 Number The File Rev., Paragraph Rev., Date and Page information is automatically generated by XTEL-DOC. The Author information can be entered by the user and takes XTEL by default. ___________________________________________________________________________ 3/13 F ___________________________________________________________________________ 3.6 Title Page _______________________________________________________________________________________ 3.6-1 Title Page Icon Commands B Title Page Configure Next Previous Select Help Configure Lets the user access the "Title Page" dialog box, Next Activates the next icon (General Info. icon), Previous Activates the previous icon (Footer icon), Select Selects the icon, Help Calls-up the on-help screen. _______________________________________________________________________________________ 3.6-2 Title Page Dialog Box This dialog box lets the user enter information (up to 30 characters max.) that will appear on the title page: 1st. Line: COMPANY: Up to 30 characters can be entered, 2nd. Line: PROJECT: Up to 30 characters can be entered, F 3rd. Line: This line comprises two entry fields: One where Station is the default display where up to 10 characters can be entered, for station level documentation, One where up to 30 characters can be entered, 4th. Line: This line comprises two entry fields: One where up to 10 characters can be entered, The other where up to 30 characters can be entered. ___________________________________________________________________________ 3/14 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ OK Quits the function and saves the selections made. Cancel Quits the function without saving the selections made. Help Calls-up the on-line help screen. Current version Displays the contents of the current documentation file. File version Displays the contents of the last documentation file generated. _______________________________________________________________________________________ 3.6-3 Title Page Example TSX V4 TECHNICAL FILE Company Telemecanique Project Factory_3 Station Oven_3 XTEL Level V4.5application application V5 level F File Rev.: Station wag_exl Paragraph Rev.: Author: Comment 1 Title Page Comment 4 Comment 2 Comment 3 Number Date: Page: This document cannot be released with approval of Telemecanique ___________________________________________________________________________ 3/15 ___________________________________________________________________________ 3.7 General Information _______________________________________________________________________________________ 3.7-1 General Information Icon Commands B General Information Configure Next Previous Select File Import Export Help Configure Lets the user access the "General Information" dialog box. Next Activates the next icon (.DOC icon). Previous Activates the previous icon (Title Page icon). Select Selects the icon. File → Import Lets the user access the "Import General Information" dialog box. File → Export Lets the user access the "Export General Information" dialog box. Help Calls-up the on-line help screen. _______________________________________________________________________________________ 3.7-2 General Information Dialog Box This dialog box lets the user select from the files available in the .DOC directory of the selected Project or Station. These files are used to create the General Information page. F If no files are available, it is possible to: • Create new ones with the OS/2 editor, or • Import them with the File → Import action. Reminder: The files selected for importing must be: • ASCII text files (.TXT extension), • Postscript files (.PSC extension) or Encapsulated Postscript files (.EPS). Postscript (.PSC) files can be generated in Word 5.0 and Encapsulated Postscript (.EPS) files in Word for Windows (refer to sub-section 4.3). Note: Files with an .EPS extension must be renamed with a .PSC extension. ___________________________________________________________________________ 3/16 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ • EDIT Lets the user create or modify files with the OS/2 text editor. To create a file, select the ????????.??? file and rename it with the editor (refer to the OS/2 documentation for information on how to use the OS/2 text editor). • Update Once a file is created with the OS/2 text editor, this action lets the user update the "Files available:" list. This ensures that a newly generated file is displayed. • DELETE • DUPLICATE • RENAME Deletes the selected file, Duplicates the selected file and prompts the user to rename the file, Renames the selected file. • SELECT>> Transfers the selected file from the "Files available:" list to the "Files selected:" list. Only files with a .TXT or .PSC extension can be selected. The position of the files in the right hand list is determined by the buttons that apply to this list (the position of a file in the list determines the order in which it is printed): • Start, places the file at the top of the list, • Before, places the file above the previously selected file, • After, places the file below the previously selected file, • End, places the file at the end of the list. • <<REMOVE Transfers the selected file from the "Selected files:" list, to the "Files available:" list. This file is no longer part of the current documentation file. OK Quits the function and saves the selections made. Help Calls-up the on-line help screens. ___________________________________________________________________________ 3/17 F ___________________________________________________________________________ 3.7-3 Import General Information Dialog Box B This dialog box lets the user import Postscript or ASCII text files as files available for General Information from any logical drive and any directory. The "Source directory: " line displays the current directory, The "Directory:" list displays all of the logical drives and directories that are accessible. Double clicking on ".." in the directory list, lets the user return to the next higher level. By selecting a logical drive, a directory or ".." and clicking on it, it is possible for the user to scan all of the directories available on a logical drive. F IMPORT>> Copies to the "Target" list one or more selected text files. These files can then be selected from the current directory by the "Configure" action accessed from the General Info icon. RENAME Renames the file selected from the "Target files" list. OK Quits the function. Help Calls-up the on-line help screen. ___________________________________________________________________________ 3/18 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ 3.7-4 Export General Information Dialog Box This dialog box lets the user export copies of files available for General Information to any logical drive and any directory, for use in other applications. The "Target directory: " line displays the current directory. The "Directory:" list displays all of the logical drives and directories that are accessible. Double clicking on ".." in the directory list, lets the user return to the next higher level. By selecting a logical drive, a directory or ".." and clicking on it, it is possible for the user to scan all of the directories available on a logical drive. <<EXPORT Copies to the "Target" list one or more files selected from the "Source" list. RENAME Renames the file selected from the "Source" list. OK Quits the function. Help Calls-up the on-line help screen. ___________________________________________________________________________ 3/19 F ___________________________________________________________________________ 3.8 Source Documents _______________________________________________________________________________________ 3.8-1 .DOC Source Files Icon Commands Source Documents B .DOC source files Configure Next Previous Select Help Configure Lets the user access the "Source Documents" dialog box. Next Activates the next icon (File icon). Previous Activates the previous icon (General Info. icon). Select Selects the icon. Help Calls-up the on-line help screen. _______________________________________________________________________________________ 3.8-2 Source Documents Dialog Box This dialog box lets the user select PL7-2, PL7-3 (V3, V4 or V5), PL7-AXE, PL7-COM, PL7-NET, PL7-MMI, PL7-PCL, PL7-PMS, PL7-OSI, XTEL-MEM, XTEL-CONF, XTELSDBASE, XTEL-MOD, XBTL940 "Source Documents" for integration into the application file. The list field on the right displays a list of functions and tools available. F The list field on the left displays a list of .DOC files available to the function or tool selected from the list on the right. ___________________________________________________________________________ 3/20 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ SELECT>> Transfers the file selected from the list on the left to the documentation file (list on the right, opposite the appropriate tool). <<REMOVE Removes the selected file from the list on the right and transfers it to the list on the left. This file is no longer part of the current documentation file. Current version Displays the contents of the current documentation file. File version Displays the contents of the last documentation file generated. OK Quits the function and saves the selections made. Cancel Quits the function without saving the selections made. Help Calls-up the on-line help screen. Note: All of the .DOC files that are generated by the various tools and functions must use the same language. The same language must also be selected for XTEL-DOC. F ___________________________________________________________________________ 3/21 ___________________________________________________________________________ 3.9 Documentation File _______________________________________________________________________________________ 3.9-1 Final Doc File Icon Commands File B Final Doc File Access Generate and Print Print Partial Print Next Previous Select Help Access Lets the user access the documentation file access window. Generate and Print Lets the user access the "Select paragraphs to generate" dialog box. Print Lets the user access the "Select paragraphs to print" dialog box. Partial Print Lets the user access the "Select paragraph to print" dialog box. Next Activates the next icon (Contents icon). Previous Activates the previous icon (.DOC icon). Select Selects the icon. Help Calls-up the on-line help screen. _______________________________________________________________________________________ 3.9-2 Select Paragraphs to Generate Dialog Box This is the final operation that lets the user generate and, if necessary, print-out the final documentation file, based on the selected configurations and icons. F To access the dialog box, all of the .DOC files that form the various paragraphs declared in the table of contents must already have been selected. The dialog box will then display a list of all of the sections and paragraphs to generate. The first time generate is selected, all of the paragraphs selected in the table of contents are proposed. Once files have been updated with one of the specialized X-TEL tools, only updated files are proposed. Any file that is regenerated is incremented by one version level (refer to sub-section 2.3-5). ___________________________________________________________________________ 3/22 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ Initial State Returns to the selection initially proposed when the icon was first opened. Select all Selects all sections and paragraphs. GENERATE Starts generation of the final documentation file. A dialog box is displayed to allow the user to identify the modification. The modification can be identified by a comment of up to 30 characters that is displayed in the documentation file update revision list (refer to sub-section 1.3). GENERATE and PRINT Links documentation file generation and printing-out. Cancel Returns the user to primary window of the mode. Help Calls-up the on-line help screen. Continue Starts generation of the selected paragraphs and displays a dialog box with a "Stop Generation" button which displays information while file generation is in progress: page name, current processing etc. Stop Returns the user to the primary window without starting generation. ___________________________________________________________________________ 3/23 F ___________________________________________________________________________ Selecting cross-reference generation mode If the documentation file comparises a PL7-3 program paragraph, XTEL-DOC will offer a choice by dialog box. none B No cross-references are generated. by symbol Starts generation and for the PL7-3 program, displays a simplified view of the cross-references as shown below. by symbol complete Starts generation and for the PL7-3 program, displays a complete view of the cross-references as shown on the next page. Validate starts generation of the selected paragraphs. Cancel returns the user to the primary window. Cross-references "by symbol": F ___________________________________________________________________________ 3/24 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ This simplified presentation avoids increasing the number of pages in the program documentation file. In the PL7-3 program, XTEL-DOC adds the page numbers where the variable is accessed in write mode. This information is displayed opposite the description of the variables and their symbol, and after a "|" separator character. If the variable requires more that 4 or 5 pages of references, XTEL-DOC prints the numbers of the pages around the current page and before or after these numbers prints a specific character ("<" or ">") to indicate that the sequence of cross-references is incompletely printed-out. Complete cross-references: F This presentation doubles the number of pages in the PL7-3 paragraph. It prints-out the Ladder Diagram program on the left half-page and the Literal program or Grafcet on the right-half page: 3 tables of three columns, comprising all of the variables that appear in the left-half page, printed in alphabetical order. The first column comprises the name of the variable, the second column the mnemonic assigned to it and the third column, the reference of the pages where the variable is accessed in write mode. ___________________________________________________________________________ 3/25 ___________________________________________________________________________ 3.9-3 Access Window B Window Zoom + Quit F Access Help Select a paragraph First page Previous Page Page Nbr... Next Page Last Page This window lets the user display the contents of the documentation file. Before this screen can be accessed, the user must first ensure that the Courier font is installed in the system (refer to sub-section 4.2). Window menu Zoom+ Displays the page currently being accessed either in large scale (Zoom active) or so that the entire page can be displayed on-screen (zoom not active). Quit Quits the Access window. ___________________________________________________________________________ 3/26 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ Access menu Select a paragraph Lets the user access the Access dialog box. This dialog box is used to select the paragraph to access. First page Access to the first page of the paragraph to display. Previous Page Access to the page before the one currently being displayed. Page Nbr... Direct access to the page specified by its number. Next Page Access to the page after the one currently being displayed. Last Page Access to the last page of the paragraph to display. Help Calls-up the on-line help screen. ___________________________________________________________________________ 3/27 F ___________________________________________________________________________ 3.9-4 Select Paragraphs to Generate Dialog Box This dialog box displays the table of contents of the final documentation file, with the following display attributes: • Dimmed: Paragraphs that are not present in the documentation file, B • White on black: Paragraphs to print first to ensure an up to date documentation file. Select paragraphs to generate. Initial State Returns the user to the selection displayed when the icon was first selected. Select all Selects all sections and paragraphs. F GENERATE Generates the documentation file. GENERATE and PRINT Generates and prints the documentation file. Cancel Returns the user to the previous window. Help Calls-up the on-line help screen. ___________________________________________________________________________ 3/28 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ 3.9-5 Select Paragraph to Print Dialog Box The Dialog box displays the table of contents for the final documentation file with any paragraphs that do not exist in the documentation shown dimmed. Select a paragraph for a partial print-out. Continue Lets the user access the dialog box shown below allowing the user to select pages in the paragraph to print-out. F Select the pages to print. PRINT Prints the selected pages. Cancel Returns the user to the previous window. Help Calls-up the on-line help screen. ___________________________________________________________________________ 3/29 ___________________________________________________________________________ 3.10 Error Messages _______________________________________________________________________________________ "Are you sure you want to replace xxxx ?" ____________________________________________________________________ Probable cause Remedial action B _______________________________________________________________________________________ The user is asked to confirm the replacement of xxxx by the result of the Copy command. _______________________________________________________________________________________ "Cannot find the .DOC files for tool xxxx." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The directory indicated in the description of Tool/Station xxxx cannot be accessed. _______________________________________________________________________________________ "CAUTION: Error in file xxxx to import." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ File xxxx could not be imported. Check that the file is not protected. _______________________________________________________________________________________ "CAUTION: File not deleted: xxxx." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ File xxxx selected for deletion could not be deleted. Check that it is not write protected or open in an application in another session. _______________________________________________________________________________________ F "CAUTION: File not duplicated: xxxx." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ File xxxx entered as the target file for duplication could not be created. Check that there is not already a file xxxx that is write protected or open in an application in another session. _______________________________________________________________________________________ ___________________________________________________________________________ 3/30 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ "CAUTION: file xxxx does not exist." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The General Information file xxxx referred to by the Copy command no longer exists. _______________________________________________________________________________________ "CAUTION: file xxxx not renamed." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ File xxxx entered as the new name of the renamed file could not be created. Check that there is not already a file xxxx that is write protected or open in an application in another session. _______________________________________________________________________________________ "CAUTION: File xxxx will be overwritten." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The name entered for the resulting Change the filename. file (xxxx) corresponds to an existing file. _______________________________________________________________________________________ "CAUTION: Only files *.TXT or *.PSC can be selected." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The selected file does not have a .TXT or .PSC extension. Rename the file so that it takes one of these extensions, depending on its type (Text or Postscript) or select another file. _______________________________________________________________________________________ "CAUTION: operation impossible, not enough room on the disk" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ There is not enough space on the Release enough space on the volume containing the Project/Station selected volume. where XTEL-DOC is running to perform the operation. _______________________________________________________________________________________ ___________________________________________________________________________ 3/31 F ___________________________________________________________________________ "CAUTION: operation impossible, not enough room on the disk" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ There is not enough space Clear enough space from the B on the target disk. target disk. _______________________________________________________________________________________ "CAUTION: operation impossible, not enough room on the disk" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ There is not enough space on the Release enough space on the volume containing the Project/Station selected volume. where XTEL-DOC is running to perform the operation. _______________________________________________________________________________________ "CAUTION: operation impossible. Refer to file: xxxx." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The command cannot be executed with file xxxx as target. Check that: • The syntax of xxxx corresponds to the filename, • File xxxx is not write protected. _______________________________________________________________________________________ "CAUTION: Operation impossible, same path xxxx." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ It is not possible to import or export Select another path. to and from the space that already contains the General Information files. _______________________________________________________________________________________ F "DOC file : xxxx is invalid" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ Check that: • this file is in semi-graphic format, • that it was generated in the same language as XTEL-DOC. _______________________________________________________________________________________ ___________________________________________________________________________ 3/32 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ "Drive xxxx access not available" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The contents of drive xxxx are: • not formatted or • unreadable _______________________________________________________________________________________ "Error: Proprietary font xxxx not found. Access terminated." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ No .DLL file in path Reinstall XTEL-DOC. \XPROSYS\DLL. _______________________________________________________________________________________ "Error: Public font xxxx not found. Access terminated." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ Font xxxx is not installed. Install and add font xxxx using the OS/2 control panel, refer to subsection 4.2. _______________________________________________________________________________________ "Error while reading index list." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ One of the files assigned to Regenerate the paragraph. paragraph xxxx was modified. _______________________________________________________________________________________ "Error while reading page: xxxx or index: yyyy file." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The files assigned to paragraph Regenerate the paragraph. xxxx were modified. _______________________________________________________________________________________ "Execution Error: Initialization Impossible." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ XTEL-DOC cannot determine the tools Reinstall XTEL-DOC or functions installed for the current Station or Project where it is running. _______________________________________________________________________________________ ___________________________________________________________________________ 3/33 F ___________________________________________________________________________ "Execution Error on xxxx." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ An error occurred while running B .DLL file xxxx. Use another Project/Station to check if the same problem occurs with the same Tool/Function combination. If so, reinstall XTEL-DOC. _______________________________________________________________________________________ "File xxxx selected for Tool/Function xxxx does not exist." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ File xxxx previously selected by Tool/ Replace or select another .DOC Function xxxx, no longer exists in the file. .DOC file space assigned to this Tool/Station. _______________________________________________________________________________________ "Footer list error. Stop printing?" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The Project/Station footer is incoherent. Reconfigure the footer. If the message persists, check the installation of XTEL-DOC. _______________________________________________________________________________________ "Footer not found." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The Project/Station footer or the type of footer was not found. F Reconfigure the footer. If the message remains, check for correct XTEL-DOC installation. _______________________________________________________________________________________ "Impossible to export, drive xxxx is write protected" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The target drive for the Remove write protection. export action is write protected. _______________________________________________________________________________________ ___________________________________________________________________________ 3/34 XTEL-DOC Operating Modes 3 ___________________________________________________________________________ "Impossible to paste: files do not exist." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The space where General Information The original XTEL-DOC tool was was stored and referenced by the removed from the system. Copy command is no longer present. _______________________________________________________________________________________ "Impossible to start: not enough room on the disk" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ Not enough space left on the disk/ Leave at least 30 Kbytes free volume containing the Project/Station space. that XTEL-DOC is run from. _______________________________________________________________________________________ "Incompatible buffer: Nothing pasted." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ There is an incompatibility between the Select compatible elements. elements selected for the Copy command and the elements selected for the Paste command. ______________________________________________________________________________________ "Load error on xxxx." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ An error occurred while loading .DLL file xxxx. Use another Project/Station to check if the same problem occurs with the same Tool/Function combination. If so the .DLL file was modified and XTEL-DOC must be reinstalled. _______________________________________________________________________________________ "Memory allocation error on font loading." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ There is not enough memory available to load the font. Release memory by closing other applications. If necessary, quit XTEL-DOC then restart it again later. _______________________________________________________________________________________ ___________________________________________________________________________ 3/35 F ___________________________________________________________________________ "Not enough room on the disk" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ For each paragraph to generate, Clear extra space on the Disk/ B a test is made to ensure that there Volume that contains the Project/ is at least enough space for the Station from which XTEL-DOC is .DOC file of the related tool. run, before the file can be generated. _______________________________________________________________________________________ "Paragraph page and index files not found: xxxx" ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ The files assigned to Regenerate the paragraph. paragraphs xxxx are no longer accessible. _______________________________________________________________________________________ "Read error in general information file xxxx." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ File xxxx, that contains the list Reselect the files that for the of files selected to make up paragraph. the General Information paragraph was damaged. _______________________________________________________________________________________ "Tool/Function xxxx not loaded." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ F The Tool or Function xxxx is not Remove and reinstall this Tool/ loaded and therefore not documented Function. in XTEL-DOC. The paragraphs related to it are therefore not included in the contents. _______________________________________________________________________________________ "Update error." ____________________________________________________________________ Probable cause Remedial action _______________________________________________________________________________________ An error occurred while updating Generate the file again. If the error the internal structure of persists, reinitialize the entire file. XTEL-DOC. A file may have remained open due to a generating error. _______________________________________________________________________________________ ___________________________________________________________________________ 3/36 ________________________________________________________ Appendix 4 Appendix Section 4 ___________________________________________________________________________ ___________________________________________________________________________ Sub-section Page _______________________________________________________________________________________ 4.1 Printer Driver Installation and Configuration 4/2 _______________________________________________________________________________________ 4.1-1 Printer Driver Installation for OS/2 1.2/1.3 4/2 _______________________________________________________________________________ 4.1-2 Printer Driver Configuration for OS/2 1.2/1.3 4/4 _______________________________________________________________________________ 4.1-3 Printer Driver Installation for OS/2 2.1 4/6 _______________________________________________________________________________ 4.1-4 Printer Driver Configuration for OS/2 2.1 4/6 _______________________________________________________________________________ 4.1-5 Example 4/6 _______________________________________________________________________________ _______________________________________________________________________________________ 4.2 Courier Font Installation 4/7 _______________________________________________________________________________________ 4.2-1 For OS/2 1.2/1.3 4/7 _______________________________________________________________________________ 4.2-2 For OS/2 2.1 4/8 _______________________________________________________________________________ _______________________________________________________________________________________ 4.3 Generating Text Files in Word 5.0 or Word for Windows 4/9 _______________________________________________________________________________________ _______________________________________________________________________________________ 4.4 Storing Documentation Files on Diskette 4/10 _______________________________________________________________________________________ This section ends on page 4/10 F ___________________________________________________________________________ 4/1 ___________________________________________________________________________ 4.1 Printer Driver Installation and Configuration _______________________________________________________________________________________ 4.1-1 Printer Driver Installation for OS/2 1.2/1.3 • Open the Desktop ManB ager window and select the Utilities Group, • From the Utilities Group menu, select the Control Panel, • From the Control Panel, select the Installation menu, • Select the Add Printer Driver action which displays the screen shown below: • Insert the printer driver diskette, • Select the Enter button to list all of the printer drivers available on the diskette. F ___________________________________________________________________________ 4/2 Appendix 4 ___________________________________________________________________________ • Select the printer driver required, • Select the Add button. • If the printer driver is already present on the hard disk, the following screen is displayed: F * Select Yes to replace the existing version or No to add the newly selected printer driver without replacing the previous version. ___________________________________________________________________________ 4/3 ___________________________________________________________________________ 4.1-2 Printer Driver Configuration for OS/2 1.2/1.3 • Select the Print Manager by double clicking on its icon, B • Select Setup, then select Printer install, F • Select the appropriate printer driver for the Postscript printer to be used, • Select port LPT1 and assign a name to the printer, • Click on OK to confirm. ___________________________________________________________________________ 4/4 Appendix 4 ___________________________________________________________________________ • Select the options shown opposite, • Click on the Job Properties button, • Select the options shown opposite, • Click on Ok to confirm. F ___________________________________________________________________________ 4/5 ___________________________________________________________________________ 4.1-3 Printer Driver Installation for OS/ 2.1 Refer to the OS/2 Version 2.1 User's Guide, Section 16 - Printers and Plotters. B ________________________________________________________________________________________ 4.1-4 Printer Driver Installation for OS/2 2.1 The parameters defined for a printer driver are known as printer characteristics and define the hardware configuration of the printer. The parameters to select are listed below: • Paper format • Presentation • Scale • Font : A4 , : Landscape : 100%, : Courrier. To define the printer characteristics, refer to the OS/2 Version 2.1 User's Guide, Section 16 - Printers and Plotters. Note: If the results obtained when printing are not satisfactory (shifted page layout, etc.), refer to the OS/2 Version 2.1 User's Guide, Section 28 - "Printing Errors" paragraph. _________________________________________________________________________________________ 4.1-5 Example F FTX 507 QMS PS 810 Microcomputer Telemecanique T FTX 507 55 11E microcomputer with: • 120 MB hard disk, • 8 MB RAM memory. Printer QMS PS 810 Postscript laser printer. The FTX 507/Printer interface uses the parallel ports on the two devices. The printer is set-up as described in Sub-section 3.2-5. ___________________________________________________________________________ 4/6 Appendix 4 ___________________________________________________________________________ 4.2 Courier Font Installation _______________________________________________________________________________________ 4.2-1 For OS/2 1.2/1.3 • Open the Desktop Manager window and select the Utilities Group, • From the Utilities Group menu, select the Control Panel, • From the Control Panel, select the Installation menu, • Select the Add Font action which displays the screen shown below: • Insert the printer driver diskette, • Select the Enter button to list all of the fonts available on the diskette. F ___________________________________________________________________________ 4/7 ___________________________________________________________________________ • Select the file with the courrier font from the list displayed. • Select Add. B _______________________________________________________________________________________ 4.2-2 For OS/2 2.1 F If the courrier font was not installed when OS/2 2.1 was installed, proceed as described below: • Select the "OS/2" icon, • Select the "System Configuration" icon, • Select the "Custom Installation" icon, - Skip the first screen by selecting OK, - From the second screen, select "Fonts" and click on the "Next" button, - Insert the OS/2 2.1 installation diskette and follow the instructions. ___________________________________________________________________________ 4/8 Appendix 4 ___________________________________________________________________________ 4.3 Generating Text Files in Word 5.0 or Word for Windows _______________________________________________________________________________________ In order to integrate Postscript (.PSC) files generated with Microsoft Word 5.0 or Encapsulated Postscript (.EPS) files generated with Microsoft Word for Windows into XTEL-DOC General Information paragraphs, select the following page layout values from the Word 5.0 Format Division Margins menu: • To select A4 Landscape (i.e. Horizontal) format: • Page length = 21 cm • Page width = 29.7 cm • To avoid exceeding the correct page size and to leave room for the footer: • Top margin ≥ 0 cm • Bottom margin ≥ 5 cm • Left margin + Gutter ≥ 2 cm • Right margin ≥ 2 cm • Even/Odd margins: No In Word 5.0 select "Postscra" from the Output Options menu in order to generate a Postscript file that can be used by XTEL-DOC. Note: If styles are used to format the document, ensure that they are present before printing the file to disk. F ___________________________________________________________________________ 4/9 ___________________________________________________________________________ 4.4 Storing Documentation Files on Diskette _______________________________________________________________________________________ To store XTEL-DOC documentation files, the context must be stored too (especially when managing different documentation file versions). B a Project to/from a diskette in X-TEL: Backing-up and Restoring The complete procedure for backing-up and restoring a project to/from a disk are described in the X-TEL Software Workshop documentation (TXT DM XTEL V5E), Divider C, Sub-section 3.2-2. Backing-up a Station to a diskette: • First identify the directories where the required Station files are stored, • Open a full-screen OS/2 session, • Type BACKUP BACKUP D:\XPROPRJ\project_name\station_name A:/F/S Note: /F is not required if the inserted diskettes are already formatted. Once the command has been executed, copy to a diskette the: • station_name.sta file. E.g.: COPY D:\XPROPRJ\project_name\station_name.sta A: Restoring a Station from a diskette: • First identify the directories where the required Station files are stored, • Open a full-screen OS/2 session, • Type RESTORE RESTORE A: D:\XPROPRJ\project_name\station_name/S Once the command has been executed, restore from the diskette the: • station_name.sta file. E.g.: COPY A: D:\XPROPRJ\project_name\station_name.sta F Backing-up and Restoring a Project to/from a diskette in MINI X-TEL: The complete procedure for backing-up and restoring a project to/from a disk are described in the MINI X-TEL Software Workshop documentation (TXT DM BJR V5E), Divider C, Sub-section 1.2-7 and 1.2-8. ___________________________________________________________________________ 4/10 ">
Download
Advertisement
Key features
Supports documentation produced by new X-TEL V5 functions
Reads, regenerates, and merges documentation files created by XTEL-DOC V4 or V42
Customizable documentation files with user-defined content and layout
Integration with X-TEL tools and functions for seamless documentation generation
Comprehensive error handling and reporting for quick troubleshooting
User-friendly interface for intuitive operation
Frequently asked questions
XTEL-DOC can manage documentation files generated by Schneider Electric products such as PL7, XBTL940, XTEL-CONF, XTEL-SDBASE, and XTEL-MOD.
XTEL-DOC V5 can only be installed on an X-TEL or MINI X-TEL V5 system.
XTEL-DOC allows users to customize the documentation file by adding user-defined content, modifying the layout, and adjusting the formatting.
The manual does not specify the output formats supported by XTEL-DOC.
Yes, XTEL-DOC has comprehensive error handling and reporting features for quick troubleshooting.