Shared FGCZ Quarto report assets
Description
The package ships a common set of Quarto report assets under inst/quarto/ so that FGCZ analysis packages (ezRun, prolfqua, …) share one look and feel:
Details
-
_metadata.yml -
Shared format defaults. Quarto applies this file automatically to every
.qmdin its directory (and subdirectories) because of its reserved name – reports need no reference to it. -
fgcz.scss - Theme overrides (tabset/card styling, figure rows).
-
fgcz_header_quarto.html -
FGCZ header injected via
include-in-header. -
fgcz-plot-finder.html -
Top-right search + download + view-source toolbar. Opt-in: staged next to every report but only injected (via
include-after-body) when asked for, e.g.fgcz_render(buttons = “search”). -
fgcz-buttons.lua -
Quarto extension filter that validates and applies a report’s optional
fgcz-buttons:YAML selection. -
template.qmd -
A generic starter report demonstrating the tabset, figure-with-callout, and nesting patterns. It is copied with
fgcz-report-overview.svg, the starter’s visual abstract.
Because _metadata.yml is applied by directory, a .qmd rendered with a plain quarto render picks up the FGCZ styling with no package involved and no front-matter reference – as long as the styling files sit in the same directory. The _metadata.yml references fgcz.scss and fgcz_header_quarto.html by bare filename, which Quarto resolves relative to the input .qmd, so they must travel together; see fgcz_copy_assets() and fgcz_render(). The toolbar (fgcz-plot-finder.html) is staged too but is opt-in – enable all three buttons with fgcz_render(buttons = TRUE), or select buttons by name.