Task: Capture screenshots for the Currency Pairs manual chapter

Table of Contents

This page documents a task in the Currency pair support in reference data story. It captures the goal, current status, acceptance, and any notes or results.

Goal

Document currency pairs and conventions in the user manual shipped five [SCREENSHOT NEEDED] placeholders in chapter_5b_currency_pairs.org, each a TODO_*.png link under assets/images/. This task is the execution checklist for capturing the real screenshots, replacing the placeholder links, and removing the [SCREENSHOT NEEDED] markers — the same close-out pattern used by Generate all missing screenshots for the manual.

Status

Field Value
State DONE
Parent story Currency pair support in reference data
Now Complete — all five screenshots captured, wired, and the manual rebuilt.
Waiting on Nothing.
Next None.
Last touched 2026-07-10

Acceptance

  • All five placeholders below are captured, named per the <area>_<description>.png convention, and committed under assets/images/.
  • Each TODO_*.png link in chapter_5b_currency_pairs.org is replaced with the real filename and its [SCREENSHOT NEEDED] caption/comment pair removed.
  • Manual PDF (./compass.sh build --direct manual) rebuilds cleanly with the new figures present, and is committed alongside the chapter.

Plan

Environment setup

  1. Ready up the environment (devops-run-environment skill), default Barclays Plc (GLEIF) provisioner — this seeds a realistic spread of currency pairs and conventions, including at least one JPY cross.
  2. Confirm the Barclays seed includes both a major (e.g. EUR/USD) and a JPY cross (e.g. USD/JPY or EUR/JPY) among the currency pairs, and that both have convention records — needed for the Conventions-window screenshot's decimal-places contrast. If not present, create them by hand via the Currency Pairs / Currency Pair Conventions detail dialogs before capturing.
  3. Start the Qt client (devops-run-client skill) and log in as tenant_admin@barclays_plc, party BARCLAYS PLC.

Capture checklist

Work top to bottom; each item names the placeholder file, the exact # Capture: instruction already recorded in the chapter, and the final filename to save under assets/images/ (drop the TODO_ prefix, keep the rest of the name).

# Placeholder Final filename What to set up
1 TODO_currency_pairs_main_window.png currency_pairs_main_window.png Reference Data → Currency Pairs, ≥3 pairs spanning ≥2 classifications, toolbar visible.
2 TODO_currency_pair_details.png currency_pair_details.png Double-click an existing pair (e.g. EUR/USD) — edit mode, whole dialog, both flags visible.
3 TODO_currency_pair_inverted_rejection.png currency_pair_inverted_rejection.png With EUR/USD on file, create-mode dialog with Base=USD, Quote=EUR, click Save — capture the warning dialog.
4 TODO_currency_pair_conventions_main_window.png currency_pair_conventions_main_window.png Reference Data → Currency Pair Conventions (or the Conventions toolbar button), ≥2 rows incl. one JPY cross.
5 TODO_currency_pair_convention_details.png currency_pair_convention_details.png Double-click an existing convention record — edit mode, whole dialog.

Five placeholders in total (grep -c "SCREENSHOT NEEDED" chapter_5b_currency_pairs.org); re-run that check before closing this task in case the chapter changed since this checklist was written.

Wiring and verification

  1. git mv each captured PNG into assets/images/ under its final name.
  2. In chapter_5b_currency_pairs.org, replace each [[proj:assets/images/TODO_*.png]] link with the real filename, and delete the #+caption: [SCREENSHOT NEEDED] ... / # Capture: ... pair, replacing the caption with a plain #+caption[...]: ... describing the actual captured image (see the Currencies chapter for the caption style once a figure is real).
  3. Rebuild the manual: ./compass.sh build --direct manual. Confirm all five figures render and no LaTeX errors are introduced beyond the pre-existing, unrelated warnings.
  4. Commit the images and the updated chapter together; rebuild and commit the PDF.

Notes

Actual pairs used for the captures were USD/AOA (Currency Pair Details) and USD/KPW (Currency Pair Convention Details) rather than EUR/USD — both are equally illustrative of the field set and were already on file in the Barclays seed data; captions were adjusted accordingly. The Currency Pair Conventions window capture used USD/JPY (row eight) as the JPY-cross contrast rather than a freshly-created pair, also already present in the seed data.

Test Scenarios

Manual QA scenarios (scaffolded via compass add test_scenario, run through the QA Validation Runner panel) that verify this task. Link new ones here as they're created; the scenario doc itself links back via its "Verifies task" field.

Scenario State Notes
Capture screenshots for the Currency Pairs manual chapter PASSED 4/5 steps auto-captured via the Scenario Runner's own screenshot tool; step 3 (Inverted Pair rejection) had to be captured manually outside the runner since the warning dialog is modal and blocks the runner's own Pass/Screenshot buttons — see the standard_ore_message_box capture.

PRs

PR Title
   

Review

Comment summary File Decision Notes
       

Result

All five placeholders in chapter_5b_currency_pairs.org are replaced with real, cropped screenshots committed under assets/images/: currency_pairs_main_window.png, currency_pair_details.png, currency_pair_inverted_rejection.png, currency_pair_conventions_main_window.png, and currency_pair_convention_details.png. Four came from the Scenario Runner's built-in screenshot capture; the fifth (the modal Inverted Pair warning) required a manual desktop screenshot since the runner couldn't interact with its own panel while that dialog was open — captured as a follow-up backlog item rather than worked around here. Manual PDF rebuilt cleanly (./compass.sh build --direct manual); figures 9.1-9.5 confirmed present in the List of Figures.

Emacs 29.3 (Org mode 9.6.15)