presently 0.17.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 532d867fea4dad3add38479e76432b7eabfe6769d1f45930cf6c3be61174648e
-  data.tar.gz: e197012bf34d8708eeb012205e07289a392a2263b29045a4d052239d578c961f
+  metadata.gz: 76e4ab0cea03d4eefe8864d4c81f0193615ba5bb4548d65d19fd93992408a746
+  data.tar.gz: b2315554cb96689cf429c04d3a914525cc3294f5e01bb1cc39b0cf7a475d8b6d
 SHA512:
-  metadata.gz: 5d2bbb05d71ba4939e5a4491ce039bff503fd276f7a18d2d13cfb0e21d07259d4f3748d3c7fb630ae53544afafa0807c688f95e8b2c3954870620600f72692ba
-  data.tar.gz: 5d6052ff6a37f309cefc28fd6d9fe5fb15a46fbdf08bd1981959546e398a3a5536b7fdf6377af9459fc613d2d42cdb69ac8f610f64828985afb3884a7d144c48
+  metadata.gz: 34fbbeee043bbdd4241049e639388661808245d0d3001256d979745199074c30a867ffc4782f30a728d494453fdadf723589ff3f44f44f08a2dd65b11bdb3b50
+  data.tar.gz: eb40ee8ba2bfa106b86e9641ece873ae27043e137c0fe3ae69ff714e24562b1b01d4a58de15681655e74348a4bcbec9f965c8bc6ac65166d63bf7c4378c58282

data/context/getting-started.md

@@ -79,6 +79,43 @@ Each slide has three parts:
 2. **Content** with Markdown headings that become named sections for the template.
 3. **Presenter notes** after a `---` separator in the body (optional).
 
