diff --git a/README.md b/README.md index b4d0d79..3694ac0 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@
A presenter for LATEX Beamer and PDF slides:
- private notes, audience screen, live LaTeX editor, rehearsal analytics, animation and video.
+ private notes, a teleprompter, audience screen, live LaTeX editor, rehearsal analytics, animation and video.
macOS, Windows and Linux.
-
-
+
+ 
+ The script scrolls by itself, the slide follows it, and Dark switches to light text on a dark background.
+
@@ -413,141 +486,6 @@ ls frames | wc -l # number of frames
-### Accessibility
-
-The full guide, with every kind of content and what it becomes in the tagged PDF:
-[Accessible.md](Accessible.md).
-Step-by-step recipes for adding tags and making an accessible PDF: [how-to.md](how-to.md).
-
-TeXora helps make presentations usable with screen readers, in three layers that each work alone, in
-any editor and engine: a **registry** of what each command needs (data), the **`accessgate`** LaTeX
-package (adds tags only where tagging is on), and **checking**.
-
-```latex
-\includegraphics[width=4cm,alt={Bar chart: sales doubled from 2024 to 2026}]{chart.pdf}
-\includeimage[width=3cm,alt={Team photo, five people}]{team.heic}
-\includevideo[width=6cm][alt={Play video: sorting demo, 40 s},caption={The list is sorted in three passes.}]{sort.mp4}
-\AccFigure{Bars growing from zero}{\animategraphics[autoplay]{10}{bars-}{1}{20}}
-```
-
-- **The WCAG checker** (the accessibility button beside Search, Analytics and Settings) checks the open PDF,
- any PDF, and its source against WCAG 2.2 and PDF/UA: what fails, what to check by hand, what passes,
- with the page or line of each issue; for Beamer slides it checks the tagged copy too, and runs veraPDF
- when installed.
-- **Tools > Check accessibility** lists what is missing (alt text, captions or transcripts, pause for
- looping media, link text, slide titles, table headers, colour contrast, link colour, language,
- title), with the line and WCAG 2.2 criterion. `TeXora --check-accessibility talk.tex [--strict]` prints the same for any editor or CI.
-- **Build tagged copy** makes `talk.acc.pdf`, a tagged copy (LuaLaTeX, PDF/UA metadata, the
- document's language), through a wrapper file, so `talk.tex` and `talk.pdf` are not changed; then it
- checks the copy's tags and alt text. It is tagged, not validated: validate it with veraPDF
- (PDF/UA-2). `TeXora --build-accessible talk.tex [--handout] [--still]` does the same.
-
-Keys, your own macros, Beamer and engines
-
-
-| Command | Accessibility keys |
-|---|---|
-| `\includegraphics`, `\includeimage` | `alt={...}`, or `artifact` / `decorative` for decoration |
-| `\includevideo` (second options) | `alt={...}` (what the link does), and `caption={...}`, `transcript={...}` or `transcriptfile=How it works, other editors, converters and safety
-
-
-**In TeXora.** Before LaTeX runs, each such picture is converted to a JPEG
-(a PNG when it has transparency, which is kept) in a `texora-images` folder beside the presentation,
-at most 2400 pixels on its longer side. LaTeX includes that copy. A copy is made again only when its
-picture changes; copies no longer used are removed.
-
-**In other LaTeX editors.** TeXora puts `texoraimage.sty` beside the presentation. Keep it and the
-`texora-images` folder with the `.tex` file (for example when uploading to Overleaf), and the document
-compiles everywhere with every picture. A picture that has not been converted yet shows as a framed
-box with its file name and a LaTeX warning, never an error. Tested with pdfLaTeX, XeLaTeX and LuaLaTeX.
-
-**Decoders.** Royalty-free formats are decoded inside TeXora, in pure Rust; nothing needs to be
-installed:
-
-| Format | Decoder |
-|---|---|
-| WebP, GIF (first frame), TIFF, BMP | the [`image`](https://crates.io/crates/image) crate |
-| JPEG XL | [`jxl-oxide`](https://crates.io/crates/jxl-oxide) |
-| AVIF | [`avif-decode`](https://crates.io/crates/avif-decode) with [`rav1d`](https://github.com/memorysafety/rav1d), the memory-safe Rust port of dav1d, built without its assembly |
-
-**HEIC/HEIF** pictures use HEVC, which is covered by active patents, so TeXora contains no decoder for
-them. It uses one already on the computer, in this order, and skips any that fails: `heif-dec` or
-`heif-convert` (libheif), `sips` (built into macOS), `magick` (ImageMagick), then the ffmpeg set in
-**Settings > Video**. The same converters stand in if a built-in decoder cannot read an unusual file.
-
-**Problems** (warnings under Problems, with the line; the slides still build): a missing picture, a file
-whose first bytes are not that format, an unsupported format, a path outside the presentation's
-folder, or no HEIC converter on the computer.
-
-**Safety.** Only files inside the presentation's folder are used, only when their first bytes really
-are that format. Converters get full paths as separate arguments, never through a shell; ImageMagick is
-told the format so it uses only that reader, and ffmpeg reads local files only.
-Updates
+How it works, other editors, converters and safety
-When a new version is published, a notice appears in the lower right corner with **See what's new**,
-**Later** and **Skip this version**, and a dot appears on the **?** button. The update box links the
-package for the current system and the release page; installing over the existing copy keeps the
-settings. **? > Check for updates** checks at any time; **Settings > Updates** turns automatic checks
-off. See [CHANGELOG.md](CHANGELOG.md) for the changes in each version.
+**In TeXora.** Before LaTeX runs, each such picture is converted to a JPEG
+(a PNG when it has transparency, which is kept) in a `texora-images` folder beside the presentation,
+at most 2400 pixels on its longer side. LaTeX includes that copy. A copy is made again only when its
+picture changes; copies no longer used are removed.
+
+**In other LaTeX editors.** TeXora puts `texoraimage.sty` beside the presentation. Keep it and the
+`texora-images` folder with the `.tex` file (for example when uploading to Overleaf), and the document
+compiles everywhere with every picture. A picture that has not been converted yet shows as a framed
+box with its file name and a LaTeX warning, never an error.
+
+**Decoders.** Royalty-free formats are decoded inside TeXora, in pure Rust; nothing needs to be
+installed:
+
+| Format | Decoder |
+|---|---|
+| WebP, GIF (first frame), TIFF, BMP | the [`image`](https://crates.io/crates/image) crate |
+| JPEG XL | [`jxl-oxide`](https://crates.io/crates/jxl-oxide) |
+| AVIF | [`avif-decode`](https://crates.io/crates/avif-decode) with [`rav1d`](https://github.com/memorysafety/rav1d), the memory-safe Rust port of dav1d, built without its assembly |
+
+**HEIC/HEIF** pictures use HEVC, which is covered by active patents, so TeXora contains no decoder for
+them. It uses one already on the computer, in this order, and skips any that fails: `heif-dec` or
+`heif-convert` (libheif), `sips` (built into macOS), `magick` (ImageMagick), then the ffmpeg set in
+**Settings > Video**. The same converters stand in if a built-in decoder cannot read an unusual file.
+
+**Problems** (warnings under Problems, with the line; the slides still build): a missing picture, a file
+whose first bytes are not that format, an unsupported format, a path outside the presentation's
+folder, or no HEIC converter on the computer.
+
+**Safety.** Only files inside the presentation's folder are used, only when their first bytes really
+are that format. Converters get full paths as separate arguments, never through a shell; ImageMagick is
+told the format so it uses only that reader, and ffmpeg reads local files only.
+
+Keys, your own macros, Beamer and engines
+
+
+| Command | Accessibility keys |
+|---|---|
+| `\includegraphics`, `\includeimage` | `alt={...}`, or `artifact` / `decorative` for decoration |
+| `\includevideo` (second options) | `alt={...}` (what the link does), and `caption={...}`, `transcript={...}` or `transcriptfile=
-| Action | Keys | Action | Keys |
-| --------------------------- | ------------------- | ----------------------- | ------------------------ |
-| Next / previous step | Right, Space / Left | Next / previous slide | Shift+Right / Shift+Left |
-| First / last slide | Home / End | Go to slide | G |
-| Audience window | F5 | Fullscreen | F11 |
-| Black / white screen | B / W | Freeze audience | F |
-| Overview | O | Split view | S |
-| Large slide | N | Back | Backspace |
-| Start or pause timer | P | Stop and reset timer | R |
-| Set talk duration | U | Bookmark slide | M |
-| Mark a question | Q | Contents | T |
-| Search | Cmd/Ctrl+F | Analytics | Y |
-| Pointer / pen / highlighter | V / D / H | Eraser / laser | X / L |
-| Zoom to area | Z | Zoom in / out / fit | + / - / 0 |
-| Undo ink / clear ink | Cmd/Ctrl+Z / C | Edit notes / save notes | E / Cmd/Ctrl+Enter |
-| LaTeX studio | Cmd/Ctrl+E | Compile LaTeX | Cmd/Ctrl+B |
-| Save source | Cmd/Ctrl+S | Check required packages | Cmd/Ctrl+K |
-| Toggle comment (studio) | Cmd/Ctrl+/ | Comment / uncomment | Cmd/Ctrl+] / Cmd/Ctrl+[ |
-| Open file | Cmd/Ctrl+O | Home | Cmd/Ctrl+L |
-| Close tab | Cmd/Ctrl+W | Settings | Cmd/Ctrl+, |
-| Cancel | Esc | | |
+| Action | Keys | Action | Keys |
+| --------------------------- | ------------------- | ---------------------------- | ------------------------ |
+| Next / previous step | Right, Space / Left | Next / previous slide | Shift+Right / Shift+Left |
+| First / last slide | Home / End | Go to slide | G |
+| Reading guide on the notes | Down / Up | Back | Backspace |
+| Teleprompter: play or pause | K | Teleprompter: faster / slower | ] / [ |
+| Audience window | F5 | Fullscreen | F11 |
+| Black / white screen | B / W | Freeze audience | F |
+| Overview | O | Split view | S |
+| Large slide | N | Cancel | Esc |
+| Start or pause timer | P | Stop and reset timer | R |
+| Set talk duration | U | Bookmark slide | M |
+| Mark a question | Q | Contents | T |
+| Search | Cmd/Ctrl+F | Analytics | Y |
+| Pointer / pen / highlighter | V / D / H | Eraser / laser | X / L |
+| Zoom to area | Z | Zoom in / out / fit | + / - / 0 |
+| Undo ink / clear ink | Cmd/Ctrl+Z / C | Edit notes / save notes | E / Cmd/Ctrl+Enter |
+| LaTeX studio | Cmd/Ctrl+E | Compile LaTeX | Cmd/Ctrl+B |
+| Save source | Cmd/Ctrl+S | Check required packages | Cmd/Ctrl+K |
+| Toggle comment (studio) | Cmd/Ctrl+/ | Comment / uncomment | Cmd/Ctrl+] / Cmd/Ctrl+[ |
+| Open file | Cmd/Ctrl+O | Home | Cmd/Ctrl+L |
+| Close tab | Cmd/Ctrl+W | Settings | Cmd/Ctrl+, |
@@ -723,7 +749,7 @@ cargo test
| Path | Content |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `src/` | The application, in Rust with [egui](https://github.com/emilk/egui) and [PDFium](https://pdfium.googlesource.com/pdfium/) |
-| `assets/` | Icon, Home picture, fonts, sample lecture, templates and the `texoravideo` LaTeX package |
+| `assets/` | Icon, Home picture, fonts, sample lecture, templates and the LaTeX packages TeXora provides |
| `scripts/` | Packaging, installer, release and icon scripts |
| `installer/` | Windows installer (Inno Setup) |
| `.github/workflows/` | Continuous tests and the release workflow |
diff --git a/screenshots/icons/teleprompter.png b/screenshots/icons/teleprompter.png
new file mode 100644
index 0000000..8a2ec1a
Binary files /dev/null and b/screenshots/icons/teleprompter.png differ
diff --git a/screenshots/teleprompter.gif b/screenshots/teleprompter.gif
new file mode 100644
index 0000000..1fd5ccd
Binary files /dev/null and b/screenshots/teleprompter.gif differ