Documentation
¶
Overview ¶
Package render provides interfaces and utilities for rendering DMAIC documents to various output formats including Marp slides.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
// Theme name (renderer-specific, e.g., "default", "corporate", "minimal")
Theme string
// IncludeDataPoints includes historical data point slides
IncludeDataPoints bool
// IncludeRootCauses includes root cause analysis slides
IncludeRootCauses bool
// IncludeInitiatives includes improvement initiatives slides
IncludeInitiatives bool
// ShowControlCharts shows SPC control chart visualizations
ShowControlCharts bool
// ShowCapabilityMetrics shows Six Sigma capability metrics
ShowCapabilityMetrics bool
// GroupByPhase groups metrics by DMAIC phase
GroupByPhase bool
// GroupByStatus groups metrics by status (Green/Yellow/Red)
GroupByStatus bool
// MaxDataPoints limits data points shown (0 = all)
MaxDataPoints int
// Custom CSS (for Marp/HTML renderers)
CustomCSS string
// Additional metadata (renderer-specific)
Metadata map[string]string
}
Options contains rendering options common to all renderers.
func DefaultOptions ¶
func DefaultOptions() *Options
DefaultOptions returns sensible default rendering options.
func ExecutiveOptions ¶
func ExecutiveOptions() *Options
ExecutiveOptions returns options for executive-focused slides (fewer details).
func SixSigmaOptions ¶
func SixSigmaOptions() *Options
SixSigmaOptions returns options for Six Sigma detailed analysis.
type Renderer ¶
type Renderer interface {
// Format returns the output format name (e.g., "marp").
Format() string
// FileExtension returns the file extension for this format (e.g., ".md").
FileExtension() string
// Render converts a DMAIC document to the output format.
Render(doc *dmaic.DMAICDocument, opts *Options) ([]byte, error)
}
Renderer defines the interface for output format renderers.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package marp provides a Marp markdown renderer for DMAIC documents.
|
Package marp provides a Marp markdown renderer for DMAIC documents. |
|
Package pandoc provides a Pandoc markdown renderer for DMAIC documents.
|
Package pandoc provides a Pandoc markdown renderer for DMAIC documents. |
Click to show internal directories.
Click to hide internal directories.