+### Styling Slides
+
+CSS can be colocated with the slides it styles:
+
+``` text
+slides/
+├── style.css
+├── 010-introduction.md
+└── 020-scheduling/
+    ├── style.css
+    ├── 010-overview.md
+    ├── 020-queue.md
+    └── 020-queue.css
+```
+
+`slides/style.css` applies globally. A nested `style.css` applies to every slide below that directory, while a CSS file matching a Markdown filename applies only to that slide. In the example above, `020-scheduling/style.css` applies to both scheduling slides and `020-queue.css` applies only to `020-queue.md`.
+
+Presently automatically wraps nested and slide-specific stylesheets in an [`@scope`](https://developer.mozilla.org/en-US/docs/Web/CSS/@scope) rule rooted at the rendered slide. Write these files as scoped CSS fragments containing ordinary style rules and nestable grouping rules such as `@media`, `@supports`, `@container`, and `@layer`. Keep stylesheet-level rules such as `@charset`, `@import`, and `@namespace`, and globally named definitions such as `@font-face`, `@keyframes`, and `@property`, in the root `slides/style.css` or the existing `public/_static/custom.css`.
+
+Relative images and fonts remain adjacent to the stylesheet that uses them:
+
+``` css
+.architecture {
+	background-image: url("architecture.svg");
+}
+```
+
+Presently uses `protocol-media-registry` to determine asset content types. Files with unrecognized media types are not served.
+
+Relative images embedded in Markdown resolve from the Markdown file's directory, including images in included Markdown files:
+
+``` markdown
+![Architecture](architecture.svg)
+```
+
+Presently loads each discovered stylesheet once in deterministic presentation order. Directory styles are loaded from parent to child before the matching slide sidecar, so more specific styles naturally appear later in the cascade. The same stylesheets are used by the display, presenter, recorder, playback, and export interfaces.
+
 ### Running the Presentation
 
 Start the server from your presentation directory:
@@ -87,13 +124,66 @@ Start the server from your presentation directory:
 $ presently
 ```
 
-Then open two browser windows:
+Open the launcher, or go directly to one of the presentation interfaces:
 
-- `http://localhost:9292/` — the audience display.
+- `http://localhost:9292/` — the interface launcher.
+- `http://localhost:9292/display` — the audience display.
 - `http://localhost:9292/presenter` — the presenter console.
+- `http://localhost:9292/record` — the slide narration recorder.
+- `http://localhost:9292/playback` — automatic playback with recorded narration.
 
 Advancing slides in either window updates both in real-time via WebSockets.
 
+### Recording Slide Narration
+
+The recording interface is separate from the presenter console because narration is an authoring workflow: each slide can be recorded, reviewed, retaken, and explicitly saved without changing the live presentation controls.
+
+Presently records WebM/Opus audio using the browser microphone, preserving its dynamics for offline normalization. A short delayed audio pipeline excludes approximately 100 milliseconds around the mouse clicks at the beginning and end. Saved recording paths mirror their slide paths under the presentation's `audio/` directory:
+
+``` text
+slides/020-problem/010-overview.md
+audio/020-problem/010-overview.webm
+```
+
+To record narration:
+
+1. Open `http://localhost:9292/record` in a browser with WebM/Opus `MediaRecorder` support.
+2. Select the slide and press **Record**.
+3. Press **Stop**, then review the recording with the audio player.
+4. Press **Save** to replace that slide's existing narration.
+
+Navigating away before saving discards the retake and preserves the previously saved recording.
+
+To normalize completed takes to a consistent `-16 LUFS` target, install FFmpeg and run:
+
+``` shell
+bundle exec bake presently:recordings:normalize
+```
+
+Originals remain under `audio/`; normalized WebM/Opus copies are written under `audio-normalized/` using the same relative paths. The task skips outputs that are newer than their source, so it can be rerun after recording additional slides.
+
+### Playing Recorded Narration
+
+Open `http://localhost:9292/playback` after every slide has a recording. Press **Start presentation** and Presently will play each narration track, run the slide's script, preserve its transition, and advance when the narration ends. Normalized recordings are preferred, with the corresponding original recording used as a fallback.
+
+For browser automation or video capture, open:
+
+``` text
+http://localhost:9292/playback?autoplay=true&controls=false
+```
+
+The playback page sets `window.__PRESENTLY_PLAYBACK_READY` after its slides, fonts, syntax highlighting, and audio metadata are loaded. It sets `window.__PRESENTLY_PLAYBACK_FINISHED` when the final narration ends. It also dispatches `presently:playback-ready` and `presently:playback-finished` events for event-driven integrations.
+
+To export the narrated presentation directly to MP4, use a Chromium and matching ChromeDriver build that supports the experimental `Page.startScreenRecording` DevTools command:
+
+``` shell
+PRESENTLY_CHROME_PATH=/path/to/chromium \
+PRESENTLY_CHROMEDRIVER_PATH=/path/to/chromedriver \
+bundle exec bake presently:export:video output=presentation.mp4
+```
+
+The defaults are 1920×1080 at up to 30 frames per second. The exporter starts an isolated Presently server, waits for playback to become ready, records until the final narration ends, and writes Chromium's MP4 stream to the selected output path.
+
 ### Keyboard Controls
 
 - **Arrow Right / Space / Page Down** — next slide.

data/lib/presently/version.rb

@@ -5,5 +5,5 @@
 
 # @namespace
 module Presently
-	VERSION = "0.17.0"
+	VERSION = "0.17.1"
 end

data/public/_components/@socketry/syntax/Syntax/Language/ruby.js

@@ -4,11 +4,15 @@ import {Match} from '../Match.js';
 
 const language = new Language('ruby');
 
-// Ruby-style function definitions and method calls (def foo, .bar)
-// Method names can end with ? or !
+// Ruby-style function definitions and method calls (def foo, .bar).
+// Predicate and bang methods are also unambiguous without a receiver or arguments.
 const rubyStyleFunction = {
-	pattern: /(?:def\s+|\.)([a-z_][a-z0-9_]*[?!]?)/i,
-	matches: Rule.extractMatches({type: 'function'})
+	pattern:
+		/(?:def\s+|\.)([a-z_][a-z0-9_]*[?!]?)|(^|[^\w.:])([a-z_][a-z0-9_]*[?!])(?!:)/i,
+	matches: Rule.extractMatches(
+		{index: 1, type: 'function'},
+		{index: 3, type: 'function'}
+	)
 };
 
 // Emulate negative lookbehind to avoid matching ::symbol (only match :symbol not ::symbol)

data/public/_components/@socketry/syntax/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@socketry/syntax",
-	"version": "0.6.1",
+	"version": "0.6.2",
 	"description": "A modern, framework-agnostic syntax highlighter using Web Components",
 	"type": "module",
 	"main": "Syntax.js",

data/readme.md

@@ -24,8 +24,6 @@ A web-based presentation tool built with [Lively](https://github.com/socketry/li
 
 Please see the [project documentation](https://socketry.github.io/presently/) for more details.
 
-After starting Presently, open `http://localhost:9292/` to choose between the audience display, presenter console, narration recorder, and narrated playback interfaces.
-
   - [Getting Started](https://socketry.github.io/presently/guides/getting-started/index) - This guide explains how to use `presently` to create and deliver web-based presentations using Markdown slides.
 
   - [Animating Slides](https://socketry.github.io/presently/guides/animating-slides/index) - This guide explains how to animate content within slides using the slide scripting system.
@@ -67,6 +65,11 @@ The task records the presentation at 1920×1080 and 30 frames per second by defa
 
 Please see the [project releases](https://socketry.github.io/presently/releases/index) for all releases.
 
+### v0.17.1
+
+  - Add slide-scoped resource cleanup with `Slide#defer`, `Slide#signal`, and idempotent `Slide#dispose`. Existing tracked timeouts now use the same disposal lifecycle.
+  - [Web Packages](https://socketry.github.io/presently/releases/index#web-packages)
+
 ### v0.16.0
 
   - Add support for organizing slides in nested directories. Every directory and slide filename must begin with a numeric prefix, and slides are ordered by relative path.
@@ -109,19 +112,6 @@ q
 
   - Add optional `translation` section to the `default` template.
 
-### v0.7.0
-
-  - Rework build effects to use direct CSS class animation rather than `view-transition-class`. `build-fade`, `build-fly-up`, etc. are now regular `@keyframes` classes applied to the revealed element, rather than view transition pseudo-element selectors. This decouples in-slide sequential animation from slide-level morph transitions.
-  - Rename `SlideElements#build` to `SlideElements#show` for clarity — `boxes.show(0)` / `boxes.show(3)` more clearly describes the outcome from the audience's perspective.
-  - Add `SlideElements#builder(options)` — returns a `SlideBuilder` with default options (group, effect) and a cached position, so callers can use `next()` instead of tracking the step count manually.
-  - Add `SlideBuilder#show(count, overrides)` — set visibility state to an arbitrary position. Returns a `Promise` that resolves when the reveal animation completes (or immediately when no effect is given).
-  - Add `SlideBuilder#next(overrides)` — reveal the next element with the builder's default effect, optionally overridden per call. O(1): only touches the single newly revealed element. Returns a `Promise`.
-  - Add `SlideBuilder#play(interval, callback)` — reveals all remaining elements in sequence with `interval` milliseconds between each. An optional callback is invoked after each reveal; return `false` to stop playback early. Requires the builder to be created via `slide.find(...).builder()` so timeouts are tracked and cancelled on slide change.
-  - Add `SlideBuilder#finished` getter — returns `true` when all elements have been revealed.
-  - Add `Slide#after(delay, callback)` — schedules a callback after a delay in milliseconds and returns a `SlideChain`. Subsequent `.after(delay, callback)` calls on the chain fire relative to the previous step, making sequential reveal timing easy to read and adjust.
-  - Add `Slide#setTimeout(callback, delay)` — a tracked replacement for the global `setTimeout`. All timeouts registered this way are automatically cancelled when the slide changes, preventing stale callbacks from firing after navigation. The global `setTimeout` in slide scripts is shadowed by this method automatically.
-  - Add `Slide#cancelTimeouts()` — cancels all pending timeouts registered by the slide's script. Called automatically by the presentation engine on every slide change.
-
 ## See Also
 
   - [lively](https://github.com/socketry/lively) — The real-time application framework that powers Presently.

data/releases.md

@@ -1,6 +1,6 @@
 # Releases
 
-## Unreleased
+## v0.17.1
 
   - Add slide-scoped resource cleanup with `Slide#defer`, `Slide#signal`, and idempotent `Slide#dispose`. Existing tracked timeouts now use the same disposal lifecycle.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: presently
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.17.1
 platform: ruby
 authors:
 - Samuel Williams