Documentation
¶
Overview ¶
Package blockquote provides constructors and methods for the HTML <blockquote> element.
The <blockquote> HTML element indicates that the enclosed text is an extended quotation. Usually, this is rendered visually by indentation. A URL for the source of the quotation may be given using the cite attribute, while a text representation of the source can be given using the <cite> element.
Index ¶
- Variables
- func New(nodes ...node.Node) *element
- func NewCite(cite string, nodes ...node.Node) *element
- func RawText(str string) *element
- func RawTextCite(cite string, str string) *element
- func RawTextf(format string, args ...any) *element
- func Static(str string) *element
- func Text(str string) *element
- func TextCite(cite string, str string) *element
- func Textf(format string, args ...any) *element
- type Element
Constants ¶
This section is empty.
Variables ¶
var ( TagOpen = []byte("<blockquote") TagClose = []byte("</blockquote>") AttrCite = []byte(" cite=\"") )
Byte constants for HTML rendering.
Functions ¶
func New ¶
New creates a new blockquote element with the given child nodes. Example: blockquote.New(p.Text("To be or not to be.")) Renders: <blockquote><p>To be or not to be.</p></blockquote>
func NewCite ¶
NewCite creates a new blockquote element with a citation URL and child nodes. Example: blockquote.NewCite("https://example.com/source") Renders: <blockquote cite="https://example.com/source"></blockquote>
func RawText ¶
func RawText(str string) *element
RawText creates a new blockquote element with raw text content. Uses text.RawText which is not HTML-escaped. Example: blockquote.RawText("<p>Quoted text.</p>") Renders: <blockquote><p>Quoted text.</p></blockquote>
func RawTextCite ¶
RawTextCite creates a new blockquote element with a citation URL and raw text content as unescaped HTML. Example: blockquote.RawTextCite("https://example.com/source", "<p>Quoted text.</p>") Renders: <blockquote cite="https://example.com/source"><p>Quoted text.</p></blockquote>
func RawTextf ¶
RawTextf creates a new blockquote element with formatted raw text content. Uses text.RawTextf which is not HTML-escaped. Example: blockquote.RawTextf("<p>%s</p>", quote) Renders: <blockquote><p>To be or not to be.</p></blockquote>
func Static ¶
func Static(str string) *element
Static creates a new blockquote element with static text content. Uses text.Static which is not HTML-escaped and is JIT-optimisable. Example: blockquote.Static("Quoted text.") Renders: <blockquote>Quoted text.</blockquote>
func Text ¶
func Text(str string) *element
Text creates a new blockquote element with text content. Uses text.Text which HTML-escapes the output. Example: blockquote.Text("To be or not to be.") Renders: <blockquote>To be or not to be.</blockquote>
func TextCite ¶
TextCite creates a new blockquote element with a citation URL and text content. Example: blockquote.TextCite("https://example.com/source", "Quoted text.") Renders: <blockquote cite="https://example.com/source">Quoted text.</blockquote>
Source Files