@orbat-mapper/control-measures 0.2.0-alpha.0 → 0.2.0-alpha.2

package/README.md

@@ -1,14 +1,13 @@
 # @orbat-mapper/control-measures
 
-A TypeScript library for generating tactical control measures as GeoJSON, according to MIL-STD-2525 and APP-6 conventions.
+Generates tactical control measures as GeoJSON, following MIL-STD-2525 and
+APP-6 conventions.
 
-## Features
-
-- Framework-agnostic: outputs plain GeoJSON.
-- Type-safe: full TypeScript typings.
-- Map-friendly: works with Leaflet, MapLibre, OpenLayers, or any GeoJSON consumer.
-- Registry-driven: a single `renderControlMeasure(cm, options)` entry point, plus a metadata catalog for discovering every measure and its options.
-- Validation controls: optional `validationMode` per render.
+The output is plain GeoJSON, so it drops into Leaflet, MapLibre, OpenLayers,
+or any other consumer without a mapping dependency of its own. Everything
+goes through one entry point, `renderControlMeasure(cm, options)`, backed by
+a metadata catalog for discovering the available measures and their options,
+plus an optional `validationMode` per render for catching bad input.
 
 ## Installation
 
@@ -22,8 +21,8 @@ pnpm add @orbat-mapper/control-measures
 
 ## Quick Start
 
