eAIP DTD Doc - Element e:Graphic-file

[previous: e:Generated] [Index] [next: e:Heliport]

Comments welcome: eaip@eurocontrol.int

e:Graphic-file

Parent elements

e:Figure, x:td, x:th

Child elements

None: this element must be empty.

Description

Defines the actual graphic file to use for a Figure. It can be used outside a Figure as well in some cases.

There are 3 ways to insert an image in an eAIP:

Graphic-file with xlink:show="embed": the image should be embedded in all presentation formats. Note that there is no guarantee that it will effectively be the case, as it depends on the rendering device capabilities. In HTML, the image is embedded provided that the browser is capable of rendering the images format. In XSL-FO, the image is embedded. In PDF, it is embedded provided that the PDF renderer supports the image format.
Graphic-file with xlink:show="replace" or "new": the image is not embedded in HTML and other on-screen presentation formats; a link to the image is presented instead. The image is embedded in XSL-FO format and derivatives (PDF, PostScript, etc.) so that the image still appears on paper, but it is embedded in a separate page, after the last page of the current section (or the current aerodrome or heliport).
Use an x:a element to create an external link: the image will (should) not be embedded in any format, including paper. On screen (including PDF), the link label will be visible and "clickable". On paper, only the link label will be visible, not even the target address.

Note about XSL-FO and derivated formats (PDF, PostScript, paper): In order to put a graphic on its own page, set xlink:show to "replace" or "new". Landscape or portrait layout is automatically selected depending on the Width attribute. If its value is greater than the "Portrait-width-px" variable (defined in fo-styles.xslt), then landscape layout is used, otherwise portrait is used. Portrait is used if no Width is provided.

Note about image scaling: Scaling only occurs if xlink:show is set to "embed" and if Width (or Height) attribute is greater than the "max-width-px" (respectively "max-height-px") variable (defined in fo-styles.xslt). Scaling respects the Width to Height ratio, which can be different from the actual graphic's proportion.

The Effective-date attribute has been removed and replaced by the use of Updated-ref attribute and "non-listed" Amendments. If a Graphic-file should have an effective date earlier than the Effective-date attribute of the eAIP element, then an Amendment of type Non-listed should be created with the effective date as needed, and the Graphic-file should have an Updated-ref attribute refering to that Amendment element.

Amendments

Example in the eAIP Specimen	see Figure
How to insert or delete the element	Use the Updated attribute.
How to change the whole element (insert and delete)	Use the Updated attribute.
How to change this element's attributes	May not be amended; change the parent element.
How to change this element's content	Not applicable.
Additional comments	Attributes: xlink:href is not free, others are free

Attributes

