Documentation
¶
Index ¶
- Constants
- type Document
- func (tr *Document) EndSection()
- func (tr *Document) Heading(section uint, title, description string, ts time.Time)
- func (tr *Document) Indent(n int)
- func (tr *Document) IndentEnd()
- func (tr *Document) List(text string)
- func (tr *Document) Paragraph()
- func (tr *Document) Section(text string)
- func (tr Document) String() string
- func (tr *Document) TaggedParagraph(indentation int)
- func (tr *Document) Text(text string)
- func (tr *Document) TextBold(text string)
- func (tr *Document) TextItalic(text string)
Constants ¶
View Source
const ( // Title heading (Document structure macro) TitleHeading = `.TH %[1]s %[2]d "%[4]s" "%[3]s" "%[5]s"` // Paragraph macro Paragraph = "\n.PP" // Relative-indent start (Document structure macro) Indent = "\n.RS" // Relative-indent end (Document structure macro) IndentEnd = "\n.RE" // Indented paragraph IndentedParagraph = "\n.IP" // Section heading (Document structure macro) SectionHeading = "\n.SH %s" // Tagged paragraph TaggedParagraph = "\n.TP" // Bold escape Bold = `\fB` // Italic escape Italic = `\fI` // Return to previous font setting PreviousFont = `\fP` )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Document ¶
type Document struct {
// contains filtered or unexported fields
}
Document is a roff document.
func (*Document) IndentEnd ¶
func (tr *Document) IndentEnd()
IndentEnd decreases the indentation level.
func (*Document) TaggedParagraph ¶
TaggedParagraph starts a new tagged paragraph.
func (*Document) TextItalic ¶
TextItalic writes text in italic.
Click to show internal directories.
Click to hide internal directories.