dc_readme

package
v0.6.0 Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2021 License: MIT Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func NewCommand

func NewCommand(forPublish bool, media dc_index.MediaType, container app_msg_container.Container) dc_section.Section

func NewHeader

func NewHeader(forPublish bool) dc_section.Section

func NewLicense

func NewLicense() dc_section.Section

func NewRelease

func NewRelease() dc_section.Section

func NewSecurity

func NewSecurity() dc_section.Document

func NewSecuritySection

func NewSecuritySection() dc_section.Section

func NewSupplemental

func NewSupplemental() dc_section.Section

func NewUsage

func NewUsage() dc_section.Section

Types

type Command

type Command struct {
	CommandHeader      app_msg.Message
	TableHeaderCommand app_msg.Message
	TableHeaderDesc    app_msg.Message
	// contains filtered or unexported fields
}

func (Command) Body

func (z Command) Body(ui app_ui.UI)

func (Command) Title

func (z Command) Title() app_msg.Message
type Header struct {
	HeaderTitle app_msg.Message
	HeaderBody  app_msg.Message
	// contains filtered or unexported fields
}

func (Header) Body

func (z Header) Body(ui app_ui.UI)

func (Header) Title

func (z Header) Title() app_msg.Message

type License

type License struct {
	HeaderTitle        app_msg.Message
	BodyLicense        app_msg.Message
	BodyLicenseRemarks app_msg.Message
	BodyLicenseQuote   app_msg.Message
}

func (License) Body

func (z License) Body(ui app_ui.UI)

func (License) Title

func (z License) Title() app_msg.Message

type Readme

type Readme struct {
	Desc app_msg.Message
	// contains filtered or unexported fields
}

func (Readme) DocDesc

func (z Readme) DocDesc() app_msg.Message

func (Readme) DocId

func (z Readme) DocId() dc_index.DocId

func (Readme) Sections

func (z Readme) Sections() []dc_section.Section

type Release

type Release struct {
	ReleaseHeader  app_msg.Message
	ReleaseBody    app_msg.Message
	HomebrewHeader app_msg.Message
	HomebrewDesc   app_msg.Message
}

Section of pointer to download

func (Release) Body

func (z Release) Body(ui app_ui.UI)

func (Release) Title

func (z Release) Title() app_msg.Message

type SecurityDesc

type SecurityDesc struct {
	HeaderTitle                   app_msg.Message
	HeaderInformationNotCollected app_msg.Message
	HeaderSensitiveData           app_msg.Message
	BodyInformationNotCollected   app_msg.Message
	BodySensitiveData             app_msg.Message
}

func (SecurityDesc) Body

func (z SecurityDesc) Body(ui app_ui.UI)

func (SecurityDesc) Title

func (z SecurityDesc) Title() app_msg.Message

type Supplemental

type Supplemental struct {
	SupplementalTitle app_msg.Message
	DocumentName      app_msg.Message
	DocumentDesc      app_msg.Message
}

func (Supplemental) Body

func (z Supplemental) Body(ui app_ui.UI)

func (Supplemental) Title

func (z Supplemental) Title() app_msg.Message

type Usage

type Usage struct {
	UsageHeader app_msg.Message
	UsageBody   app_msg.Message
}

func (Usage) Body

func (z Usage) Body(ui app_ui.UI)

func (Usage) Title

func (z Usage) Title() app_msg.Message

Jump to

Keyboard shortcuts

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