Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The purpose of this Web site is to explain the usage of the AIXM model and to enable the AIXM community to collaboratively develop guidance material in support to the AIXM implementations and to provide implementations, including information about such implementations. Three known implementations. Contributions are welcome, both as simple comments and as content proposal, as explained on the how to contribute page.

The site is organised in three high-level areas of interest are identified: data sources, coding guidelines and extensions. In order to facilitate contributions from the global AIXM community, anonymous users are allowed to provide comments on certain sections of the Web site. Registered users have the possibility to make both inline and global comments and can also contribute to the development of the site.

AIXM Data Sources

Presented as:

AIXM Coding Guidelines

Image Removed

Including:

AIXM Extensions

Will be added progressively!

How to use

Structure

AIXM concepts, AIXM applications and AIXM data sources. Editorial and text formatting conventions are explained here: editorial conventions.

Site tree

The AIXM Confluence site is organised in "Spaces", each dedicated to a specific topic or sub-topic. Each space is a collection of pages, organised as a tree. A page may have other child pages.

Commenting

There are two ways of providing comments to the content.

  • Inline commenting: highlight a text or part of a text on a page and keep the cursor over it for a second - a "comment' iconImage Removedappears. Click on it, enter your comment and save it.
  • Comment field: In case you have a general comment relevant for the whole content of a page, please enter it comment in corresponding field displayed at the bottom of each page and save it. This way of commenting allows some additional formatting (e.g. text colouring, italic, bold, etc.) and for named users also some additional functions (e.g. upload of images).

Please note that comment fields remain visible even once the comment was resolved. Therefore,the preferred commenting method is to use inline comments, which may be resolved and closed.

You can also edit your already saved comments.

Note
titleNote:

When commenting as anonymous user you may add at the beginning of the comment your name. This could help the content contributors to address the comment in the best way. Of course, you are not obliged to provide your name.

Editorial Workflow

For some pages, a workflow is implemented in order to allow for reviewing the page content before making it publicly available. First a content page is in the draft status, then it should be assigned for review and finally it will be published.

Image Removed

User categories

There are two main types of users. Based on the type of the user, different access permissions are granted.

Anonymous user (no log–in required)

  • The anonymous user has read access to “published” pages, which is most of the site content. However, some pages might be in development and therefore not yet publicly visible.
  • the anonymous user can review and comment on all published pages.

Named user (log-in is required)

  • A named user may have Read & Write access, depending on the Space/Page
  • A named user can create content (i.e. write/update content, upload images and files, etc.) and also review and comment all the content pages (i.e. draft versions and published versions).
  • Registration: the AIXM Confluence server is hosted by the European Organisation for the Safety of Air Navigation (EUROCONTROL). Log-in is possible for anyone who has an EUROCONTROL extranet account. However, this still require that the corresponding user is added in a specific group. Please use this registration page in order to request access.

Style and format aspects

Mark-up

The following four types of mark-up are used on some pages in order to draw the attention of the reader on some particular aspects:

Note
titleNote

This mark-up is s used to create awareness for a matter of specific importance. A Note may be editorial or content related.

Warning
titleIssue
Used to highlight issues such as inconsistencies detected in source documents, limitations of the AIXM model, etc. In general, an issue will require an action to be taken, such as bringing the issue to the attention of the AIXM Change Control Board, etc.
Tip
titleGood to know

This mark-up is used, for example, when providing coding examples or information about other resources that might complement the information provided on the page.

Info
titleOpen Question

This mark-up is used to mark open questions which the author of the content is not able to resolve using the input available. It is possible that some open questions remain on the site for a long time. For example, open questions concerning elements that might be candidates for inclusion in the AIP data set might remain for a long time in this status. They might be resolved when sufficient experience is accumulated and a solution emerges.

Content Formatting (SBVR style)

On some pages (such as the pages where the AIXM model elements are explained) an SBVR-style formatting is used as defined in the document AIXM 5.1 - Business Rules - Using SBVR and Schematron (see http://www.aixm.aero/page/business-rules)

Single cite
citeIDAIXM:BR:Notation

AIXM 5.1 - Business Rules - Using SBVR and Schematron, version 0.7

The main formats used are:

  • SBVR NounConcept
    Represented by AIXM UML Classes and Properties, meaning that AIXM Class Name, Role Name or Attribute Name may appear as NounConcept.
    Style: Bold, underlined and UpperCamelCase or lowerCamelCase (depending on how the noun concept appears in the UML model). If several nouns are concatenated, then they should be separated by a dot (“.”) symbol.
  • SBVR Verb-concept
    Represented by Name of an AIXM UML association.
    Style: italic
  • SBVR 'Name'
    Represents UML Instances, Slots, Enumeration literals, and their assigned Properties and CodeList values
    Style: surrounded by ‘simple quotes’
  • SBVR keyword
    are used to construct statements – the words that can be combined with other designations to form statements and definitions, see sections on Logical Operations, Quantification, Modality and Additional SBVR keywords, all these being part of the keyword concept
    Style: Usual text format

Contributors (i.e. named users) when providing content can format text according the SBVR style. Therefor dedicated text formatting styles have been created which can be selected in the edit mode from the tool bar.

Image Removed

Shortcuts:

SBVR NounConcept : CTRL+SHIFT+1

SBVR Verb-concept : CTRL+SHIFT+2

SBVR 'Name' : CTRL+SHIFT+3

SBVR keyword : CTRL+SHIFT+4

The following diagram shows the high-level structure of these spaces, with the sections that are part of the same space sharing a common background color.



draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNamespaces
simpleViewerfalse
width
diagramWidth1019
revision29

Space Shortcuts

 In case you have the sidebar expanded on the left-hand side, besides the table of content you will find also some Space Shortcuts on top. These may be external (e.g. to AIXM.aero) or internal (e.g. to other spaces such as the 'AIXM Coding Overview').