dfn

package
v0.3.0-rc2 Latest Latest
Warning

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

Go to latest
Published: Apr 7, 2026 License: MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	TagOpen  = []byte("<dfn")
	TagClose = []byte("</dfn>")

	AttrTitle = []byte(" title=\"")
)

Byte constants for HTML rendering.

Functions

func New

func New(nodes ...node.Node) *element

New Creates a new dfn element with the given child nodes. Example: dfn.New(text.Text("validator")) Renders: <dfn>validator</dfn>

func RawText

func RawText(str string) *element

RawText Creates a new dfn element with raw text content. Uses text.RawText which is not HTML-escaped. Example: dfn.RawText("<b>validator</b>") Renders: <dfn><b>validator</b></dfn>

func RawTextf

func RawTextf(format string, args ...any) *element

RawTextf Creates a new dfn element with formatted raw text content. Uses text.RawTextf which is not HTML-escaped. Example: dfn.RawTextf("<abbr>%s</abbr>", term) Renders: <dfn><abbr>HTML</abbr></dfn>

func Static

func Static(str string) *element

Static Creates a new dfn element with static text content. Uses text.Static which is not HTML-escaped and is JIT-optimisable. Example: dfn.Static("Validator") Renders: <dfn>Validator</dfn>

func Text

func Text(str string) *element

Text Creates a new dfn element with text content. Uses text.Text which HTML-escapes the output. Example: dfn.Text("validator") Renders: <dfn>validator</dfn>

func Textf

func Textf(format string, args ...any) *element

Textf Creates a new dfn element with formatted text content. Uses text.Textf which HTML-escapes the output. Example: dfn.Textf("%s v%d", term, ver) Renders: <dfn>HTML v2</dfn>

func Titled added in v0.3.0

func Titled(str string, title string) *element

Titled Creates a new dfn element with the term text and an expanded title. The title provides an alternative form or full expansion of the term being defined. Uses text.Text which HTML-escapes the output. Example: dfn.Titled("spec", "Specification") Renders: <dfn title="Specification">spec</dfn>

Types

type Element

type Element = element

Element is an exported alias for the private element type

Jump to

Keyboard shortcuts

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