View Categories

Snapshot Template Structure and Best Practices

1 min read

The snapshot template controls the look and structure of your generated reports. The system creates a copy of your template each time and inserts all snapshot content into the body of that document.

How the Template Works #

When a snapshot is generated, the script:

  • Copies your template
  • Adds the report title and date range
  • Inserts summary metrics
  • Inserts item tables
  • Inserts revision log entries
  • Appends charts from Dashboard or Content_Log (if available)

The script writes content sequentially into the document body. It doesn’t require placeholders or markers.

What You Can Customize #

You can safely modify:

  • Heading styles
  • Body text styles
  • Page layout
  • Margins, spacing, and fonts
  • Header or footer elements
  • Branding elements such as logos
  • Introductory or instructional text

Anything you include in the template (logos, notes, page layout choices) appears in every generated report.

What You Should Not Change #

Avoid removing all body content.
Snapshot generation expects at least one paragraph to anchor insertion. A completely empty document can break placement.

Avoid locking the entire document with editing restrictions that prevent the script from writing new content.

Best Practices #

Keep formatting consistent.
Simple, predictable typography makes reports easier to read.

Use clear structure.
Use H1 for the main title and H2/H3 for sections.

Add light branding.
A small logo or organization name helps when reports are shared outside your team.

Test after making large changes.
Run Generate Snapshot to confirm content lands where you expect.

Shopping Cart