Documents and slides

Document output lets a calculation return a report-like structure whose building blocks can form a notebook result, generated handout, or presentation slide.

Compose a fragment explicitly

.Fragment holds an ordered sequence of output values. .Heading and .Paragraph establish document structure; .Figure adds a caption and label around any output value.

Runnable RiXRun cell

summary := .Table( ["quantity", "value"], [["side", 7], ["area", 49]] ); .Fragment([ .Heading(1, "Square report"), .Paragraph("All values in this report are exact."), .Figure(summary, "Measurements for one square", "fig:square") ]) ;

The label is useful to a renderer or exporter even though RiX Web simply shows the figure in place. Keep labels stable when you expect a document to grow.

Write a compact document template

For text-heavy reports, @"""...""" makes a Fragment directly. Blank lines separate document blocks. Prefix a block with h1: through h6: to start a section, or use fig: / table: for a captioned standalone value. @{...} evaluates now and inserts the resulting value.

Runnable RiXRun cell

values := .Table( ["x", "x squared"], [[1, 1], [2, 4], [3, 9]] ); @""" h1: Exact square values The square of 3 is @{3 ^ 2}. table: Selected values #tbl:squares @{values} """ ;

Interpolation here is different from a deferred block such as @{; ...}. The template evaluates the interpolation immediately and stores the resulting text or output value in the document.

Use the template’s document syntax

The template has a compact, strict Markdown-like inline vocabulary: *emphasis*, strong, *both*, ` code , $math$, and [label](link: primary {attributes}). It intentionally does not use underscore delimiters, so ordinary RiX-style names such as exact_value stay ordinary text. @@{ writes a literal @{`, even inside code or math.

Runnable RiXRun cell

count := 5; diagram := "assets/exact-proof.svg"; @""" h1: ***Exact*** report #exact-report p: The **answer** is @{count}. Its source is `answer := @{count}` and its math is $x_@{count} = 25$. callout: tip — Keep the proof Use exact values until the final display. code: rix next := @{count}; @@{ math: x_@{count} = 25 ol: - Start with the certified value. ul: - Preserve the endpoint proof. image: @{diagram} {mime=image/svg+xml, alt="A proof diagram", width=320} """ ;

The h1: creates the outer Section; a later h2: would become its child, while another h1: starts a sibling. The parser rejects skipped heading levels and runs of four or more asterisks, so ambiguous markup is caught where it is authored.

Keep inline meaning and document blocks

Paragraph children can now be semantic inline values rather than values that a renderer flattens to text. Sections, quotations, callouts, code blocks, display math, and nested lists are all portable records. The browser chooses HTML elements; a terminal keeps an honest text fallback.

Runnable RiXRun cell

.Section({= level=1, id="exactness", title=[.Text("Exact "), .Math({= source="x^2 = 2" })], children=[ .Paragraph([ .Text("Use "), .Emphasis("exact"), .Text(" values and "), .Strong("keep the proof"), .Text(" in "), .Code(".Math"), .Text("."), .LineBreak(), .Text("The source remains portable.") ]), .Callout({= variant=:note, title="Renderer policy", children=[.Paragraph("The record chooses meaning; the host chooses presentation.")] }), .Quote({= children=[.Paragraph("Truth is ever to be found in simplicity.")], attribution="Isaac Newton" }), .CodeBlock({= language="rix", code="next := (x + 2 / x) / 2;" }), .MathBlock({= source="x_{n+1} = (x_n + 2/x_n) / 2", alt="Newton update" }), .List({= ordered=1, items=[ .ListItem(.Paragraph("Start with a certified interval.")), .ListItem(.Paragraph("Record the exact refinement.")) ] }) ] }) ;

Image, Audio, and Video wrap an .Asset reference rather than pretending that a vector .Graphic is a photograph or media file. Image alternative text is required; audio and video retain an optional transcript that export hosts can require. Asset resolution stays with the host, so a RiX record never opens a file or fetches a URL by itself.

Wrap a graphic as a figure

Figures are not limited to tables. This creates a small plot, then gives it a caption and a stable label for document cross references. The document plugin tutorial connects these records to publication planning; renderer tutorials cover HTML, LaTeX and other exports.

Runnable RiXRun cell

.Plugin.Load("plot"); curve := .plot.Polynomial([1, -2, -1], [-1, 4]); .Figure(curve, "Graph of x squared minus 2x minus 1", "fig:curve") ;

Build a deck one slide at a time

.Slide attaches a title and optional metadata to one output value. .Slides preserves the order of those slides. RiX Web renders the current deck as a series of clearly separated slide sections; other hosts can add navigation or export without changing the RiX source.

Runnable RiXRun cell

.Plugin.Load("plot"); count := 5; deck := .Slides( [ .Slide( .Fragment([ .Heading(1, "Exact data"), .Paragraph("A table remains structured data.") ]), "Data" ), .Slide( @""" h1: ***Exact*** snapshot p: The certified result is @{count}. callout: tip — Preserve the proof Keep the exact value until the final display. """, "Template report" ), .Slide( .Fragment([ .Heading(1, "Exact graph"), .plot.Polynomial([1, -2, -1], [-1, 4]) ]), "Graph" ) ], "Output building blocks" ); deck ;