EFB PLN SDK Documentation issues (errors..)

Version: Current SU3

Frequency: Consistently

Severity: Low

Context: SDK Documentation MSFS2024

Bug description:

SDK_DOC: EFB PLN Docu errors and shortcomings.

EFB PLN Doc reviewed:

In general:
For clarity the XML items documentation sequence should match the sequence generated and expected, XML parsers are usually specific about the appearance of elements.

1st Screenshot is old

SU3: EFB button SAVE - goes to Load and Save, there is no LOAD button

Example mentioned:
..To get an idea of how this file is formatted, you can see an example below where we have a flight plan that:
..Terminates with the ILS 12L approach and landing at runway 12L
→ but the Code below shows 12 RIGHT

DepartureDetails
 ..or the selected arrival runway and any Standard Terminal Arrival (STAR) procedures.
 -> Does not apply to DepartureDetails (I assume..)

< TransitionFP >
.. This is a sub-element of < DepartureDetails > and
→ Missing ‘and < ArrivalDetails >’
→ Missing .. for Arrivals…

< ArrivalDetails >
.. arrival at the selected airport, such as the selected departure runway and any selected Standard Instrument Departure (SID) procedures,
→ Does not apply to ArrivalDetails (I assume..)
→ Missing < TransitionFP >

< ApproachDetails >
..is used to describe details about the departure from the selected airport, such as the selected departure runway and any selected Standard Instrument Departure (SID) procedures, or the selected arrival runway and any Standard Terminal Arrival (STAR) procedures.
→ Does not apply to ApproachDetails (I assume..)
→ Missing what is it then for…

< ApproachTypeFP >
..This is a required element when < ApproachDetails > is part of the PLN
→ As it is required - what content is expected if there is no Approach procedure but only a VisualPattern defined ?

< ATCWaypoint >
.. Element id..
→ Code Example uses Id=“PARIS_POI” what is it now ‘id’ or ‘Id’ ??
→ Missing < WorldPositon > element (is still in ICAO)

< ATCWaypontType >
→ Typo? should be ATCWaypointType

< ICAO >
..This is a required sub-element
Is it required?? how to fill it for User waypoints without ICAO naming??

< ICAORegion >
..This element is only required when the < ATCWaypontType > is set to “User”, otherwise it is optional.
→ ?? How to require it for User waypoints ?? what to fill in there?

Edited for formatting issue…

Hello and thank you for reporting this.

I created an issue in our backlog and this will be reviewed.

Regards,
Boris

1 Like