How to use
Structure
The present Confluence Space named “AIXM 5.1 Coding Guidelines (A51CG)" is a collection of several grouped content pages.
Besides this Introduction page, the Space is structured according the defined scope, mainly consisting of two parts: the pages for the Mapping and the pages for the for the Coding Guidelines. The latter includes the rules and coding examples.
You will also find an AIXM 5 Model Overview part containing the overview pages for all the main topics discussed in the coding guidelines. These pages serve as a kind of short "management summary" covering the main aspects of an AIXM topic, such as airspace or route. Each overview page is an integral part of the detailed coding guidelines for a particular topic, i.e. it is copied into the detailed coding guideline page of the topic concerned.
Additionally, you will find several File lists that contain all kind of files used in the scope of these guidelines (e.g. supporting documents, additional coding examples, etc.) which can be downloaded or viewed directly in Confluence.
A dedicated page contains a summary of all the References used on the individual guideline pages.
Finally, you will find a Contacts page with some email address in case you want to send information or ask a question.
In the sidebar on the left-hand side you have also some Space Shortcuts, which are external links (e.g. to AIXM.aero) and internal links (e.g. to a List of comments).
Types of Users
There are 2 main types of users. Based on the type of the user, different access permissions are granted.
Named user (log-in is required)
- A named user has Read & Write access.
- 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).
- The content creation is workflow dependent. First a content page is in the draft status, then it should be assigned for review and finally it will be published.
Anonymous user (no log–in required)
- The anonymous user has only read access to “published” pages.
- He can review and comment on all published pages.
- In case of accessing a page that is not yet published a corresponding error message will be shown to the user.
| Note | ||
|---|---|---|
| ||
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. |
Commenting
There are 2 main way of providing comments to the content.
- Inline commenting: Just highlight a text or part of a text on a page. Click on the little icon that appears, enter your comment and save it.
- Write a comment field: In case you have a general comment relevant for the whole content of a page enter your 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, bold etc.) and for named users also some additional functions (e.g. upload of images).
You can also edit your already saved comments.
Mark-ups
In the scope of the guidelines documentation the following 4 types of mark-up are used.
| Note | ||
|---|---|---|
| ||
This mark-up is s used to create awareness for a matter of specific importance. A Note may be editorial or content related. |
| Warning | ||
|---|---|---|
| ||
| The mapping and the guideline pages may also highlight inconsistencies, discrepancies and other issues detected in PANS-AIM and/or AIXM 5.1.(1). In general, an issue will require an action to be taken, this might be to raise an issue for the AIXM CCB or to comment on the PANS-AIM draft. |
| Tip | ||
|---|---|---|
| ||
This mark-up is used to provide examples, of how data that are part of the AIP data set may be published in an AIP. The publication examples are taken from the DONLON AIP and also State AIPs. |
| Info | ||
|---|---|---|
| ||
This mark-up is used to raise open questions which the author of the content considers relevant to be discussed amongst the contributors and/or the members of the AIXM 5 Coding Focus Group. These mark-ups will be removed once the question is solved. |
Content Formatting (SBVR style)
For the AIXM elements on the confluence pages, i.e. features, attributes, values, etc. SBVR style formatting is used as defined in the document AIXM 5.1 - Business Rules - Using SBVR and Schematron
, which can be found on the aixm website http://www.aixm.aero/page/business-rules.
The main formats used are:
SBVR NounConceptRepresented 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.
Shortcuts:
SBVR NounConcept : CTRL+SHIFT+1
SBVR Verb-concept : CTRL+SHIFT+2
SBVR 'Name' : CTRL+SHIFT+3
SBVR keyword : CTRL+SHIFT+4