Skip to main content

The PreTeXt Guide

Subsection 4.2.2 Isomorphic Blocks

The structure of a block is described carefully in the schema (Chapter 6). There are approximately forty blocks that are arranged into ten groups, within which they behave identically, except for their displayed names. An exception is the group of four “figure-like” items which are very similar, but have differences beyond just their displayed names. These groupings are defined in the xsl/entities.ent file, which we summarize in the next table. The category name is taken from the entities file, and the notes are meant to describe the distinctive capabilities of the category.
List Summary of Blocks
<remark>, <convention>, <note>, <observation>, <warning>, <insight>
The most basic, generic, block.
<example>, <question>, <problem>
A worked problem meant as exposition. It can be structured with <task>, <hint>, <answer>, and <solution> just like an <exercise> or PROJECT-LIKE, but the <hint>, <answer>, and <solution> cannot be electively removed from output, and they do not migrate to collections of solutions elsewhere. Hidden by default for HTML output formats.
<project>, <activity>, <exploration>, <investigation>
These are similar to an <exercise>, but the name suggests a slightly different undertaking, and they cannot be placed in an <exercises> division. The current default is that they are numbered independently from other blocks, but this is planned to switch to elective behavior. The <hint>, <answer>, and <solution> behave more like those for an <exercise> and can be removed from output, and can migrate to collections of solutions.
<figure>, <table>, <listing>, <list>
An object that is a container for other atomic objects, which are typically somewhat rigid (not reflowable) or two-dimensional. Typically with a number, and provided with a title or caption. But each is slightly different in what it can contain and how it is rendered. A <table> can only hold a <tabular>, while a <listing> is meant for <program> and <console>. A <list> is not the list itself, but a container for one of the three possible lists (see Section 4.11 and especially Section 4.20). A <figure> is the most liberal, allowing a wide variety of contents, with <image> being the prototypical example. These are not designed with the expectation that they can be renamed.
<theorem>, <corollary>, <lemma>, <algorithm>, <proposition>, <claim>, <fact>, <identity>
Mathematical results, which can have an (optional) <proof>. Proofs are hidden by default in HTML output.
<axiom>, <conjecture>, <principle>, <heuristic>, <hypothesis>, <assumption>
A mathematical statement, which does not have a proof.
A definition of a (mathematical) object.
<aside>, <biographical>, <historical>
Parenthetical content that is structured beyond what a footnote can contain.
<computation>, <technology>, <data>
For descriptions of activities or data for use with computers, calculators, or other devices.
<objectives>, <outcomes>
These are structured primarily as lists, and may only appear early (<objectives>) or late (<outcomes>) within a division.