Chapter 7. How to Create an eAIP

eAIP Description Document

Production

During preparation of an eAIP, the AIS office shall be responsible for maintaining the eAIP description document. This is an XML document containing all the information needed to automatically publish an eAIP. It is used by several eAIP tools transformations to generate the eAIP navigation interface in HTML.

This document may be edited directly using a text editor or with an XML editor. It may also be generated by dedicated eAIP management software.

Location

The eAIP description document shall be located in the directory of the eAIP it describes, and it shall be named eAIS-package.xml.

If the eAIP includes the XML files, the description document shall be published as well, in the directory of the eAIP. Otherwise, it shall not be provided.

Validation

The eAIP description document shall be valid (in the XML sense) against the eAIP DTD. A summary of this DTD is provided for reference in the next section.

Document Structure

An eAIP shall be described using the following XML elements:

eAIS-package

This is the root element, containing Description, eAIP-package, eSUPs and eAICs elements. It shall have the following attributes:

ICAO-country-code

The ICAO country code of the publishing country.

State

The full name of the State concerned by the eAIP.

Effective-date

The effective date of the information contained in the eAIP. In general, a single effective date applies for any information contained. Exceptionally, it is possible that one or more documents included in the eAIP have a later effective date. For example, an eAIP SUP may have an effective date which is different from the AIRAC cycle date of the eAIP in which it is included.

Publication-date

The date on which the eAIP is published.

Package-name

The eAIP name, normally used to name the eAIP's base directory. This name shall be unique for any eAIP published for a given ICAO-country-code, in a given series.[2]This name shall normally be composed of the effective date in the form year-month-day. For AIRAC eAIPs, the suffix -AIRAC shall be added.

Publishing-organisation

The name of the organisation responsible for editing or publication.

Description

Each Description element shall contain textual information about the eAIP, in one language, in HTML format. This information shall be presented on the eAIP cover page.

eAIP-package

This element shall indicate which eAIP contains the relevant eAIP Amendment. An eAIP which does not contain an Amendment itself shall refer to a previous eAIP, so that user applications may find the latest relevant Amendment. If the current eAIP contains an Amendment, then it shall refer to itself. This element shall contain at least one Language-version element, which points to a specific version of the Amendment in one language.

eSUPs

This element shall contain the list of all AIP Supplements in force on the eAIP publication date. Each Supplement shall be defined in an eSUP-reference element.

eSUP-reference

This element shall indicate which eAIP contains the relevant Supplement. The reference may be to a previous eAIP or the current one. This element shall contain at least one Language-version element, which points to a specific version of the Supplement in one language.

eAICs

This element shall contain the list of all Circulars in force on the eAIP publication date. Each Circular shall be defined in an eAIC-reference element.

eAIC-reference

This element shall indicate which eAIP contains the relevant Circular. The reference may be to a previous eAIP or the current one. This element shall contain at least one Language-version element, which points to a specific version of the Circular in 1 language.

Usage

The description document is used by several XSLT stylesheets in the toolbox. It may be used to generate various HTML files:

  • eAIP table of contents;

  • eAIP list of changes;

  • List of AIP Supplements;

  • List of Circulars;

  • Cover page.

Additionally, the eAIP description document may be used to generate an EAD PAMS-compatible eAIP mapping file (packmap.xml). See appendix eAIP for EAD PAMS.

Important

These stylesheets rely on the eAIP description document being valid and complete. AIS editors shall be responsible for the management of the definition file.

Quick Start: How to Make an eAIP

Procedure for a General eAIP

  1. Create an eAIP description file (as a minimum, set the root element's attributes and the content of the eAIP-package element); save this file in the base directory of the eAIP Core Toolbox;

  2. Open a command prompt, go to the base directory of the eAIP tools and run the following MakeAIP-core command: makeaip-core all -s path\to\package\base\directory -t path\to\package\base\directory;

  3. Create a directory directly in the root of the C: drive (or any other drive), named in a similar way to the eAIP base directory (for example, 2004-10-04), copy to it the directories html and graphics from the eAIP;

    [3]

  4. Create a zip file; add to all of the contents of the directory which has just been created.

The zip file contains an eAIP with all the required HTML files.

eAIP's History

Optionally, you can add the eAIP's history to the zip file:

  1. Create or update the eAIS-packages.xml file for the eAIP's history;

  2. Again at the command prompt, run the following MakeAIP-core command: makeaip-core history -s path\to\package\parent\directory -t path\to\package\parent\directory;

  3. Copy all files (not directories) in the directory used for -s and -t to the root of the zip file.



[2] There can be several eAIP series for the same country: civil/military, distant geographical regions.

[3] The objective of this operation is to have a separate directory for the eAIP inside the zip file. This is important if more than one eAIP is to be grouped in a zip file and if the eAIPs' history is to be added.