class Optional Type: space-separated XML name tokens
Style class selector. Any valid class name can be input here, as it depends on the set of style sheets you have developed (for HTML classes implementation, see html/eAIP.css in the eAIP Specimen). Several classes can be specified using a space as separator. Note that class names are the same for both HTML and XSL-FO.
Height Optional Type: text
Height in pixels of the zone in which the graphic will appear (note that this is not necessarily the graphic's height). If xlink:show is set to "embed", then this value can be a percentage of the available space.
id Optional Type: unique ID
Identifier for the element. This must be unique for within an eAIP, which is enforced at validation. The id value can then be used for reference from other elements, as it is the case with the Ref attribute of an e:Abbreviation.
Page-name Optional Type: text
When xlink:show is set to "replace" or "new", then Page-name must be set to the page name (or "number") in PDF/paper format. The page name is not output on the page, as it is normally part of the graphic itself, but it is used for the checklist of pages (GEN-0.4). Not used in HTML.
Remarks Optional Type: text
Any short remark related to the element. This attribute may be useful for editing purpose. It should not be used for publishing, as it is currently not used by the supplied style sheets.
title Optional Type: text
This attribute allows to provide some more information about the element. It is not always used: check with the style sheets. When it is used in HTML, elements will have their title attribute displayed as a pop-up when the mouse is left over them for a while, much like Abbreviations. It is not yet used in XSL-FO.
Type Required Type: text
Graphic file MIME type, such as "image/gif", "application/pdf" or "image/svg+xml".
Updated Optional Choice: Inserted, Deleted, No
Default: No
Amendment: Indicates if the element has been updated since the previous AIP issue and how.
"Inserted" means the whole element has been inserted;
"Deleted" means the whole element has been deleted;
if not specified, then there was no update since the previous issue.
If only parts of the element are amended, then these parts (i.e. child elements) must be marked as such, not the parent element.
When an element is changed, editors must duplicate the element and mark one copy as "Inserted" and the other as "Deleted".
Updated-ref Optional Type: ID reference
Reference to the id of an e:Amendment by which the current element is changed. This attribute is relevant only if the Updated attribute is set.
Width Optional Type: text
Width in pixels of the zone in which the graphic will appear (note that this is not necessarily the graphic's width). If xlink:show is set to "embed", then this value can be a percentage of the available space.
xlink:href Required Type: text
URL of the graphic file. Note: if you use a relative URL, take care that it must be relative to the XML, HTML and XSL-FO files at the same time.
xlink:show Optional Choice: embed, replace, new, other, none
Default: replace
Indicates how the image should be displayed in HTML (when generating XSL-FO, embed is always assumed). Here is an explanation of the possible values:
embed: the image is embedded into the page
replace: a link is created for the image; the user must follow the link to display the image
new: a new window is open for the image when the user follows the link
other and none: not implemented
xmlns:e Fixed http://www.eurocontrol.int/xmlns/AIM/eAIP
This namespace node defines the "e" namespace, which groups all eAIP specific elements. For more information, refer to the W3C's document Namespaces in XML. This node is implied: it does not need to be set explicitly (except on e:eAIP), but can be if needed.
xmlns:x Fixed http://www.w3.org/1999/xhtml
This namespace node defines the "x" namespace, which groups all XHTML elements. This node is implied: it does not need to be set explicitly (except on e:eAIP), but can be if needed.
xmlns:xlink Fixed http://www.w3.org/1999/xlink
This namespace node defines the "xlink" namespace. This node is implied: it does not need to be set explicitly (except on e:eAIP), but can be if needed.

class	Optional	Type: space-separated XML name tokens	Style class selector. Any valid class name can be input here, as it depends on the set of style sheets you have developed (for HTML classes implementation, see html/eAIP.css in the eAIP Specimen). Several classes can be specified using a space as separator. Note that class names are the same for both HTML and XSL-FO.
Height	Optional	Type: text	Height in pixels of the zone in which the graphic will appear (note that this is not necessarily the graphic's height). If xlink:show is set to "embed", then this value can be a percentage of the available space.
id	Optional	Type: unique ID	Identifier for the element. This must be unique for within an eAIP, which is enforced at validation. The id value can then be used for reference from other elements, as it is the case with the Ref attribute of an e:Abbreviation.
Page-name	Optional	Type: text	When xlink:show is set to "replace" or "new", then Page-name must be set to the page name (or "number") in PDF/paper format. The page name is not output on the page, as it is normally part of the graphic itself, but it is used for the checklist of pages (GEN-0.4). Not used in HTML.
Remarks	Optional	Type: text	Any short remark related to the element. This attribute may be useful for editing purpose. It should not be used for publishing, as it is currently not used by the supplied style sheets.
title	Optional	Type: text	This attribute allows to provide some more information about the element. It is not always used: check with the style sheets. When it is used in HTML, elements will have their title attribute displayed as a pop-up when the mouse is left over them for a while, much like Abbreviations. It is not yet used in XSL-FO.
Type	Required	Type: text	Graphic file MIME type, such as "image/gif", "application/pdf" or "image/svg+xml".
Updated	Optional	Choice: Inserted, Deleted, No Default: No	Amendment: Indicates if the element has been updated since the previous AIP issue and how. "Inserted" means the whole element has been inserted; "Deleted" means the whole element has been deleted; if not specified, then there was no update since the previous issue. If only parts of the element are amended, then these parts (i.e. child elements) must be marked as such, not the parent element. When an element is changed, editors must duplicate the element and mark one copy as "Inserted" and the other as "Deleted".
Updated-ref	Optional	Type: ID reference	Reference to the id of an e:Amendment by which the current element is changed. This attribute is relevant only if the Updated attribute is set.
Width	Optional	Type: text	Width in pixels of the zone in which the graphic will appear (note that this is not necessarily the graphic's width). If xlink:show is set to "embed", then this value can be a percentage of the available space.
xlink:href	Required	Type: text	URL of the graphic file. Note: if you use a relative URL, take care that it must be relative to the XML, HTML and XSL-FO files at the same time.
xlink:show	Optional	Choice: embed, replace, new, other, none Default: replace	Indicates how the image should be displayed in HTML (when generating XSL-FO, embed is always assumed). Here is an explanation of the possible values: embed: the image is embedded into the page replace: a link is created for the image; the user must follow the link to display the image new: a new window is open for the image when the user follows the link other and none: not implemented
xmlns:e	Fixed	http://www.eurocontrol.int/xmlns/AIM/eAIP	This namespace node defines the "e" namespace, which groups all eAIP specific elements. For more information, refer to the W3C's document Namespaces in XML. This node is implied: it does not need to be set explicitly (except on e:eAIP), but can be if needed.
xmlns:x	Fixed	http://www.w3.org/1999/xhtml	This namespace node defines the "x" namespace, which groups all XHTML elements. This node is implied: it does not need to be set explicitly (except on e:eAIP), but can be if needed.
xmlns:xlink	Fixed	http://www.w3.org/1999/xlink	This namespace node defines the "xlink" namespace. This node is implied: it does not need to be set explicitly (except on e:eAIP), but can be if needed.