report

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 26, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package report provides report generation for PRISM documents.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateDashboardHTML

func GenerateDashboardHTML(dashboard *prism.ExecutiveDashboard, opts *DashboardOptions) string

GenerateDashboardHTML generates a standalone HTML dashboard.

func GenerateDashboardMarkdown

func GenerateDashboardMarkdown(dashboard *prism.ExecutiveDashboard, opts *DashboardOptions) string

GenerateDashboardMarkdown generates a Pandoc-compatible Markdown dashboard.

func GenerateDashboardMarp

func GenerateDashboardMarp(dashboard *prism.ExecutiveDashboard, opts *DashboardOptions) string

GenerateDashboardMarp generates a Marp presentation dashboard.

func GenerateMarkdown

func GenerateMarkdown(doc *prism.PRISMDocument, opts *MarkdownOptions) string

GenerateMarkdown generates a Pandoc-compatible Markdown report.

Types

type DashboardOptions

type DashboardOptions struct {
	Title           string
	Author          string
	Date            string
	IncludeYAMLMeta bool   // Include YAML front matter for Pandoc
	IncludeGaps     bool   // Include gap analysis section
	MaxGaps         int    // Maximum gaps to show (0 = all)
	Theme           string // HTML theme: "light", "dark"
}

DashboardOptions configures dashboard report generation.

func DefaultDashboardOptions

func DefaultDashboardOptions() *DashboardOptions

DefaultDashboardOptions returns sensible defaults.

type MarkdownOptions

type MarkdownOptions struct {
	Title           string
	Author          string
	Date            string
	IncludeYAMLMeta bool   // Include YAML front matter for Pandoc
	ViewType        string // "both", "by-goal", "by-phase"
	IncludeDetails  bool   // Include initiative details
}

MarkdownOptions configures markdown report generation.

func DefaultMarkdownOptions

func DefaultMarkdownOptions() *MarkdownOptions

DefaultMarkdownOptions returns sensible defaults.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL