beffroi-tools/docs/user-guide.md

108 lines
5.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# PPTX Reporter user guide
The desktop app turns PowerPoint videos and video folders into timing reports. The
Windows GUI has been confirmed working by the project owner. Screenshots below
show the compact interface running on Linux with a sample video folder; window
borders, file dialogs and path separators differ on Windows.
## 1. Open a presentation
On Windows, extract the **whole portable ZIP** and launch
`pptx-reporter-gui.exe`. Keep `ffprobe.exe` beside it. No Python, PowerPoint or
Typst installation is needed.
On **Setup**, drop PPTX files or a folder anywhere in the window, or use
**PPTX files…** / **Folder…**. **Recent…** reopens a previous input; **Enter a
path** lets you type a path. The input list uses natural filename order, so
`media2` comes before `media10`. Long lists scroll within their own area.
The default window is 760 × 560. **Setup** and **Results** stay at the top;
the action button, progress and Cancel stay at the bottom. At smaller sizes or
with enlarged text, the active pane can scroll without hiding those controls.
![Start screen with the presentation picker and drop area](images/reporter/01-start.png)
## 2. Choose what to create
Check the selected inputs and **Save to** path. Use **Change…** for another
destination, type into the output field, or use **Use default** to reset it.
Hover a shortened filename or path to see its full value.
| Mode | Result |
| --- | --- |
| Extract + reports | Save embedded videos and generate reports |
| Reports only | Generate reports without keeping newly extracted videos |
| Extract only | Save videos without generating reports |
Ontime, PDF and Markdown checkboxes are on Setup. **More formats…** opens
all formats and presets. For easy reading, choose **Reading & printing**: it selects Web page, PDF and
Compact PDF. Add **Ontime** if you need a rundown import. **Defaults** selects
Markdown and Ontime; **All** selects every format. Individual checkboxes let
you adjust any selection.
The example below uses Reports only, with PDF, Markdown and Ontime selected.
![Selected presentation, save location and report formats](images/reporter/02-options.png)
Click the purple action button. Its label follows your mode: **Generate
reports**, **Extract videos**, or **Extract & generate reports**.
## 3. Open your results
During processing, the app shows the current step and progress where measurable.
Time estimates apply to that phase. **Cancel** stops between steps and interrupts
FFprobe; an active PDF compilation finishes before stopping.
After successful completion, the app switches to **Results**. Click **Open**
beside a report or **Open output folder**. **Copy path** copies a file's location,
not its contents. Results scroll independently of the bottom action bar.
**Activity & diagnostics** contains warnings and detailed progress messages.
You can switch tabs during a run; input and format controls stay disabled until
it finishes. Errors remain visible in the bottom bar.
![Completed run with report files and Open actions](images/reporter/03-results.png)
The default output is beside your presentation:
```text
Showcase_videos/
├── reports/ timing reports and editable Typst sources
└── videos/ extracted media, when requested
```
The `.typ` files are editable PDF sources; open `.pdf` for normal reading.
Existing reports are regenerated. Existing videos are reused unless **Settings
→ Replace existing extracted or copied videos** is enabled. The source PPTX is preserved.
A presentation with no embedded videos produces no new reports. **Settings**
also contains the FFprobe location override.
## 4. Read the timings
Reports follow slide order. Durations account for PowerPoint start/end trims;
trim details appear under the media name. A **Looping** marker identifies a
video without a usable finite playback duration. Loops and unsupported timing
are excluded from playback totals and Ontime. Extracted videos remain untrimmed.
Compact PDF keeps the slide, media name and duration in a portrait layout.
Here is the top of the sample report:
![Compact PDF preview showing a trimmed video and a looping video](images/reporter/04-compact-report.png)
To use the rundown, import `timings.ontime.json` into **Ontime 4** via
**Editor → Project → Manage projects**. This is different from `timings.json`,
which contains general report metadata. See [Ontime details](pptx-videos.md#ontime-import)
for skipped events and choosing your show start time.
## If something needs attention
- **FFprobe cannot be found:** keep the bundled executable beside the app, or
select it under **Settings → FFprobe → Locate…**.
- **Generate is disabled:** choose a presentation and at least one report format,
or select Extract only.
- **A warning or failure appears:** expand **Activity & diagnostics** for details.
- **A report will not open:** use Open output folder and open it with an installed
PDF reader or browser. Ontime JSON needs to be imported into Ontime.
For CLI options and exact playback semantics, see [Reporter](rust-reporter.md)
and [Report options](pptx-videos.md).