@gramps-connect/story 0.3.0 → 0.5.0

package/README.md

@@ -15,9 +15,10 @@ writes them and presents them with this package's player.
   Everything happens in the browser: an opened story is never uploaded.
 - **Change a story, or make one:** the Story Editor, at
   **https://dsblank.github.io/gramps-connect-stories/edit.html** (or
-  **Edit** on an open story in the viewer). Titles, dates, text, photos
-  and the order of slides; it saves a new `.story.zip`, back into the opened file
-  in Chrome and Edge. Also entirely in the browser.
+  **Edit** on an open story in the viewer). Titles, dates, text, photos,
+  places, shapes and old maps on the map, and the order of slides; it saves a new `.story.zip`, back into
+  the opened file in Chrome and Edge. Also entirely in the browser, except
+  a place search on Wikidata when you ask for one.
 - **Put a story on a web page:** the [`<gramps-connect-story>`](#on-any-web-page-gramps-connect-story)
   element.
 - **Format specification:** [`spec/1.0/README.md`](spec/1.0/README.md)
@@ -142,7 +143,7 @@ needed only by the player. With TypeScript 6 or later, add `"geojson"` to
 ## The editor: `@gramps-connect/story/editor`
 
 A React component that edits a story: the slides on the left (drag to
-reorder), the selected slide's title, date, text and photos in the middle,
+reorder), the selected slide's title, date, text, place and photos in the middle,
 and the player on the right showing it as it changes, with undo and redo
 and the format's validation as you go. Photos are added by picking,
 dropping or pasting, prepared in the browser (`optimizeImage`: resized,
@@ -174,11 +175,28 @@ Gramps' own date parser, in all of Gramps' languages. Pass
 `parseDateText` to use another. Fields the editor doesn't know are kept as
 they are, so opening and saving a story never loses anything.
 
+A place is a name and a point: click the map or drag the pin, type the
+coordinates, or pick one of the story's other places to use the very same
+one (its shape and map overlays too). **Find on Wikidata** looks the name
+up and puts the pin there; it's the only thing the editor sends anywhere,
+the name only, and only when clicked. Pass `placeSearch` to use another
+service, or `placeSearch={null}` to leave it out.
+
+**Edit map** opens the place's map full screen: draw shapes (points,
+lines, areas) or import them from a KML, GPX or GeoJSON file, and lay
+scans of old maps over it (stored at up to 2048px, PNG when they have
+transparency), moving, resizing, rotating or dragging their corners to
+line them up, with the years each one shows. The map editor itself is
+`MapEditor`, which Gramps Connect's own map overlay editor uses too; the
+plain functions behind it (map files, the shape model, overlay geometry)
+are `@gramps-connect/story/map-edit`. The editor also needs `terra-draw`
+and `terra-draw-maplibre-gl-adapter` (optional peer dependencies).
+
 The editor is built with [Mantine](https://mantine.dev) 8 (optional peer
 dependencies `@mantine/core` and `@mantine/hooks`, needed only by the
 editor): wrap it in a `MantineProvider` and load Mantine's stylesheet. The
 pieces it's made of (`SlideList`, `StoryTextField`, `DateField`,
-`PhotosField`) and its editing functions (`addSlide`, `moveSlide`,
+`PlaceField`, `PhotosField`, `MapEditor`, `PlaceMapDialog`) and its editing functions (`addSlide`, `moveSlide`,
 `updateSlide`, `addImage`, undo history, ...) are exported too.
 
 ## Writing stories from Python: `python/gramps_connect_story.py`