Page 1
EAGLE XML EDITOR USER GUIDE
VERSION 12
4 July 2014
A Product of Raytheon Company
1997-2014 Raytheon Company
ALL RIGHTS RESERVED
U.S. Patents 4,847,795; 5,457,792; 5,493,679;
5,737,532; 7,930,052; 8,560,105
Made in the U.S.A.
Enhanced
Automated
Graphical
Logistics
Environment
Page 2
COPYRIGHT 1997-2014 RAYTHEON COMPANY
UNPUBLISHED WORK - ALL RIGHTS RESERVED.
This document shall not be published, or disclosed to others, or duplicated in
whole or in part without written permission of Raytheon Company.
All other company and product names used herein may be the trademarks or
registered trademarks of their respective companies.
Information in this manual may change without notice and does not represent a
commitment on the part of Raytheon Company and its subsidiaries.
Revision History
Printed August 2012 First Edition
Printed November 2012 Second Edition
Printed July 2014 Third Edition
Printed July 2014
The EAGLE Software Package has become the
best of its kind thanks, in large part, to its clients.
We would like to take this opportunity to thank all
of you for your suggestions, insights and support.
In addition, we want to renew our commitment to
you, our valued clients.
Page 3
EAGLE XML Editor User Guide Version 12
TABLE
OF
CONTENTS
Page 5
EAGLE XML Editor User Guide TABLE OF CONTENTS
v
TABLE OF CONTENTS
TABLE OF CONTENTS .................................................................................................. v
LIST OF ILLUSTRATIONS .......................................................................................... xi
SECTION 1 INTRODUCTION .............................................................................. 1-3
1.1 INTRODUCTION ........................................................................................... 1-3
1.2 CONVENTIONS USED IN THIS DOCUMENT ......................................... 1-3 1.2.1 General Conventions ............................................................................................. 1-3 1.2.2 Mouse Conventions ............................................................................................... 1-4 1.2.3 Keyboard Conventions .......................................................................................... 1-4 1.2.4 Window Conventions ............................................................................................ 1-4
1.3 AUTHORING STRUCTURED DOCUMENTS........................................... 1-4 1.3.1 What is XML ......................................................................................................... 1-5 1.3.2 Benefits of Structured Authoring........................................................................... 1-6
1.4 EAGLE XML EDITOR DESCRIPTION ..................................................... 1-6 1.4.1 Setting the XML Editor as the EPS Default .......................................................... 1-7 1.4.2 XML Editor User Interface Overview ................................................................... 1-8 1.4.3 XML Edit Window ................................................................................................ 1-9 1.4.4 Attributes Window .............................................................................................. 1-10 1.4.5 Character Entities Window .................................................................................. 1-11 1.4.6 Tags Window ...................................................................................................... 1-11 1.4.7 Validation Results Window ................................................................................. 1-12
1.5 WINDOW USER OPTIONS ........................................................................ 1-12 1.5.1 Undock a Window ............................................................................................... 1-12 1.5.2 Re-dock a Window .............................................................................................. 1-13 1.5.3 Reposition a Window .......................................................................................... 1-14 1.5.4 Preview Window ................................................................................................. 1-14
1.6 MAIN TOOLBAR ......................................................................................... 1-15 1.6.1 Toolbar Icons ....................................................................................................... 1-15
1.6.1.1 Validate Icon ................................................................................................... 1-16 1.6.1.2 Save Icon ......................................................................................................... 1-16 1.6.1.3 Undo Icon ........................................................................................................ 1-16 1.6.1.4 Redo Icon ........................................................................................................ 1-17 1.6.1.5 Cut, Copy and Paste Icon’s .............................................................................. 1-17 1.6.1.6 Insert Entity Icon ............................................................................................. 1-17 1.6.1.7 Insert External Reference Icon ........................................................................ 1-17 1.6.1.8 Insert Internal Reference Icon ......................................................................... 1-17 1.6.1.9 Insert LSA XREF Icon .................................................................................... 1-18 1.6.1.10 Insert Comment Icon ................................................................................... 1-18
Page 6
EAGLE XML Editor User Guide TABLE OF CONTENTS
vi
1.6.1.11 Toggle Preview Icon .................................................................................... 1-18 1.6.1.12 Spell Checker Icon ...................................................................................... 1-18
1.6.2 Toolbar Menus .................................................................................................... 1-19 1.6.2.1 File ................................................................................................................... 1-19 1.6.2.2 Edit .................................................................................................................. 1-20 1.6.2.3 View ................................................................................................................ 1-20 1.6.2.4 Insert ................................................................................................................ 1-21 1.6.2.5 Tools ................................................................................................................ 1-22 1.6.2.6 Help ................................................................................................................. 1-22
SECTION 2 BASIC EDITING ................................................................................ 2-3
2.1 INTRODUCTION ........................................................................................... 2-3
2.2 OPENING A DATA MODULE FOR EDIT ................................................. 2-3
2.3 OPENING A PROCEDURAL DATA MODULE LINKED TO THE LSAR
FOR EDIT ................................................................................................................... 2-3
2.4 VIEWING DOCUMENT PROPERTIES ..................................................... 2-6
2.5 ADDING CONTENT AS ELEMENTS ......................................................... 2-6
2.6 DELETING ELEMENTS ............................................................................... 2-8
2.7 ADDING ELEMENTS ATTRIBUTES ......................................................... 2-8
2.8 DELETING ELEMENT ATTRIBUTES .................................................... 2-10
2.9 ADDING TABLES ........................................................................................ 2-10 2.9.1 Creating Tables with Table Editor ....................................................................... 2-10 2.9.2 Editing Tables with Table Editor ......................................................................... 2-12 2.9.3 Adding a Table Title ............................................................................................ 2-14 2.9.4 Adding a Reference to a Table ............................................................................ 2-14
2.10 INSERTING ENTITIES ........................................................................... 2-16 2.10.1 Inserting a Reference to a Figure ......................................................................... 2-18 2.10.2 Inserting a Reference to a Hotspot in a Figure .................................................... 2-19
2.11 INSERTING REFERENCES TO DATA MODULES ........................... 2-20
2.12 INSERTING COMMENTS ...................................................................... 2-22
2.13 INSERTING INTERNAL REFERENCES TO LSAR OBJECTS IN THE
DATA MODULES ................................................................................................... 2-22
2.14 SPELL CHECKING THE CONTENT ................................................... 2-24
SECTION 3 VALIDATING CONTENT ................................................................ 3-3
3.1 INTRODUCTION ........................................................................................... 3-3
3.2 VALIDATING THE DATA AGAINST THE SCHEMA ............................ 3-3
Page 7
EAGLE XML Editor User Guide TABLE OF CONTENTS
vii
3.3 VALIDATING THE DATA AGAINST THE BREX DATA MODULE ... 3-6
SECTION 4 ADVANCED FEATURES.................................................................. 4-3
4.1 INTRODUCTTION ........................................................................................ 4-3
4.2 FIND AND REPLACE ................................................................................... 4-3 4.2.1 Find ........................................................................................................................ 4-3 4.2.2 Replace .................................................................................................................. 4-4
4.3 SPELL CHECKER ......................................................................................... 4-4
4.4 DOCTYPE MANAGER ................................................................................. 4-6
SECTION 5 USER PREFERENCES ...................................................................... 5-3
5.1 INTRODUCTION ........................................................................................... 5-3
5.2 EDITOR - GENERAL .................................................................................... 5-4 5.2.1 Data Save/Export ................................................................................................... 5-4 5.2.2 Drag_Drop/Paste ................................................................................................... 5-4 5.2.3 Miscellaneous ........................................................................................................ 5-4 5.2.4 Prompt Defaults ..................................................................................................... 5-4 5.2.5 Text Settings .......................................................................................................... 5-5
5.3 EDITOR - LAYOUT ....................................................................................... 5-5 5.3.1 Layout .................................................................................................................... 5-5
5.4 EDITOR - SPELLCHECKER ....................................................................... 5-6 5.4.1 Added, Removed and Ignored Tabs ...................................................................... 5-6
5.5 VALIDATION ................................................................................................. 5-7 5.5.1 Misc ....................................................................................................................... 5-7
SECTION 6 KEYBOARD SHORTCUTS .............................................................. 6-3
6.1 INTRODUCTION ........................................................................................... 6-3
INDEX ............................................................................................................................... 3
Page 8
EAGLE XML Editor User Guide TABLE OF CONTENTS
viii
Page 9
EAGLE XML Editor User Guide Version 12
LIST
OF
ILLUSTRATIONS
Page 11
EAGLE XML Editor User Guide LIST OF ILLUSTRATIONS
xi
LIST OF ILLUSTRATIONS FIGURE PAGE
Figure 1. EAGLE Main Screen – Tools >>Options ..................................................................... 1-7 Figure 2. EAGLE Set Options Window ....................................................................................... 1-7 Figure 3. EAGLE XML Editor Main Screen ............................................................................... 1-8 Figure 4. XML Edit Window Header ........................................................................................... 1-9 Figure 5. XML Edit Window ....................................................................................................... 1-9 Figure 6. Child elements cannot be added after </para> ............................................................... 1-9 Figure 7. Child elements can be added after <descript> ............................................................ 1-10 Figure 8. Vertical Tag Navigation Bar ....................................................................................... 1-10 Figure 9. Attributes Window ...................................................................................................... 1-11 Figure 10. Character Entities Window ....................................................................................... 1-11 Figure 11. Tags Window ............................................................................................................ 1-12 Figure 12. Validation Results Window ...................................................................................... 1-12 Figure 13. Undock a Window .................................................................................................... 1-13 Figure 14. Re-dock a window .................................................................................................... 1-14 Figure 15. Preview Window Open ............................................................................................. 1-15 Figure 16. Toolbar Icons ............................................................................................................ 1-15 Figure 17. Main Toolbar>>File .................................................................................................. 1-19 Figure 18. Edit Menu.................................................................................................................. 1-19 Figure 19. View Menu................................................................................................................ 1-20 Figure 20. Insert Menu ............................................................................................................... 1-21 Figure 21. Tools Menu ............................................................................................................... 1-22 Figure 22. Help Menu ................................................................................................................ 1-22 Figure 23. Opening a Data Module for Edit with EAGLE XML Editor ...................................... 2-3 Figure 24. Opening a Data Module Linked to the LSAR for Edit ................................................ 2-4 Figure 25. XML Editor: Linked to Task Message ........................................................................ 2-4 Figure 26. Multiple Subtasks Opened For Edit ............................................................................ 2-5 Figure 27. Subtask 3 - Multiple Subtask Edit Window ................................................................ 2-5 Figure 28. Document Properties ................................................................................................... 2-6 Figure 29. Position Cursor ............................................................................................................ 2-7 Figure 30. Select Element Tags .................................................................................................... 2-7 Figure 31. Insert Element Tag – Ctrl+Enter ................................................................................. 2-8 Figure 32. Delete Tags ................................................................................................................. 2-8 Figure 33. Insert Element Attribute .............................................................................................. 2-9 Figure 34. Element Attribute ........................................................................................................ 2-9 Figure 35. Deleting Element Attribute ....................................................................................... 2-10 Figure 36. Table Editor – Create Table ...................................................................................... 2-10 Figure 37. New Table Window – Rows and Columns ............................................................... 2-11 Figure 38. Example Table .......................................................................................................... 2-11 Figure 39. Example Table Markup ............................................................................................. 2-12 Figure 40. Table Editor – Edit Table .......................................................................................... 2-12 Figure 41. Table Editor – Tags>>para ....................................................................................... 2-13 Figure 42. Sample Table Header Row ....................................................................................... 2-13
Page 12
EAGLE XML Editor User Guide LIST OF ILLUSTRATIONS
xii
Figure 43. Sample Row Entries .................................................................................................. 2-14 Figure 44. Insert – Internal Reference ........................................................................................ 2-15 Figure 45. Insert Internal Reference Window – Table Selected ................................................. 2-15 Figure 46. Sample Internal Reference ........................................................................................ 2-16 Figure 47. Insert>>Entity ........................................................................................................... 2-16 Figure 48. Insert Entity Window – Training Bicycle CGM ....................................................... 2-17 Figure 49. Sample Figure Inserted ............................................................................................. 2-18 Figure 50. Cursor Placed for Insert ............................................................................................. 2-18 Figure 51. Insert Internal Reference – Figure Selected .............................................................. 2-18 Figure 52. Example Internal Reference ...................................................................................... 2-19 Figure 53. Internal Reference Window – Hotspot Reference ..................................................... 2-19 Figure 54. Example Hotspot Reference ...................................................................................... 2-20 Figure 55. Valid Reference Insertion Point IAW ....................................................................... 2-20 Figure 56. Insert - Reference ...................................................................................................... 2-20 Figure 57. Insert Reference Window – DM Selected ................................................................. 2-21 Figure 58. Data Module Reference Inserted ............................................................................... 2-21 Figure 59. Comment Icon Dropdown ......................................................................................... 2-22 Figure 60. Example Comments .................................................................................................. 2-22 Figure 61. Main Screen - Insert>>LSA XREF ........................................................................... 2-23 Figure 62. Insert LSA XREF Window – Tools (CG) Tab .......................................................... 2-23 Figure 63. InternalLsaRef Example ........................................................................................... 2-24 Figure 64. View >> Validation Results ........................................................................................ 3-3 Figure 65. View >> Validation Results ........................................................................................ 3-4 Figure 66. XML Validated ........................................................................................................... 3-4 Figure 67. Invalid tag indication (shown in red) .......................................................................... 3-4 Figure 68. Validation errors found ............................................................................................... 3-5 Figure 69. Hide Error Dialogs Box Clicked ................................................................................. 3-5 Figure 70. BREX Validation Errors ............................................................................................. 3-6 Figure 71. Find and Replace - Find .............................................................................................. 4-3 Figure 72. Spell Checker Errors ................................................................................................... 4-5 Figure 73. Spell Checker window ................................................................................................ 4-5 Figure 74. Doctype Manager Window ......................................................................................... 4-6 Figure 75. Preferences>>Editor – General Window .................................................................... 5-3 Figure 76. Preferences – Editor>>Layout Top Shown ................................................................. 5-5 Figure 77. Preferences – Editor>>Layout Bottom Shown ........................................................... 5-5 Figure 78. Preferences Editor - SpellChecker Window ................................................................ 5-6 Figure 79. Preferences - Validation Window ............................................................................... 5-7 Figure 80. Keyboard Shortcuts ..................................................................................................... 6-3
Page 13
EAGLE XML Editor User Guide Version 12
SECTION 1
INTRODUCTION
Page 15
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-3
SECTION 1 INTRODUCTION
1.1 INTRODUCTION
This section provides an overview of the EAGLE XML Editor. This section will include General
conventions that will be used throughout the User Guide, as well as notation for different parts of
the EAGLE XML Editor.
Initial design requirements for the EAGLE XML Editor were primarily ASD S1000D
requirements. Beginning with the July 4th
Version 12 EAGLE Publishing System release, the
vastly improved EAGLE XML Editor incorporated MIL-STD-40051 Work Package capability.
1.2 CONVENTIONS USED IN THIS DOCUMENT
Before using the EAGLE XML Editor, it is important to understand the terms and notation
conventions used in the documentation.
1.2.1 General Conventions
The word “choose” is used for carrying out a menu command or a command button in a
dialog box.
The word “select” is used for highlighting the object that the next action is to affect, and
for selecting a specific dialog box option.
Commands that are chosen are given with the menu name preceding the command name.
For example, the phrase “choose File>>Open Project …” means choose the Open
Project… command from the File menu. This naming convention describes the sequence
that should be followed in choosing a command --- select the menu first and then choose
the command.
Data fields that should be entered by the user into the application are enclosed in single
quotation marks preceded by the words “type in” or “enter”
The word “STEP” is used to indicate that the following instructions are steps that should
be performed by the user while taking the training class. Each step or user action is
preceded by a bullet symbol ( ● )
Button names, key stroke combinations, menu items and tabs are in bold print to help
emphasize what is being typed in or selected with the mouse.
Page 16
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-4
1.2.2 Mouse Conventions
The word “Click” means to press and immediately release the mouse button without
moving the mouse. For example, “Click OK”
The phrase “Double-click” means to click the mouse button twice in rapid succession.
For example, “Double-click the EAGLE Publishing System icon to start EAGLE
Publishing System”.
The phrase “drag” means to press and hold the mouse button while you move the mouse;
then, release the button.
1.2.3 Keyboard Conventions
Key names match the names shown on most keyboards and appear in bold caps. For
example the Shift key appears as SHIFT
A plus (+) sign used between two key names indicates both keys must be pressed at the
same time. For example, “Press SHIFT+F1” means press the SHIFT key and hold it
down while you press the F1 key.
A comma (,) between two key names indicates that those keys must be pressed
sequentially. For example, “Press ALT+F,O” means press the ALT key and the F key at
the same time and release them, and then press the O key and release it.
Ctrl+Click is used to Select specific records. Hold down the CTRL key and left Click
with the mouse.
1.2.4 Window Conventions
Response windows cannot be closed using the normal window conventions. They will
have an Ok or Cancel button for response, and they will close upon completion.
Checkboxes are square objects on a window that allow selection of certain criteria. They
are designed so that more than one checkbox can be checked at a time.
Radio buttons are circular objects on a window that allow selection of certain criteria.
They are designed so that only one radio button can be selected at a time.
Tabs exist on a window providing methods of accessing different areas of the window.
When a tab is clicked on, the window changes to reflect the tab information.
1.3 AUTHORING STRUCTURED DOCUMENTS
XML and structured authoring provides a methodology to enforce content and document structure
requirements. By giving a context to data by surrounding it with markup tags or elements, data
can be processed and managed by data processing systems such as EAGLE Publishing System.
When documents are authored manually by technical authors, they must refer to an authoring
guide to make sure that the work is consistent with the style of the organization and with the other
authors. Structured authoring uses a document type file (either a document type definition (DTD)
or a schema) that describes the content rules for different documents.
Page 17
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-5
S1000D uses both DTDs and schemas. The EAGLE XML Editor is compatible with S1000D
XML schemas that manage what content is allowed to be generated by reading the schemas and
through the use of hierarchical tags.
Examples of content rules may include:
Warnings cannot appear inside notes
A bulleted list must contain at least two items
A graphic must have a caption
Elements contain content, either text or other content. The parent/child element hierarchy
associates related information explicitly, for example; part number, nomenclature, manufacturer
and quantity. In a typical unstructured document the associations between elements are only
implied by their position on the page.
Elements can have attributes that are used to store information about the element and can be used
to further classify the element and its content.
The formatting of structured documents for output as either hard copy or electronic is
implemented by the publishing system application.
1.3.1 What is XML
Extensible Markup Language (XML) is closely related to other markup languages, such as
Standard Generalized Markup Language (SGML) and defines a standard for storing structured
content in text files. The standard is maintained by the World Wide Web Consortium (W3C).
XML is a markup language and content is enclosed by tags. In XML, element tag names are
enclosed in angle brackets: <para>This is a paragraph of text.</para>. A closing tag is indicated
by a forward slash in front of the element name. Attributes are stored inside the element tags:
<para authname="David Jacques">This is a paragraph of text.</para>.
XML does not provide a set of predefined tags. Instead, the tags, attributes and relationships
between them can be defined as required. This makes it possible for ASD S1000D and MIL-STD-
40051 to define and implement a content structure that matches the requirements of the
information being produced.
Page 18
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-6
1.3.2 Benefits of Structured Authoring
Instead of wrestling with format and layout of a document, writers can focus on the technical
content and organization. After the initial transition and learning curve, working within a structure
increases writer productivity and improves the quality and consistency of the final output. During
quality assurance the structure of the document can be automatically validated eliminating the
need for editors to check a document for structure. Instead, editors can focus on word choice,
grammar, and technical accuracy. By automating some of the most tedious parts of the editing job,
a structured authoring environment makes it possible for editors to do a more thorough edit in the
same amount of time.
1.4 EAGLE XML EDITOR DESCRIPTION
The EAGLE XML Editor was developed to provide an application for the generation and editing
of XML data stored in the EAGLE database. The EAGLE XML Editor is initiated directly from
the EAGLE Publishing System for use with ASD S1000D XML data modules and MIL-STD-
40051 work Packages.
It allows a technical writer to edit XML content as it is validated by the data module schema. It
shows the user what elements and attributes are valid at the current point in the content.
The editor communicates with the EAGLE database and has utilities that assist the writer in
searching the data base for assets, inserting figures, hotspots and character entities, and hyperlinks
to other data modules.
A rendered preview of the XML content is available. There are validation tools to check the
content for validity against the schema and the BREX data module.
Page 19
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-7
1.4.1 Setting the XML Editor as the EPS Default
In EAGLE, from the Main screen, select Tools>>Options.
Figure 1. EAGLE Main Screen – Tools >>Options
Select ‘EAGLE XML’ from the Editor: dropdown list.
Figure 2. EAGLE Set Options Window
Page 20
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-8
1.4.2 XML Editor User Interface Overview
The default window arrangement is with the XML edit window on the left. The Attributes window
is top right. The Character Entities window is right center. The Tags window is right bottom. And
the Validation Results window is along the bottom.
The windows, other than the XML edit window can be closed by clicking the close (X) button.
The position of the window on the screen can be changed by the user by left clicking the header
and dragging.
Figure 3. EAGLE XML Editor Main Screen
Page 21
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-9
Figure 4. XML Edit Window Header
1.4.3 XML Edit Window
The XML edit window header will display either the data module code of the data module being
edited or the work package if using 40051.
The XML edit window shows the content as XML tags in bold black font, attributes and content.
The cyan color highlights the content that can be edited.
Attributes are shown as red text.
Figure 5. XML Edit Window
Clicking inside an element will turn the current element purple and its child green, dark purple
indicates that child elements can be added. Light purple indicates that there are no new child
elements that can be added
Figure 6. Child elements cannot be added after </para>
Page 22
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-10
Figure 7. Child elements can be added after <descript>
The vertical tag navigation bar to the left of the edit window uses chevrons to indicate where the
open and close tags of the currently selected element appear in the content. Clicking on a chevron
will navigate the edit window to the tag.
Spell checking errors can also be indicated in the navigation bar by a red line, clicking on the line
will navigate the edit window to the error.
Figure 8. Vertical Tag Navigation Bar
1.4.4 Attributes Window
The Attributes window displays a pick-list of allowable attributes for the current element. When
the cursor is positioned inside an element the valid attribute list is displayed. Attributes can be
selected by clicking on them.
Page 23
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-11
Figure 9. Attributes Window
1.4.5 Character Entities Window
To insert special characters into the content, ISO entities are selected from the Character Entities
window. Typing characters into the filter field will filter the list.
Figure 10. Character Entities Window
1.4.6 Tags Window
The Tags window displays a pick-list of allowable XML element tags for the current position in
the content as controlled by the schema. When the cursor is positioned in the content, the valid
tags list is displayed. Tags can be selected by clicking on them.
Page 24
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-12
Figure 11. Tags Window
1.4.7 Validation Results Window
The Validation Results window on the bottom of the screen reports the results of parsing the
content against the schema. It also displays the Validation setting, On or Off and S1000D issue.
Figure 12. Validation Results Window
1.5 WINDOW USER OPTIONS
Users can arrange the windows on the editor according to their preference.
1.5.1 Undock a Window
Click the undock icon ( ) to undock a window from the editor. Left-click on the window title
bar and drag to reposition the window on the screen.
Page 25
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-13
Figure 13. Undock a Window
1.5.2 Re-dock a Window
Click the dock icon ( ) to re-dock a window to the editor.
Page 26
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-14
Figure 14. Re-dock a window
1.5.3 Reposition a Window
Windows can be repositioned on the screen. Right-click in the window title bar and drag the
window. Arrows facing out to the screen edges will appear, drag the cursor and the window title
bar over the appropriate arrow to dock the window at that position. The panel will turn blue when
the cursor is positioned correctly. Release the mouse button to re-dock the window at the desired
location.
1.5.4 Preview Window
The content can be rendered in a PDF preview window as the content is entered. The preview is
only a representation of the content and is not intended to show exactly how the content will be
output after publishing. Some data module types are used for processing and are not intended for
users to see. These data module types will not be rendered in the preview window.
To open the preview window, click View>>Toggle Preview window [Ctrl+Shift+P], or click the
Toggle Preview icon ( ) on the toolbar.
Page 27
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-15
The preview will update about a second after typing new content stops.
The preview window auto navigates to the current edit window cursor location.
Figure 15. Preview Window Open
1.6 MAIN TOOLBAR
The Main Toolbar of the EAGLE XML Editor includes all the menu options required for editing,
validation and administrative functions. Along with the classic text based toolbar present on all
Windows applications, there are also hot-buttons present for quick access of some of the more
commonly used functions.
1.6.1 Toolbar Icons
Some of the EAGLE XML Editor menu functions can be accessed by clicking the toolbar icon
Figure 16. Toolbar Icons
Page 28
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-16
1.6.1.1 Validate Icon
Clicking the Validate Icon will validate the XML against the specific schema. If errors are
detected, a ‘XML failed to Validate’ message will be displayed. Additionally, an error dialog box
will point out possible error causes.
Clicking the button when displayed will hide the error dialog box.
Clicking the drop down arrow to the right of the Validate icon will display ‘Validate Brex’ and
‘Clear Errors’ selections:
Clicking the Validate BREX option will
Clicking the Clear Errors option will
1.6.1.2 Save Icon
Clicking the Save Icon will save the changes to the database.
1.6.1.3 Undo Icon
Clicking the Undo Icon will undo changes made.
Page 29
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-17
1.6.1.4 Redo Icon
Clicking the Redo Icon will return all changes after Undo has been activated.
1.6.1.5 Cut, Copy and Paste Icon’s
This is self explanatory. Basic cut, copy and paste operation.
1.6.1.6 Insert Entity Icon
Clicking this Icon will result in the Insert Entity window being displayed. This will allow for
selection of entities for insertion where allowed.
1.6.1.7 Insert External Reference Icon
Clicking this Icon will result in the Insert Reference window being displayed. This will allow for
selection of DM’s (WP’s) for insertion where allowed.
1.6.1.8 Insert Internal Reference Icon
Clicking the Icon will result in the Insert Internal Reference window being displayed. This will
allow for selection of internal objects such as Figures or Paragraphs for reference.
Page 30
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-18
1.6.1.9 Insert LSA XREF Icon
Clicking this Icon will result in the Insert LSA XREF window being displayed. This will allow for
the selection of Tools (CG) and/or Parts (CI) for insertion where allowed.
1.6.1.10 Insert Comment Icon
Clicking this Icon will allow for the insertion of general comments. Clicking the drop down arrow
to the right of the icon will allow for the selection of specific types of comments for insertion.
1.6.1.11 Toggle Preview Icon
Clicking this Icon will result in the PDF Preview window to toggle on and off. This presents you
with a snapshot of the PDF output prior to full PDF display.
1.6.1.12 Spell Checker Icon
Clicking on this Icon will result in the Spell checker window being displayed. This window will
allow for finding the miss-spellings as well as displaying suggested spellings.
Clicking the drop down arrow to the right of the Icon will display the Auto Spell Checker on-off
checkbox.
Page 31
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-19
1.6.2 Toolbar Menus
1.6.2.1 File
Figure 17. Main Toolbar>>File
Save [Ctrl+S] - Saves the file back to the database.
Export - Will allow you to save the xml to a file as xml.
Exit - Closes the editor.
Figure 18. Edit Menu
Page 32
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-20
1.6.2.2 Edit
Undo - Undo the last action.
Redo - Redo the last action.
Cut - Cut the selection.
Copy - Copy the selection.
Paste - Paste the selection.
Select All - Select all of the content.
Find - Open the Find and Replace dialogue window at the Find tab.
Replace - Open the Find and Replace dialogue window at the Replace tab.
Preferences - Open the Preferences window, allowing for Editor text settings, layout and
validation settings.
Figure 19. View Menu
1.6.2.3 View
Character Entities - Toggle Character Entities pane in Editor window.
Tags - Toggle Tags pane in Editor window.
Attributes - Toggle Attributes pane in Editor window
Preview - Toggle Preview PDF window.
Validation Results - Toggle Validation Results window.
Rename tags –
Rename attributes -
Document Properties - Displays details about the document in a document Properties window.
Page 33
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-21
1.6.2.4 Insert
Entity - This will result in the Insert Entity window being displayed. This will allow for selection
of entities for insertion where allowed.
Replace a Figure – Becomes active when the Figure to be replaced is selected in the XML. This
will activate the Insert Entity window for selection of an Entity.
I
Figure 20. Insert Menu
Reference - Opens the Insert Reference window. This will allow for selection of DM’s (WP’s) for
insertion where allowed.
LSA XREF - Opens the Insert LSA XREF window, which allows for the selection of Tools (CG)
and/or Parts (CI) for insertion where allowed.
Internal Reference - Opens the Insert Internal Reference window. This will allow for selection of
internal objects such as Figures or Paragraphs for reference.
Applicability Reference -
Table - Allows for creating a new table, editing of a table and pasting from spreadsheet.
Comment - Creates XML comment tags ‘<!-- -->’.
Character Data (CDATA) - <![CDATA[ ]]> tags inserted.
Page 34
EAGLE XML Editor User Guide SECTION 1 INTRODUCTION
1-22
Figure 21. Tools Menu
1.6.2.5 Tools
Spell Checker - Opens the Spell Checker window. This window will allow for finding the miss-
spellings as well as displaying suggested spellings.
Doctype Manager - Opens the Doctype Manager window
1.6.2.6 Help
Help – This will invoke the EAGLE XML Editor User Guide.
Describe Tag: - With a Reference DM selected in the XML, clicking on Describe Tag will invoke
the Referenced DM Details window. With a Figure Tag selected in the XML
clicking on Describe Tag will invoke the Artwork Details window.
Figure 22. Help Menu
Page 35
EAGLE XML Editor User Guide Version 12
SECTION 2
BASIC EDITING
Page 37
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-3
SECTION 2 BASIC EDITING
2.1 INTRODUCTION
This section provides an overview of the EAGLE XML EDITOR basic editing process. This
section will outline the process of opening a data module/work package for edit, adding new
content and saving the data to the EAGLE Common Source Database
2.2 OPENING A DATA MODULE FOR EDIT
From the EPS Main screen data grid, right-click on a data module that has STATUS
checked out ( )
As assigned author, choose Author DM>>Edit/Review XML
Or alternatively double click the data module if EAGLE XML Editor is set as the
default editor
Figure 23. Opening a Data Module for Edit with EAGLE XML Editor
2.3 OPENING A PROCEDURAL DATA MODULE LINKED TO THE LSAR FOR
EDIT
From the EPS Main screen data grid make sure the desired DM/WP is checked out
Click on the procedural DM/WP to be opened for edit
You may verify that the DM/WP is linked to the LSAR by clicking the Task
Information/Subtasks buttons displayed at the bottom of the data grid
Page 38
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-4
Figure 24. Opening a Data Module Linked to the LSAR for Edit
Right-click the DM and choose Author DM>>Edit/Review XML or alternatively
double click the data module if EAGLE XML Editor is set as the default editor
Figure 25. XML Editor: Linked to Task Message
Click to Edit the Subtask narrative. This will ensure the EAGLE
LSAR narrative and the DM with stay in sync
Click DM if editing only the DM XML is desired, eg. If editing the ID status section
The EAGLE XML Editor opens with all of the LSAR subtasks open in the same
edit window if was chosen
Page 39
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-5
Figure 26. Multiple Subtasks Opened For Edit
On save the edit changes are saved to the appropriate LSAR subtask number. The
processing instructions are discarded on Save
Figure 27. Subtask 3 - Multiple Subtask Edit Window
Page 40
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-6
2.4 VIEWING DOCUMENT PROPERTIES
Click View >> Document Properties
Figure 28. Document Properties
2.5 ADDING CONTENT AS ELEMENTS
The Tags window displays a pick-list of allowable XML element tags for the current position in
the content as controlled by the schema. When the cursor is positioned in the content, the valid
tags list is displayed. Tags can be selected by clicking on them.
The data module will open with the default content defined by the XML template in EPS. The data
module metadata can be edited in the IDSTATUS section. New content can be added between the
<content></content> elements.
Position the cursor where the new content is required. If the open element tag is
light purple, no new elements are allowed to be inserted
Page 41
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-7
Figure 29. Position Cursor
Select the required element from the Tags window, the new tag is inserted into the
content
Figure 30. Select Element Tags
Alternately press Ctrl+Enter to open a tag insert list, typing the first characters of
the tab will filter the list, press Enter to insert the highlighted tag
Page 42
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-8
Figure 31. Insert Element Tag – Ctrl+Enter
2.6 DELETING ELEMENTS
Figure 32. Delete Tags
Highlight the tags to be deleted and click Delete or Highlight the tags right-click
and choose Cut (ctrl+x)
2.7 ADDING ELEMENTS ATTRIBUTES
Place the cursor inside the element tag before the content. The element open tag will
turn dark purple showing that attributes can be added. The allowed element
attributes appear in the Attributes window with the element name. Select the
required attribute name
If the attribute has an enumerated list, the list will appear in an attribute list. Select the required
value.
Page 43
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-9
Figure 33. Insert Element Attribute
Attributes are displayed in red font.
Figure 34. Element Attribute
Page 44
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-10
2.8 DELETING ELEMENT ATTRIBUTES
Figure 35. Deleting Element Attribute
Place the cursor over the attribute, the attribute becomes shaded and the cursor
changes to a hand – left-double-click the mouse to delete the attribute.
2.9 ADDING TABLES
2.9.1 Creating Tables with Table Editor
Tables can be created and edited manually by creating the appropriate elements for the table.
The tag structure starts with a <table> tag, it is sensible to follow this with a <title> tag. <tgroup>
defines the number of columns with an attribute cols=””.
Utilizing the EAGLE XML Editor Table Editor:
Place the cursor in an appropriate location where a<table> tag is available
Right-click and choose Table Editor>>Create Table
Figure 36. Table Editor – Create Table
Page 45
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-11
Figure 37. New Table Window – Rows and Columns
In the New table window select Rows: and Columns
Choose the button
Figure 38. Example Table
In the Table Editor, convert the top row to a header row by right-clicking in the blue
shaded cell and selecting Convert to Header Row
Choose the button in the lower right of the screen. Do not use the
Save button on the Main toolbar.
Page 46
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-12
Figure 39. Example Table Markup
2.9.2 Editing Tables with Table Editor
Locate a <table> tag and highlight all the elements of the Table by left-clicking and
sliding slightly downward
Right-click and choose Table Editor>>Edit Table. If this is not available for
selection, you may not have all elements selected (blue highlights)
Figure 40. Table Editor – Edit Table
Page 47
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-13
Note: If editing Issue 4 of ASD S1000D, the next procedure is required as table Entries must be
wrapped in <para> tags
Figure 41. Table Editor – Tags>>para
In the Table Editor window click in the first cell in the header row and right-click
and choose Tags>>para
You may also click in the cell and choose Ctrl+I
Enter a Column Name in the tags
Do the same for the other two Column headers
Figure 42. Sample Table Header Row
Page 48
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-14
Click the validate button periodically to ensure correctness
Add some Items , Inspections and Results to the table as necessary
Validate. Choose the button
Figure 43. Sample Row Entries
2.9.3 Adding a Table Title
In the EAGLE XML Editor window place the cursor in a valid location for a Title
tag
Place the cursor between the tags that were inserted
Enter a Table name
Validate. Save
2.9.4 Adding a Reference to a Table
You must give the Table an Id to reference to start.
In the EAGLE XML Editor window place the cursor after the open <table> tag
An ‘Id” attribute should be available on the right
Double-click the ‘Id’ attribute
Enter a Table Id between the quotes removing all spaces
Note: Project rules and agreements will most likely be in place dictating the Id format
Page 49
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-15
Validate
Place the cursor in a position where a <internalRef> tag is valid. Do not click on
this tag
Choose Insert>>Internal Reference
Figure 44. Insert – Internal Reference
Select the Table desired
Choose the button
Figure 45. Insert Internal Reference Window – Table Selected
Validate and Save
Page 50
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-16
Figure 46. Sample Internal Reference
2.10 INSERTING ENTITIES
In S1000D data assets used to enhance the content of data modules such as figures and multimedia
are known as Entities. Artwork, or figures and multimedia are added in the same way. A link to
the Entity is established in the data module, the entity is not actually copied into the content.
Position the cursor in the content at a valid point for a <figure> tag to be added,
<figure> will display in the Tags window. Do not click on the tag
Figure 47. Insert>>Entity
Click Insert >> Entity on the Main tool bar, the Insert Entity window opens. The
window displays all of the S1000D entities currently loaded into the EPS CSDB for
the End item. The Information Control Number (ICN), ICN Title and Type are
displayed
Page 51
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-17
Figure 48. Insert Entity Window – Training Bicycle CGM
The list of entities can be filtered by typing characters into the Type to filter results
field. The available list of entities automatically filters as the search term is entered.
The filter is not case sensitive.
Click on a row to preview the image. Preview of CGM graphics with hotspot
regions will automatically illuminate the hotspot regions
Click the button in the lower right of the window to insert
the XML <figure> tag into the content. The figure id is automatically generated.
Validate and Save
Page 52
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-18
Figure 49. Sample Figure Inserted
2.10.1 Inserting a Reference to a Figure
Position the cursor in the content at a valid point for a <internalRef> tag to be
added. In the sample shown, the cursor is placed after the word ‘bicycle’
Do not click on the tag
Figure 50. Cursor Placed for Insert
Choose Insert>>Internal Reference from the Main toolbar
Figure 51. Insert Internal Reference – Figure Selected
Select the ICN
Page 53
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-19
Click the button
Figure 52. Example Internal Reference
2.10.2 Inserting a Reference to a Hotspot in a Figure
Position the cursor in the content at a valid point for a <internalRef> tag to be added
Do not click on the tag
Choose Insert>>Internal Reference from the Main toolbar
In the Insert Internal Reference window , click on the ICN
Figure 53. Internal Reference Window – Hotspot Reference
As shown in Figure 53, click on a ‘fig_hot’. ‘Hot009’ is a reference to the hotspot
for the seat
Page 54
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-20
Click on the button
Figure 54. Example Hotspot Reference
2.11 INSERTING REFERENCES TO DATA MODULES
Links to other data modules can be inserted into the content of a data module. The S1000D
schemas use different tag structures depending on the version of S1000D.
Position the cursor in the content at a valid point for a <refdm> tag to be added,
<refdm> will display in the Tags window. Do not click on the tag
In the example shown the cursor is placed after the words ‘cable IAW’
Figure 55. Valid Reference Insertion Point IAW
Figure 56. Insert - Reference
Click Insert >> Reference on the Main tool bar, the Insert Reference window
opens
Page 55
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-21
Figure 57. Insert Reference Window – DM Selected
The window displays all of the data modules currently loaded into the EPS CSDB
for the End item. The DMCODE, TECHNAME and INFONAME are displayed.
The list of data modules can be filtered by typing characters into the Type to filter
results field. The available list of entities automatically filters as the search term is
entered. The filter is not case sensitive.
Click on a row to select the reference
Click the button to insert the XML <refdm> tag into the content
Close the Insert Reference window
Validate and Save
Figure 58. Data Module Reference Inserted
Page 56
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-22
2.12 INSERTING COMMENTS
XML comments can be inserted into the content. The writer can chose between regular comments
or insert a comment with a category of TODO, NOTE or CHANGE.
Click Insert >> Comment on the Main tool bar, an empty comment tag <!----> is
inserted into the XML. Text can be typed into the comment it shows as a lime green
font.
Click the Comment Icon dropdown and select the type of comment to be inserted,
the comment is preceded with the text TODO, NOTE or CHANGE and the
comment text is highlighted with a different color
Figure 59. Comment Icon Dropdown
Figure 60. Example Comments
2.13 INSERTING INTERNAL REFERENCES TO LSAR OBJECTS IN THE DATA
MODULES
When editing LSAR task narratives, links to support resources in the LSAR task (support
equipment, spares, consumables), can be created to link the task narrative to support recourses.
These are created with an EAGLE tag called <lsaxref>, these are resolved into the correct tag
when the data is released from the LSAR into the data module.
Page 57
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-23
Figure 61. Main Screen - Insert>>LSA XREF
Position the cursor in the content at a valid point for an <InternalLsaxref> tag to be
added. Do not click on the tag.
Click Insert >> LSA XREF on the Main tool bar
Figure 62. Insert LSA XREF Window – Tools (CG) Tab
The Insert LSA XREF window opens on the Tools (CG) tab. Clicking the Parts
(CI) tab will list the available consumables.
The Special Tools CAGECDXH, REFNUMHA and POSTTEXT are displayed as
well as SOURCE. Type into the Type to filter results field to filter the results. Click
to highlight a record.
Click the button to insert an lsaxref to the support equipment item.
Spaces may need to be inserted into the content for correct formatting.
Validate and Save
Page 58
EAGLE XML Editor User Guide SECTION 2 BASIC EDITING
2-24
Figure 63. InternalLsaRef Example
2.14 SPELL CHECKING THE CONTENT
The content can be spell checked as follows.
Click the Toggle Preview Toolbar icon or click the View >> Preview menu. Shortcut
keys [Ctrl+Shift+P]
Click the Toggle Preview Toolbar icon again to close the preview window
Page 59
EAGLE XML Editor User Guide Version 12
SECTION 3
VALIDATING
CONTENT
Page 61
EAGLE XML Editor User Guide SECTION 3 VALIDATING CONTENT
3-3
SECTION 3 VALIDATING CONTENT
3.1 INTRODUCTION
SGML and XML documents authored to DTDs and schemas can be validated against the schema
to check for structural errors. In addition S1000D provides the ability to check the data module
against the project business rules that can be defined in a data module called the Business Rules
Exchange (BREX) data module.
The EAGLE XML Editor has tools to validate the data.
3.2 VALIDATING THE DATA AGAINST THE SCHEMA
If errors are detected when the data module is opened the invalid tag is highlighted
red
Click the View >> Validation Results menu to display the Validation results
window at the bottom of the edit window
Click the Validate icon to run the validation tool. If no validation errors
are found a No validation errors message is displayed.
If validation errors are detected, an error message box points to the error in the
content. The error message can be dragged to a new location if required.
Placing the cursor over the message box also makes the message transparent
Click the Hide Error Dialogs toggle button to make all of the error messages
transparent
The error is repeated in the Validation Results window and an XML Failed To
Validate message box is displayed.
Figure 64. View >> Validation Results
Page 62
EAGLE XML Editor User Guide SECTION 3 VALIDATING CONTENT
3-4
Figure 65. View >> Validation Results
Figure 66. XML Validated
Figure 67. Invalid tag indication (shown in red)
Page 63
EAGLE XML Editor User Guide SECTION 3 VALIDATING CONTENT
3-5
Figure 68. Validation errors found
Figure 69. Hide Error Dialogs Box Clicked
Page 64
EAGLE XML Editor User Guide SECTION 3 VALIDATING CONTENT
3-6
3.3 VALIDATING THE DATA AGAINST THE BREX DATA MODULE
The EAGLE XML editor can validate the data module contents against the project BREX data
module.
If errors are detected when the data module is opened the invalid tag is highlighted
red
Click the View >> Validation Results menu to display the Validation results
window at the bottom of the edit window
Click the Validate icon down arrow and Validate BREX to
run the BREX validation tool. If no validation errors are found a No validation
errors found message is displayed
If validation errors are detected, an error message box points to the error in the
content. The error message can be dragged to a new location if required.
Placing the cursor over the message box also makes the message transparent
Click the Hide Error Dialogs toggle button to make all of the error messages
transparent
The error is repeated in the Validation Results window and an XML Failed To
Validate message box is displayed.
Figure 70. BREX Validation Errors
Page 65
EAGLE XML Editor User Guide Version 12
SECTION 4
ADVANCED
FEATURES
Page 67
EAGLE XML Editor User Guide SECTION 4 ADVANCED FEATURES
4-3
SECTION 4 ADVANCED FEATURES
4.1 INTRODUCTTION
The following section describes the EAGLE XML Editor advanced features.
4.2 FIND AND REPLACE
4.2.1 Find
Click the Edit >> Find [Ctrl+F] menu to display the Find and replace window
with the Find tab open
Type a search term into the Find What field. The drop down list shows previous
search terms
Select Entire Document or Selection (if a selection of content is selected) in the
Look In drop down list
Select the required Find Options from Match case and Match whole word
Check the Advanced Expressions check box and select from Wildcard, Regular
Expression and XPath in the list
Click Highlight All to highlight the search term in the content. The highlight color
can be selected by clicking the color box
Click Clear to remove the highlighting from the content
Figure 71. Find and Replace - Find
Page 68
EAGLE XML Editor User Guide SECTION 4 ADVANCED FEATURES
4-4
4.2.2 Replace
Click the Edit >> Replace [Ctrl+R] menu to display the Find and replace window
with the Replace tab open.
Type a search term into the Find What field. The list shows previous search terms.
Type a term into the Replace With field. The list shows previous terms.
Select Entire Document or Selection (if a selection of content is selected) in the
Look In list.
Select the required Find Options from Match case and Match whole word.
Check the Advanced Expressions check box and select from Wildcard, Regular
Expression and XPath in the list.
Click Highlight All to highlight the search term in the content. The highlight color
can be selected by clicking the color box.
Click Clear to remove the highlighting from the content.
Click Find Next to move to the next instance.
Click Replace to replace the text.
Click Replace All to replace all instances.
4.3 SPELL CHECKER
Detected spelling errors are indicated by a red wavy underline. A red line on the left side of the
edit window represents where the errors are located in the content. Clicking on a red line will
bring the error into view.
Click the Auto Spell Check icon to toggle the auto spell
check feature on and off.
Click the Tools >> Spell Checker menu (or the Spell Checker icon) to display the
Spell Checker window. The buttons on the window perform the following
functions:
o Find Next - highlight the next word.
o Change – replace the word
o Ignore – step past this error
o Ignore Always – do not stop at this word again on this run
o Add to Dictionary – Add the word to the dictionary
o Close – close the Spell Checker window
Page 69
EAGLE XML Editor User Guide SECTION 4 ADVANCED FEATURES
4-5
Figure 72. Spell Checker Errors
Figure 73. Spell Checker window
Page 70
EAGLE XML Editor User Guide SECTION 4 ADVANCED FEATURES
4-6
4.4 DOCTYPE MANAGER
The Doctype Manager tool provides the ability to examine the entity declarations, special
characters used and the data module document type declaration.
Click the Tools >> Doctype Manager menu to display the Doctype Manager
window. The tabs on the window display the following information:
o Entities - Lists the entity declarations
o Misc – Lists miscellaneous ISO entity declarations
o Declaration – Document type declaration
Figure 74. Doctype Manager Window
Page 71
EAGLE XML Editor User Guide Version 12
SECTION 5
USER
PREFERENCES
Page 73
EAGLE XML Editor User Guide SECTION 5 USER PREFERENCES
5-3
SECTION 5 USER PREFERENCES
5.1 INTRODUCTION
Users can set preferences for the appearance and functionality of the he EAGLE XML Editor. The
following section describes the settings: default settings are shown in bold.
Click the Edit >> Preferences [Ctrl+P] menu to display the Preferences window
Figure 75. Preferences>>Editor – General Window
Page 74
EAGLE XML Editor User Guide SECTION 5 USER PREFERENCES
5-4
5.2 EDITOR - GENERAL
5.2.1 Data Save/Export
FormatXmlOnSaveAndExport – True/False
Add new lines to the XML for easier viewing in standard text editors.
SaveChangesOnDocumentChange – Prompt/Yes/No
Automatically save changes when the current document changes or is closed
ShowSavedConfirmationWindow –True/False
5.2.2 Drag_Drop/Paste
AutoConvertTableRowData - Prompt/Yes/No
Convert table data copied from excel to rows/entries for CALS XML tables.
SmartEscapePastedContent – True/False
Attempt to escape pasted content—replace “ with ‘amp;’ when not already part of an
entity, ‘<’ with ‘lt;’, etc.
5.2.3 Miscellaneous
ResolveCharacterEntities - True/False
Resolve character entities (i.e. convert apos; to ‘).
5.2.4 Prompt Defaults
AlwaysUseTaskEditMode - Prompt/Yes/No
Opens all of the EAGLE LSAR subtask narratives in a single edit window. Selecting No
only opens a single subtask at a time
DontShowValidationLoadErrorMessage - Prompt/Yes/No
Page 75
EAGLE XML Editor User Guide SECTION 5 USER PREFERENCES
5-5
5.2.5 Text Settings
AttributeValueColor – Select color (Red)
CommentColor – Select color (Lime)
PlainTextColor – Select color (Black)
TagColor – Select color (Black)
TextSize – Select point size (12)
5.3 EDITOR - LAYOUT
5.3.1 Layout
DisplayGraphicsInline – True/False
Display graphics in the XML editor view.
NonBlockingTextTypeTags – para title
Lists the tags for which the text will stay together on a single line.
Figure 76. Preferences – Editor>>Layout Top Shown
Figure 77. Preferences – Editor>>Layout Bottom Shown
Page 76
EAGLE XML Editor User Guide SECTION 5 USER PREFERENCES
5-6
5.4 EDITOR - SPELLCHECKER
Auto spell check – Checked
Show errors in sidebar – Checked
Dictionary File: C:\Documents and Settings\All Users\Application
Data\EAGLE\english.txt
Learned File: C:\Documents and Settings\1066529\Application
Data\EAGLE\english.lrn
5.4.1 Added, Removed and Ignored Tabs
This allows the user to manage the learned dictionary. Words can be inserted and deleted
as required.
Figure 78. Preferences Editor - SpellChecker Window
Page 77
EAGLE XML Editor User Guide SECTION 5 USER PREFERENCES
5-7
5.5 VALIDATION
5.5.1 Misc
ShowAlertOnValidationFailure – True/False
Show an alert when the validation completes with errors.
ShowAlertOnValidationSuccess – True/False
Show an alert when the validation completes without error.
Figure 79. Preferences - Validation Window
Page 78
EAGLE XML Editor User Guide SECTION 5 USER PREFERENCES
5-8
Page 79
EAGLE XML Editor User Guide Version 12
SECTION 6
KEYBOARD
SHORTCUTS
Page 81
EAGLE XML Editor User Guide SECTION 6 KEYBOARD SHORTCUTS
6-3
SECTION 6 KEYBOARD SHORTCUTS
6.1 INTRODUCTION
Keyboard shortcuts are provided for some of the common actions.
File - Save Ctrl+S
File - Print Ctrl+P
Edit - Undo Ctrl+Z
Edit - Redo Ctrl+Y
Edit - Cut Ctrl+X
Edit - Copy Ctrl+C
Edit - Paste Ctrl+V
Edit - Find Ctrl+F
Edit - Replace Ctrl+R
Edit - Preferences Ctrl+P
View - Character Entities Ctrl+Shift+E
View - Tags Ctrl+Shift+T
View - Attributes Ctrl+Shift+A
View - Preview Ctrl+Shift+P
Edit - Rename tags Ctrl+T
Insert element tag Ctrl+Enter
Insert attribute Ctrl+Shift+Enter
Ctrl+click Wraps current selected text in clicked tag
Figure 80. Keyboard Shortcuts
Page 82
EAGLE XML Editor User Guide SECTION 6 KEYBOARD SHORTCUTS
6-4
Page 83
EAGLE XML Editor User Guide Version 12
INDEX
Page 85
EAGLE XML Editor User Guide INDEX
INDEX 3
INDEX
Attributes, 2-9
Attributes window, 1-10
Benefits of XML
writer productivity, 1-6
BREX data module, 3-6
Character Entities window, 1-11
Comments
Inserting, 2-22
data module schema, 1-6
Data Modules
Reference To, 2-20
Document Properties, 2-6
document type file, 1-4
EAGLE XML Editor
Description, 1-6
Main Toolbar, 1-15
Elements, 1-5
Entities
Inserting, 2-16
EPS Main screen
Opening a DM, 2-3
Procedural DM Linked, 2-3
Extensible Markup Language, 1-5
Figure Reference
<internalRef>, 2-18
Internal Reference
Hotspot, 2-19
LSAR
Edit the Subtask narrative, 2-4
Support Resources, 2-22
Task Narrative, 2-22
Main Toolbar
Validate Icon, 1-16
markup tags, 1-4
schemas, 1-5
Setting Default XML Editor, 1-7
structured authoring, 1-4
Table
Table Reference, 2-14
Table Editor, 2-11
Table Title, 2-14
Tables
Creating, 2-10
Toolbar Menus, 1-19
Validation Results window, 1-12
XML, 1-5
XML Content
Spell Check, 2-24
XML edit window, 1-9
XML Editor
Find and Replace, 4-3
Keyboard shortcuts, 6-3
User Interface, 1-8
User Preferences, 5-3
Validating Content, 3-3
XML element tags
Adding Content, 2-6
Page 86
EAGLE XML Editor User Guide INDEX
INDEX 4
Page 87
Technical support is provided by the EAGLE Team of Raytheon Company. Telephone support is
available Monday through Friday from 8:00 a.m. to 4:30 p.m. Mountain Standard Time. EAGLE
technical support personnel can be reached at (520) 663-6673. Training on the EAGLE product is
available.
Are you ready for EAGLE? Join Team EAGLE and find out what it’s like to soar. Give your
logistics software product the EAGLE advantage. For more information on becoming part of
Team EAGLE, contact:
Raytheon Company
Team EAGLE
(520) 663-6673
email [email protected]
Enhanced
Automated
Graphical
Logistics
Environment