added nl2br

docs/LATA API.md → docs/Command Line Interface and API.md

@@ -4,8 +4,9 @@ LATA can be used as an external application through the lata-cli client applicat
 The client application makes direct use of the API. Both use the same parameters.
 
 When used from outside of X-Plane, as an external application, LATA has some constraints.
-1. It needs to know the home or root folder where X-Plane is installed.
-2. It does not connect to X-Plane, so it is necessary to restart LST if it is running so that it sees the newly created files.
+1. If LATA is not installed at the recommended location, it needs to know the folder where X-Plane is installed.
+2. It does not connect to X-Plane, so it is necessary to restart LST from inside X-Plane so that it takes into account the newly created files.
+3. If run from another python installation or environment, required python packages need to be installed in that environment.
 
 Client application accepts `-h` or `--help` flag to provide general help or help specific to an operation.
 
@@ -15,11 +16,12 @@ $ lata-cli -h                  
 usage: lata-cli [-h] {help,?,create,clean,lint} ...
 
 positional arguments:
-  {help,?,create,clean,lint}
+  {help,?,create,clean,lint,list}
     help (?)            help, print this help
-    create              create turnaround, taxi, or tow, or random movement
-    clean               clean airport movements or all
+    create              create turnaround, taxi, tow, or random movement
+    clean               clean all movements on an airport
     lint                lint configuration files
+    list                list possible and valid values for most elements (runways, ramps, aircraft types…)
 
 options:
   -h, --help            show this help message and exit
@@ -50,6 +52,7 @@ $ python lata-cli.py create turnaround OTHH arrival pax A35K A7 2023-10-08T00:15
 
 ```
 
+The arrival or departure flag determines which operations get carried out. The passenger or cargo flag also. (There is no catering on a cargo flight, there more ULD loaders on cargo flights, etc.)
 # Taxi
 
 ```sh
@@ -120,6 +123,8 @@ $ python lata-cli.py create random turnaround EDDM
 $ python lata-cli.py create random turnaround EDDM
 ```
 
+When no time is specified, the movement will start immediately with the taxi-in movement of the aircraft from the runway to the gate (arrival on-block). Turnaround operations will then be synchronized based on the time of arrival of the aircraft at the gate.
+
 ## Random Taxi
 
 ```sh
@@ -159,4 +164,4 @@ The linter includes a gross *object library checker* that scans X-Plane library
 $ lata-cli list EBBR
 ```
 
-will list all valid values for runways, ramps, vehicles, aircraft types with model, and turn around services.
+will list all valid values for runways,  ramps, vehicles, aircraft types with model, and turn around services.

docs/How It Works.md

@@ -1,11 +1,13 @@
 
-The Little Airport Turnaround Activity (LATA) plugin or side application generates object movement files that can be processed by the [Living Scenery Technology](https://forums.x-plane.org/index.php?/files/file/82876-living-scenery-technology/) (LST) plugin.
+The Little Airport Turnaround Activity (LATA) plugin or side application generates object movement files that can be processed by the [Living Scenery Technology](https://forums.x-plane.org/index.php?/files/file/82876-living-scenery-technology/) (LST) plugin. It is a Living Scenery Technology *generator*.
 
-All files that LATA generates are placed in a new custom scenery folder called LATA and do not interfere with other sceneries. LST will find and load them when started and generate appropriate objects and their movements. LATA manages all generated files, including their removal when no longer needed.
+All files that LATA generates are placed in a custom scenery folder called LATA and do not interfere with other sceneries. LST will find and load those files when started and generate appropriate objects and their movements. LATA manages all generated files, including their removal when no longer needed.
 
 LATA generates movement files based on user requests.
 
-[[Movements|Here]] are the movements of vehicles that can be generated by LATA.
+There are two methods to generate that activity. In X-Plane, [[User Interface|the LATA plugin interface]] allows for creation of one or more random turnarounds and vehicle moments, to quickly generate activity on the ground of the airport and around you. It is the simplest way to generate random activity.
+
+LATA also has a [[Command Line Interface and API|client application]] that allows for creation of precise, scheduled and coordinated movements. In this case, it is necessary to supply information such as [[Movements|movement type]], ramp positions to use, and timing.
 
 
 

docs/Installation.md

@@ -1,10 +1,12 @@
 
 ## Installation Requirements
 
-LATA is an application written in the python language. It will require a working copy of a recent python interpreter.
+LATA is an application and plugin written in the python language. It requires the XPPython3 X-Plane plugin.
 
 ## LATA Software Installation
 
+LATA is a Custom Scenery and needs to be installed as such.
+
 Download the latest version of LATA from [GitHub](https://github.com/devleaks/lata). 
 
 Decompress the archive file into X-Plane Custom Scenery folder.
@@ -79,11 +81,11 @@ $ python lata-cli.py create turnaround LFBO arrival pax A321 F12 "2023-10-08T00:
 )
 ```
 