-The library is registry-driven. Describe a control measure as a `ControlMeasure`
-object — its `kind`, `controlPoints`, and optional `options` — then render it:
+Describe a control measure as a `ControlMeasure` object — `kind`,
+`controlPoints`, and optional `options` — then render it:
 
 ```ts
 import { renderControlMeasure, type ControlMeasure } from "@orbat-mapper/control-measures";
@@ -49,8 +48,7 @@ const render = renderControlMeasure(mainAttack, { validationMode: "warn" });
 
 ## Discovering measures and options
 
-Rather than importing per-measure generators, use the catalog to enumerate the
-available control measures and their parameters:
+Skip the per-measure imports and query the catalog instead:
 
 ```ts
 import {
@@ -82,28 +80,86 @@ useful for strict integrations and tests.
 
 ## Supported control measures
 
-| `kind` | Measure |
-| --- | --- |
-| `ambush` | Ambush |
-| `search-area` | Search Area |
-| `main-attack` | Main Attack |
-| `supporting-attack` | Supporting Attack |
-| `airborne-attack` | Airborne Attack |
-| `attack-helicopter` | Attack Helicopter |
-| `support-by-fire` | Support by Fire |
-| `attack-by-fire` | Attack by Fire |
-| `flot` | FLOT (Forward Line of Own Troops) |
-| `breach` | Breach |
-| `bypass` | Bypass |
-| `canalize` | Canalize |
-| `fortified-line` | Fortified Line |
-| `fortified-area` | Fortified Area |
-| `block` | Block |
-| `disrupt` | Disrupt |
-| `fix` | Fix |
-| `obstacle-bypass-easy` | Obstacle Bypass (Easy) |
-| `obstacle-bypass-difficult` | Obstacle Bypass (Difficult) |
-| `obstacle-bypass-impossible` | Obstacle Bypass (Impossible) |
+Grouped by APP-6/MIL-STD-2525 entity type, with each measure's 2525E symbol
+code.
+
+<!-- AUTO-GENERATED:measures-table -->
+
+### Command and Control Lines
+
+| Preview | `kind` | Measure | 2525E Value |
+| --- | --- | --- | --- |
+| <img src="media/boundary.svg" width="96" height="48" alt=""> | `boundary` | Boundary | `110100` |
+
+### Maneuver Lines
+
+| Preview | `kind` | Measure | 2525E Value |
+| --- | --- | --- | --- |
+| <img src="media/flot.svg" width="96" height="48" alt=""> | `flot` | Forward line of own troops (FLOT) | `140100` |
+| <img src="media/final-protective-fire-left.svg" width="96" height="48" alt=""> | `final-protective-fire-left` | Final Protective Fire (Left) | `140501` |
+| <img src="media/final-protective-fire-right.svg" width="96" height="48" alt=""> | `final-protective-fire-right` | Final Protective Fire (Right) | `140502` |
+| <img src="media/principal-direction-of-fire.svg" width="96" height="48" alt=""> | `principal-direction-of-fire` | Principal Direction of Fire | `140503` |
+| <img src="media/ambush.svg" width="96" height="48" alt=""> | `ambush` | Ambush | `141700` |
+
+### Maneuver Areas
+
+| Preview | `kind` | Measure | 2525E Value |
+| --- | --- | --- | --- |
+| <img src="media/fortified-area.svg" width="96" height="48" alt=""> | `fortified-area` | Fortified Area | `151000` |
+| <img src="media/battle-position.svg" width="96" height="48" alt=""> | `battle-position` | Battle Position | `151200` |
+| <img src="media/airborne-attack.svg" width="96" height="48" alt=""> | `airborne-attack` | Airborne Attack | `151401` |
+| <img src="media/attack-helicopter.svg" width="96" height="48" alt=""> | `attack-helicopter` | Attack Helicopter | `151402` |
+| <img src="media/main-attack.svg" width="96" height="48" alt=""> | `main-attack` | Main Attack | `151403` |
+| <img src="media/supporting-attack.svg" width="96" height="48" alt=""> | `supporting-attack` | Supporting Attack | `151404` |
+| <img src="media/attack-by-fire.svg" width="96" height="48" alt=""> | `attack-by-fire` | Attack by Fire | `152000` |
+| <img src="media/support-by-fire.svg" width="96" height="48" alt=""> | `support-by-fire` | Support By Fire | `152100` |
+| <img src="media/search-area.svg" width="96" height="48" alt=""> | `search-area` | Search Area | `152200` |
+
+### Protection Areas
+
+| Preview | `kind` | Measure | 2525E Value |
+| --- | --- | --- | --- |
+| <img src="media/block.svg" width="96" height="48" alt=""> | `block` | Block | `270501` |
+| <img src="media/disrupt.svg" width="96" height="48" alt=""> | `disrupt` | Disrupt | `270502` |
+| <img src="media/fix.svg" width="96" height="48" alt=""> | `fix` | Fix | `270503` |
+| <img src="media/turn.svg" width="96" height="48" alt=""> | `turn` | Turn | `270504` |
+| <img src="media/obstacle-bypass-easy.svg" width="96" height="48" alt=""> | `obstacle-bypass-easy` | Obstacle Bypass Easy | `270601` |
+| <img src="media/obstacle-bypass-difficult.svg" width="96" height="48" alt=""> | `obstacle-bypass-difficult` | Obstacle Bypass Difficult | `270602` |
+| <img src="media/obstacle-bypass-impossible.svg" width="96" height="48" alt=""> | `obstacle-bypass-impossible` | Obstacle Bypass Impossible | `270603` |
+
+### Protection Lines
+
+| Preview | `kind` | Measure | 2525E Value |
+| --- | --- | --- | --- |
+| <img src="media/antitank-ditch-under-construction.svg" width="96" height="48" alt=""> | `antitank-ditch-under-construction` | Ditch - Under Construction | `290201` |
+| <img src="media/antitank-ditch-completed.svg" width="96" height="48" alt=""> | `antitank-ditch-completed` | Ditch - Completed | `290202` |
+| <img src="media/antitank-wall.svg" width="96" height="48" alt=""> | `antitank-wall` | Antitank Wall | `290204` |
+| <img src="media/fortified-line.svg" width="96" height="48" alt=""> | `fortified-line` | Fortified Line | `290900` |
+
+### Mission Tasks
+
+| Preview | `kind` | Measure | 2525E Value |
+| --- | --- | --- | --- |
+| <img src="media/block-mission-task.svg" width="96" height="48" alt=""> | `block-mission-task` | Block | `340100` |
+| <img src="media/breach.svg" width="96" height="48" alt=""> | `breach` | Breach | `340200` |
+| <img src="media/bypass.svg" width="96" height="48" alt=""> | `bypass` | Bypass | `340300` |
+| <img src="media/canalize.svg" width="96" height="48" alt=""> | `canalize` | Canalize | `340400` |
+| <img src="media/clear.svg" width="96" height="48" alt=""> | `clear` | Clear | `340500` |
+| <img src="media/delay.svg" width="96" height="48" alt=""> | `delay` | Delay | `340800` |
+| <img src="media/isolate.svg" width="96" height="48" alt=""> | `isolate` | Isolate | `341500` |
+
+### Generic Arrows
+
+| Preview | `kind` | Measure | 2525E Value |
+| --- | --- | --- | --- |
+| <img src="media/block-arrow.svg" width="96" height="48" alt=""> | `block-arrow` | Block Arrow | `990001` |
+| <img src="media/classic-arrow.svg" width="96" height="48" alt=""> | `classic-arrow` | Classic Arrow | `990002` |
+
+<!-- /AUTO-GENERATED:measures-table -->
+
+This table and the preview SVGs are generated; run
+`pnpm --filter @orbat-mapper/control-measures generate-docs` after adding or
+changing a measure to refresh both.
 
 ## License