beffroi-tools/docs/rust-reporter.md

45 lines
2.2 KiB
Markdown

# PPTX reporter
Create video timing reports from a PowerPoint presentation using the desktop
app or CLI. Python and PowerPoint are not required for the Rust application.
For a walkthrough with screenshots, see the [user guide](user-guide.md).
```sh
cargo run --locked --bin pptx-reporter-gui
cargo run --locked --bin pptx-reporter -- presentation.pptx --timings-only --report all
cargo run --locked --bin pptx-reporter -- presentation.pptx --extract-only
```
Drop one PPTX into the window or choose a file. Check the save location, choose
extraction/report mode, select formats, then use the purple action button.
Reading & printing selects HTML, PDF and compact PDF; Defaults selects Markdown
and Ontime. Advanced contains video replacement and FFprobe location controls.
The app remembers options and the last eight presentations. Completed files
can be opened directly or their paths copied.
Progress estimates apply to the current counted phase. Cancel interrupts
FFprobe and stops between steps; an active PDF compilation finishes first.
Activity & diagnostics retains warnings and details.
## Files and dependencies
Output defaults to `<presentation>_videos/`, with `videos/` and `reports/`
subfolders. Reports are regenerated; extracted videos are reused unless
`--overwrite` is selected. Empty presentations create no output.
HTML, Markdown, plain text, JSON, Typst, PDF, compact PDF and Ontime are supported.
Durations account for per-shape trims. Loops and unsupported timing stay visible
in reports but are omitted from Ontime and playback totals. Extracted media
remains unchanged. See [report options and semantics](pptx-videos.md).
PDF compilation and fonts are embedded; no Typst installation or package
downloads are needed. FFprobe is discovered beside the app, in its `bin/`
subfolder, or on PATH. Override with `--ffprobe PATH` or Advanced in the GUI.
On Windows, extract the whole portable ZIP and launch `pptx-reporter-gui.exe`.
`pptx-reporter.exe` provides the CLI and opens the GUI when given no arguments.
Linux desktop builds need windowing/OpenGL libraries at runtime.
See [development](development.md) for source checks and [releases](releases.md)
for Cross builds, packaging and dependency provenance.