-LATA creates files for LST in the X-Plane 12/Custom Scenery/LATA folder.
+LATA creates files for LST in the `X-Plane/Custom Scenery/lata` folder.
 
 ```sh
 
-$ ls X-Plane/Custom Scenery/Lata
+$ ls X-Plane/Custom Scenery/lata
 library
 LICENSE
 LST_LFBO_TAR_ARR_F12_A321_2310080015

docs/Movements.md

@@ -1,10 +1,9 @@
 The following movements can be created with LATA.
+
 - Taxi from ramp to runway or runway to ramp
 - Tow from one ramp to another
-- Trip from parking to destination
-- Turnaround which is in fact a collection of one or more individual Services.
-
-A Service is a movement of a ground support equipment that provides a service to an aircraft.
+- Trip of a ground support vehicle from parking to destination
+- Turnaround, which is a collection of one or more individual Services. A Service is a movement of a ground support equipment that provides a service to an aircraft. That vehicle will spawn at a parking position, service the aircraft at its ramp, and then head to a destination position where it will vanish.
 
 ![[movements.png]]
 # Taxi
@@ -60,9 +59,7 @@ A service support vehicle always travels from a X-Plane *parking* position, and
 
 Taxi, tow, or turnarounds are scheduled according to aircraft arrival at gate (on-block time), or departure from gate (off-block time).
 
-A condition of success for scheduling is that the event being planned must occur in the future time, relative to the simulator time. (Please recall that the simulator time is not necessarily the current real life time.)
-
-If the event, for example a turnaround refueling, is scheduled to occur in the past, in respect of the local time, it is not created.
+A condition of success for scheduling is that the event being planned must occur in the future time, relative to the simulator time. (Please recall that the simulator time is not necessarily the current real life time.) If the event, for example a turnaround refueling, is scheduled to occur in the past, in respect of the local time, it is not created.
 
 It is possible to either explicitly specify a movement time by supplying the aircraft on block or off block time, or to start the movement(s) immediately. In the later case, LATA will determine the on block or off block time based on the desired movements, the first vehicle that needs moving will start immediately creating some *activity*.
 

docs/Parameters and Options.md

@@ -4,9 +4,11 @@
 ## XPLANE_BASE
 Home directory of X-Plane.
 
-LATA uses the folder to find miscellaneous X-Plane files like airport definitions and objects.
+LATA uses the folder to find X-Plane files like airport definitions and objects.
 
-LATA will create a Custom Scenery called LATA and will place its generated files in that directory for LST. On restart, LST will automagically find those new files and generate traffic accordingly.
+If LATA was not installed in the X-Plane Custom Scenery folder, LATA will create a Custom Scenery called LATA and will place its generated files in that directory for LST. On restart, LST will automagically find those new files and generate traffic accordingly.
+
+> If you installed LATA in X-Plane Custom Scenery folder, there is no need to specify this parameter.
 
 # Options
 
@@ -15,6 +17,7 @@ Boolean, explicit.
 
 ## Cargo Flight Percentage
 Value between 0 and 100, to specify the ratio of passenger and cargo flights.
+When a flight is randomly generated, this parameter drives the type of the flight.
 Setting the cargo flight percentage to 25 will generate 75% passenger flights and 25% cargo flights.
 
 ## Closest Destination

docs/User Interface.md

@@ -0,0 +1,36 @@
+
+#### Little Airport Turnaround Activity
+
+##### Generate 0-9 turnarounds
+- [ ] Close to me
+- [ ] Add aircraft
+- [ ] Include aircraft taxi
+(When turnaround has ended vehicles disappear.)
+
+
+##### Generate 0-19 random traffic routes
+- [ ] Passing by ramps next to me
+- [ ] Add one random tow
+(Recall that traffic routes are run over and over again.)
+
+
+[ Start ]  [ Stop all LATA activity ]
+
+##### Advanced
+- [ ] Monitor FPS
+- [ ] 
+
+##### Status (sample texts)
+6 turnarounds (with aircrafts and taxi) and 7 routes active.
+Problem generating traffic. See XPPython.log for more information.
+No taxiway routes, cannot generate taxi.
+No service roads. Cannot generate turnaround traffic.
+No or not enough parking or destinations at this airport.
+No or not enough ramp at this airport.
+Too many turnarounds requested. Spawning 4.
+Too much traffic requested. Spawning 5 vehicles.
+All traffic stopped.
+
+S: ICAO;Tx:76/132/23gates,45tied;Sr:56/112/12park,23dest;Ac:6cl/34ac/3gsepro;Ta:8/8
+
+[ Dismiss ]

docs/index.md

@@ -1,13 +1,20 @@
 # Welcome
 
-Little Airport Turnaround Activity (LATA) is a X-Plane plugin that generates animation on the ground of an airport.
+Little Airport Turnaround Activity (LATA) is a X-Plane scenery plugin that generates animation on the ground of an airport. Any airport.
 
 The original goal is to generate turnaround activity around an aircraft, with the coordinated movement of ground support vehicles around the aircraft in timely fashion.
 
 However, the flexibility of the plugin allow for a lot more generation of activity around the airport. It can generate activity around your aircraft, or any other aircraft at the airport. It can even animate aircrafts like any other model.
 
 The plugin generates activity based on instructions it receives. It does not coordinates activities or even ground movements. It does not control ground traffic. Generated traffic may happily collide if instructed to do so.
 
-This plug in only generate activity on the *ground of an airport*, on the taxiways and service roads of that airport. It does not generate activity in the surroundings, roads, highways or even water.
+This plug in only generate activity on the *ground of an airport*, on the taxiways and service roads of that airport. It does not generate activity in the surroundings, roads, highways or even water. LATA will not work if the airport does not have service roads.
 
 [[How It Works|Here]] is a little explanation of how it works.
+
+
+
+> [!NOTE] Title
+> Are call out converted with Dracula
+
+Are call out converted with Dracula

docs/resources/Configuration Files.md

@@ -20,4 +20,9 @@ The type of vehicle specified in the Service must match a vehicle type in the gr
 
 ## Service Position
 
-A Service `precise-position` must match the name of a position in the GSE profile. If a precise-position cannot be found, another position for the service is used. If no position can be found, the center of the ramp is used.
+A Service `precise-position` must match the name of a position in the GSE profile. If a precise-position cannot be found, another position for the service is used. If no position can be found, the center of the ramp is used.
+
+# Profile Fallback
+
+For a given aircraft performing a turnaround, there is a sophisticate mechanism to find a suitable profile.
+LATA first tries to find a profile for the exact airplane. If none is found it tries to find a profile for an aircraft of the same class. Then for a generic narrow or wide body aircraft, and finally fall back on a large narrow body aircraft (class `C`) which is the default value if none is found.

mkdocs.yml

@@ -24,6 +24,7 @@ theme:
 
 # Extensions
 markdown_extensions:
+  - nl2br
   - footnotes
   # - attr_list
   - pymdownx.arithmatex: