warning

A callout warning of a hazard: what goes wrong if the reader gets a step wrong, and what it costs.

warningNodeAliases:caution
On this page

#Attributes

titleImplicit
Set after the WARNING label. Rich text, so $…$ maths and inline formatting set in it. Without one, the label stands alone.
rich-text
Can be written as shorthand: warning:value

#Allowed content

Body { }
paragraphh1h2h3h4listequation

#Allowed in

scene { }

#Examples

warning{
    Always add acid to water, never water to acid. Water poured onto concentrated acid can boil on contact and spray the acid out of the beaker.
}(
    title: Diluting acid
)
warning{
    Dividing both sides by $x$ loses the solution $x = 0$.
}

#Notes

  • It is headed WARNING and its number, then the title if there is one; the body is the hazard.
  • Narrative only: a callout in a scene's detail is refused.
  • Callouts do not nest, and none takes a divider or an internote card in its body.
  • A warning takes no detail: node warning does not allow detail content.
  • Every callout but a panel is numbered through the internote in the order it is written, each kind counting on its own: DEFINITION 1, NOTE 1, DEFINITION 2. A theorem's kinds share one count: THEOREM 1, LEMMA 2.

#Writing guidance

  • Callouts — Prose around every callout, one job each, a definition written to stand in a glossary, and which callout a result, a hazard or a set-apart panel takes.

Last updated