SceneReference

One `screenshot:` image reference of a page, parsed by one grammar.

Declared in src/libs/libhelptext/helptext/SceneReference.hpp.

Detailed description

A page asks for a scene render with an image reference:

![The cache panel](screenshot:KilnActivity?focus=cachePanel&margin=24)

The keys are these (white-label-docs §WLO-S2):

  • mode: the variation of the scene. The default is default.
  • callout: a comma-separated, ordered list of anchors. Each gets a numbered marker.
  • size: an explicit frame size, <w>x<h>.
  • dpr: the device pixel ratio of the render.
  • focus: the one anchor of a closeup. The image shows that widget and a margin around it.
  • margin: the margin of the closeup, in logical pixels. The default is 16.

The in-app help, the site export, the catalog and the lint read a reference with parse(), so that the four always agree on the grammar. A reference that breaks a rule of the grammar carries the rule in error, and the export reports it as a failed capture.

In this section