Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AnalysisFormats ¶
func AnalysisFormats() []string
AnalysisFormats returns the list of all supported output formats for analysis rendering.
func ResultFormats ¶
func ResultFormats() []string
ResultFormats returns the list of all supported output formats for result rendering.
Types ¶
type AnalysisRenderer ¶
type AnalysisRenderer interface {
// RenderAnalysis renders an analysis in a specific format.
RenderAnalysis(w io.Writer, analysis *models.Analysis) error
}
AnalysisRenderer renders a complete models.Analysis dataset to an output writer.
func NewAnalysisRendererWithFormat ¶
func NewAnalysisRendererWithFormat(format string) (AnalysisRenderer, error)
NewAnalysisRendererWithFormat creates an AnalysisRenderer for the specified format.
type BibtexRenderer ¶
type BibtexRenderer struct{}
BibtexRenderer renders results and analyses in BibTeX format.
func NewBibtexRenderer ¶
func NewBibtexRenderer() *BibtexRenderer
NewBibtexRenderer creates a new BibtexRenderer.
func (*BibtexRenderer) RenderAnalysis ¶
RenderAnalysis implements the AnalysisRenderer interface.
func (*BibtexRenderer) RenderResults ¶
RenderResults implements the ResultRenderer interface.
type FilenameRenderer ¶
type FilenameRenderer struct{}
FilenameRenderer renders analysis node filenames to an output writer.
func NewFilenameRenderer ¶
func NewFilenameRenderer() *FilenameRenderer
NewFilenameRenderer creates a new FilenameRenderer instance.
func (*FilenameRenderer) RenderAnalysis ¶
RenderAnalysis outputs the generated markdown filename for each node in the analysis.
type JSONRenderer ¶
type JSONRenderer struct {
}
JSONRenderer renders results as JSON
func NewJSONRenderer ¶
func NewJSONRenderer() *JSONRenderer
NewJSONRenderer creates a new JSONRenderer
func (*JSONRenderer) RenderAnalysis ¶
RenderAnalysis implements Renderer.
func (*JSONRenderer) RenderResults ¶
RenderResults implements the Renderer interface
type MarkdownRenderer ¶
type MarkdownRenderer struct {
// contains filtered or unexported fields
}
MarkdownRenderer renders works and analysis results using embedded markdown templates.
func NewMarkdownRenderer ¶
func NewMarkdownRenderer(format string) (*MarkdownRenderer, error)
NewMarkdownRenderer creates a new MarkdownRenderer with the specified template format.
func (*MarkdownRenderer) Render ¶
Render executes the template corresponding to format on the provided item and writes the output to w.
func (*MarkdownRenderer) RenderAnalysis ¶
RenderAnalysis implements Renderer.
func (*MarkdownRenderer) RenderResults ¶
RenderResults implements the Renderer interface
type Renderer ¶
type Renderer interface {
ResultRenderer
AnalysisRenderer
}
Renderer combines ResultRenderer and AnalysisRenderer interfaces.
type ResultRenderer ¶
type ResultRenderer interface {
// RenderResults renders the graph in a specific format.
RenderResults(w io.Writer, result []*models.Result) error
}
ResultRenderer renders a list of scored query results to an output writer.
func NewResultRendererWithFormat ¶
func NewResultRendererWithFormat(format string) (ResultRenderer, error)
NewResultRendererWithFormat creates a ResultRenderer for the specified format.
Source Files