docx

Documentation

Index

• type Config
  • func (config *Config) BuildDocx() error
• type OpenControlDocx
  • func (openControl *OpenControlDocx) FormatAllNarratives(standardKey string, controlKey string) string
  • func (openControl *OpenControlDocx) FormatNarrative(standardKey string, controlKey string, sectionKeys ...string) string
  • func (openControl *OpenControlDocx) FormatParameter(standardKey string, controlKey string, sectionKeys ...string) string
  • func (openControl *OpenControlDocx) FormatResponsibleRoles(standardKey string, controlKey string) string

Types

type Config

type Config struct {
	OpencontrolDir string
	TemplatePath   string
	ExportPath     string
}

Config contains data for docx template export configurations

func (*Config) BuildDocx

func (config *Config) BuildDocx() error

BuildDocx exports a Docx ssp based on a template

type OpenControlDocx

type OpenControlDocx struct {
	*models.OpenControl
}

OpenControlDocx struct is an extension of models.OpenControl that adds a template path and export path.

func (*OpenControlDocx) FormatAllNarratives

func (openControl *OpenControlDocx) FormatAllNarratives(standardKey string, controlKey string) string

FormatAllNarratives returns a control formatted for docx with all the narratives

func (*OpenControlDocx) FormatNarrative

func (openControl *OpenControlDocx) FormatNarrative(standardKey string, controlKey string, sectionKeys ...string) string

FormatNarrative returns a control formatted for docx with only the specified narrative section(s)

func (*OpenControlDocx) FormatParameter

func (openControl *OpenControlDocx) FormatParameter(standardKey string, controlKey string, sectionKeys ...string) string

FormatParameter fills in the parameter for a given parameter, standard and control.

func (*OpenControlDocx) FormatResponsibleRoles

func (openControl *OpenControlDocx) FormatResponsibleRoles(standardKey string, controlKey string) string

FormatResponsibleRoles fills in the responsible role for each component for a given standard and control.