Transcript Dialogue-oriented Documentation

Graphical Hotspot Definition
A Common ATA/AECMA Approach
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Presentation at XML Europe ‘99
28 April 1999
Granada / Spain
[email protected]
28 April 1999 / Page 1
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Speakers
• David W. Cruikshank
• Associate Technical Fellow
• Co-chair ATA GWG
• Chief Technical Officer, CGM Open Consortium
• Peter Zimmermann
• Chief Advisor for IT
• Member AECMA EPWG
• Observer, CGM Open Consortium
[email protected]
28 April 1999 / Page 2
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Agenda
•
•
•
•
•
•
•
Introduction
Background
ATA and WebCGM profiles
Concepts
Examples
Potential future extensions
Conclusion
[email protected]
28 April 1999 / Page 3
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Definitions
• Graphical primitive: basic drawing element defining the
geometry
• Graphics metafile: CGM picture composed of graphical
primitives and their associated attributes
• Graphical object: addressable logical unit within a
picture (realized by CGM V4 APS)
• Graphical hotspot: graphical object participating in a
link (XLink resource)
• XML companion file: non-graphical meta-data of
graphical objects
• XLink file: linking elements and hotspot definitions
(XLink locators)
[email protected]
28 April 1999 / Page 4
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Background
• ATA GWG has been working on specifications for
intelligent graphics since 1989
• Intelligent graphics functional spec (IGFUNQREQ)
published in 1993
• Graphics exchange spec (GREXCHANGE): mainly CGM
V3 profile
• Intelligent graphics exchange spec (IGEXCHANGE):
CGM V4 profile
• Intelligent graphics structure model expressed as SGML
DTD fragment
[email protected]
28 April 1999 / Page 5
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
ATA and WebCGM profiles
• CGM Open consortium founded in 1998
• WebCGM profile developed, W3C REC since January
1999
• WebCGM profile
• based on ATA GREXCHANGE profile
• subset of ATA CGM elements
• superset of ATA linking functionality for web
addressing
• WebCGM intelligent graphics model
[email protected]
28 April 1999 / Page 6
[email protected]
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Spec 2100
SEE
ATA Realization
A
igsheet
[2] SPACERS
[1] IGNITER BOSS
[3] KEYWASHER
[2] CLASSIFIED
SPACERS
IGNITER PLUG
(AMM-74-21-02/401)
SEE
B
[3] KEY WASHER
[1] IGNITER
BOSS
locator
detail A
para
para+
detail B
para
DIMENSION A
A
refaps
refaps
refint
DIMENSION C
CLASSIFIED SPACERS
B
G-09435 (1098)
G-09574 (1098)
Igniter Plug Boss Installation
Figure 401
[email protected]
28 April 1999 / Page 7
[email protected]
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Spec 2100
SEE
WebCGM Realization
A
picbody
[2] SPACERS
[1] IGNITER BOSS
[3] KEYWASHER
[2] CLASSIFIED
SPACERS
IGNITER PLUG
(AMM-74-21-02/401)
SEE
grobject
grobject
para
para+
[3] KEY WASHER
[1] IGNITER
BOSS
grobject para
B
DIMENSION A
A
subpara
subpara
DIMENSION C
CLASSIFIED SPACERS
B
G-09435 (1098)
G-09574 (1098)
Igniter Plug Boss Installation
Figure 401
[email protected]
28 April 1999 / Page 8
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Concepts
• Requirements
• Graphics ideally shall contain only graphical information,
because
• Non-graphical information (meta-data) easier to maintain in XML
• Decoupling of data & meta-data is more flexible
• Query functions, navigation, and data analysis easier to implement
• Logical structure within graphics must be exposed for reuse of
graphical objects
• Graphical objects belonging to different graphics can
participate in one link
• A graphical object may participate in more than one link
(different behavior)
• Multidirectional links within a graphic, between graphics, and
between graphics and text shall be possible.
[email protected]
28 April 1999 / Page 9
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Concepts (contd.)
• Outline
XML
CGM
hotspot
XML
XML
Comp.
grobject
Hotspot
Definitions
Sheet 1
XML
Linking
Elements
CGM
hotspot
XML
Companion
Sheet 2
Documents
[email protected]
Figure
28 April 1999 / Page 10
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Concepts (contd.)
• Adressing Graphical Objects
• Application Structures
Content model of graphical object (conceptually expressed as an XML DTD
fragment)
<!ELEMENT grobject
(grobject | gdata)* >
<!ATTLIST
grobject
id
ID
#REQUIRED
region CDATA #IMPLIED >
<!ELEMENT gdata
EMPTY >
• XPointers
• Basic form of address chosen is a URI (Uniform Resource Identifier)
• Most important URI form today is an extended URL (Uniform Resource
Locator)
• Example for addressing a CGM file on the web:
http://www.boeing.com/cgm/atacgm4.cgm
• Example for addressing a graphical object with id “grobj01“ within this CGM
file:
http://www.boeing.com/cgm/atacgm4.xml#id(grobj01)
[email protected]
28 April 1999 / Page 11
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Concepts (contd.)
• The XML Companion File (DTD fragment)
<!ELEMENT
<!ATTLIST
<!ELEMENT
<!ATTLIST
<!ELEMENT
[email protected]
graphic
graphic
graphicid
linkURI
(grobject)* >
ENTITY
CDATA
grobject
grobject
id
type
name
descript
(gdata)* >
gdata
EMPTY >
ID
CDATA
CDATA
CDATA
28 April 1999 / Page 12
#REQUIRED
#REQUIRED >
#REQUIRED
#IMPLIED
#IMPLIED
#IMPLIED >
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Concepts (contd.)
• Graphical hotspots
<!ELEMENT
<!ATTLIST
[email protected]
hspot
hspot
xml:link
EMPTY >
CDATA
#FIXED
href
CDATA
#REQUIRED
refgraphic
role
title
show
actuate
behavior
ENTITY
#IMPLIED
CDATA
#IMPLIED
CDATA
#IMPLIED
(embed | replace | new)
(auto | user)
CDATA
#IMPLIED >
28 April 1999 / Page 13
“locator"
“new"
“user"
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Concepts (contd.)
• The Linking Element
<!ELEMENT
<!ATTLIST
[email protected]
hsplink
hsplink
xml:link
inline
role
title
show
actuate
behavior
(hspot)+ >
CDATA
#FIXED
(true | false) “false“
CDATA
#IMPLIED
CDATA
#IMPLIED
(embed | replace | new)
(auto | user)
CDATA
#IMPLIED >
28 April 1999 / Page 14
“extended“
“new"
“user"
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Bidirectional link between text and graphic - Example
• CGM filename: atacgm1.cgm
• XML companion file (atacgm1.xml)
<graphic graphicid=“GNBR01” linkURI=“atacgm1.cgm”>
<grobject id=“grobj01” name=“part1”></grobject></graphic>
• XML text file (atatext1.xml)
...<pnr id=“refpart1”>Part1</pnr> is used to...
• Xlink file (hsplink1.xml)
<hsplink role=“text-hspot” behavior=“highlight”>
<hspot href=“id(grobj01)” refgraphic=“GNBR01” title=“Part No. 1”></hspot>
<hspot href=“atatext1.xml#id(refpart1)”></hspot></hsplink>
or
<hsplink role=“text-hspot” behavior=“highlight”>
<hspot href=“atacgm1.xml#id(grobj01)” title=“Part No. 1”></hspot>
<hspot href=“atatext1.xml#id(refpart1)”></hspot></hsplink>
[email protected]
28 April 1999 / Page 15
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Bidirectional link between text and graphic - Example(contd.)
<hsplink role=“text-hspot”
behavior=“highlight”>
Part No. 1
...<pnr
id=“refpart1”>Part1</pnr>
is used to...
XML Document
(atatext1.xml)
[email protected]
<grobject id=“grobj01”
name=“part1”>
</grobject>
</graphic>
<hspot href=“id(grobj01)”
refgraphic=“GNBR01”
title=“Part No. 1”>
</hspot>
<hspot
href=“atatext1.xml#
id(refpart1)”>
</hspot>
</hsplink>
XML Link file
(hsplink1.xml)
28 April 1999 / Page 16
<graphic
graphicid=“GNBR01”
linkURI=“atacgm1.cgm”
>
CGM file
(atacgm1.cgm)
XML Companion
(atacgm1.xml)
Graphic-related info
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Bidirectional link between two graphical objects
in one graphic
• CGM filename: atacgm1.cgm
• XML companion file (atacgm1.xml)
<graphic graphicid=“GNBR01” linkURI=“atacgm1.cgm”>
<grobject id=“grobj01” name=“part1”></grobject>
<grobject id=“grobj02” name=“part2”></grobject></graphic>
• Xlink file (hsplink1.xml)
<hsplink role=“hspot-hspot” show=“embed” behavior=“highlight”>
<hspot href=“id(grobj01)” refgraphic=“GNBR01” title=“Part No. 1”>
</hspot>
<hspot href=“atacgm1.xml#id(grobj02)” title=“Part No. 2”>
</hspot></hsplink>
[email protected]
28 April 1999 / Page 17
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Multidirectional link between text and graphic
• CGM filenames: atacgm1.cgm, atacgm2.cgm
• XML companion file 1 (atacgm1.xml)
<graphic graphicid=“GNBR01” linkURI=“atacgm1.cgm”>
<grobject id=“grobj01” name=“part1”></grobject></graphic>
• XML companion file 2 (atacgm2.xml)
<graphic graphicid=“GNBR02” linkURI=“atacgm2.cgm”>
<grobject id=“grobj01” name=“part1”></grobject></graphic>
• XML text file (atatext1.xml)
...<pnr id=“refpart1”>Part1</pnr> is used to...
• Xlink file (hsplink2.xml)
<hsplink role=“text-hspots”>
<hspot href=“atacgm1.xml#id(grobj01)” title=“Part No. 1”></hspot>
<hspot href=“id(grobj01)” refgraphic=“GNBR02” title=“Part No.
1”></hspot>
<hspot href=“atatext1.xml#id(refpart1)”></hspot></hsplink>
[email protected]
28 April 1999 / Page 18
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Potential future extensions
• Investigate application/extension of the DOM
(Document Object Model)
• Free graphics from textual components
(annotations)
• Links to and from resources in other
multimedia formats such as video/audio,
animations, 3D (VRML), and even simulations.
• Establish links between authoring/illustration
system (used-on lists)
• Establish link to enterprise PDM system (usedon lists for parts)
[email protected]
28 April 1999 / Page 19
[email protected]
Spec 2100
Graphical Hotspot Definition
A Common ATA/AECMA Approach
Conclusion
• Definition of generic element ”anchor” within
text DTD’s is advised
• XML companion file only a first attempt to
integrate XML/CGM
• More detail work necessary in the areas of
• link management
• link traversal
• user interfaces
• ATA GWG will work with this concept to
enhance the ATA intelligent graphics model.
[email protected]
28 April 1999 / Page 20
[email protected]