Index by Component Type
Paragraph markup components
These components can be placed within a <p> tag to change the rendered appearance of the enclosed text.
| Component | Description |
|---|---|
<alert> | bold text |
<asList> | formatting component for sequences and maps |
<attr> | renders default font for an attribute |
<c> | renders default font for a code example |
<ellipsis> | renders an ellipsis symbol |
<em> | renders italicized text |
<footnote> | renders a numbered footnote above and to the right of the preceeding text which expands when clicked |
<idx> | under development |
<lorem /> | generates random lorem-ipsum filler text |
<lq> | paragraph markup component for a left-quote mark |
<lsq> | paragraph markup component for a left-single-quote mark |
<nbsp/> | renders a blank space |
<pluralize> | change text from singular to plural based on context |
<pre> | preserves verbatim text; renders text as input into the editor |
<q> | paragraph markup component for a quotation |
<rq> | paragraph markup component for a right-quote mark |
<rsq> | paragraph markup component for a right-single-quote mark |
<sq> | renders the enclosed text in single quotation marks |
<tag> | render enclosed text within a pair of tags, < > </ > |
<tagc> | renders enclosed text within a closing tag, </ > |
<tage> | render enclosed text within a self-closing tag, < /> |
<term> | emphasized styling associated with a defined vocabulary word |
Sectional components
Sectional components are blocks of content that serve as containers for other components. Some of these have auto-numbering and/or a default title. General content that is not typically included inside a paragraph are also included here.
| Component | Description |
|---|---|
<activity> | a sectional component with auto-numbering and auto-title |
<aside> | renders a collapsible section of content |
<caption> | renders a caption inside a <figure> |
<cell> | smallest data element in a <table> |
<cellBlock> | a container element for specifying data in a <spreadsheet> |
<chart> | under development |
<choice> | defines a multiple-choice response |
<choiceInput> | defines a multiple-choice block |
<codeEditor> | renders an embedded doenetML code editor |
<codeViewer> | renders an embedded viewer for a <codeEditor> component |
<column> | container element for a column of cells in a <spreadsheet> |
<conclusion> | container element for content that does not have auto-numbering |
<contentPicker> | sectional component for selecting blocks of content with a pull-down menu |
<dataFrame> | under development |
<definition> | a sectional component with auto-numbering and auto-title |
<div> | groups doenetML content into an unformatted container that can be named |
<document> | largest hierarchical sectional component |
<example> | sectional component with default numbering that defines an example |
<exercise> | sectional component with default numbering that defines an exercise |
<exercises> | a container element for multiple <exercise> components |
<figure> | container element for images, videos, and captions |
<hint> | hidden content triggered by clicking on a banner or by specific user interactions |
<image /> | inserts an image |
<introduction> | container element for content that does not have auto-numbering |
<li> | list item |
<note> | an auto-numbered sectional component with default title |
<objectives> | a boxed sectional component with default title and auto-numbering |
<ol> | ordered list |
<p> | create a paragraph or drop down a line |
<paragraphs> | a container element for <p> components |
<problem> | sectional component with default numbering that defines a problem |
<problems> | a container element for <problem> components |
<proof> | sectional component designated as a proof |
<question> | a sectional component; similar to a <problem> |
<row> (in a table) | container element for one or more <cell>components within a <tabular> |
<row> (in a matrix) | container element for horizontal entries in a single row of a <matrix> |
<sbsGroup> | a container element for <sideBySide> components |
<section> | sectional component that renders an auto-numbered block of content |
<setup> | defines a block for defining or initializing named content; does not render to viewer |
<sidebySide> | renders components in a side-by-side horizontal format |
<solution> | expandable block component which displays a problem solution |
<stack> | vertical container element for organizing content within a <sideBySide> |
<statement> | container element for content that does not have auto-numbering |
<table> | container element for a <tabular> |
<tabular> | define data arranged in a tabular format |
<theorem> | a sectional component with auto-numbering and auto-title |
<title> | creates a title within a document, section, or other block component |
<topic> | container element for content that does not have auto-numbering |
<ul> | unordered, or bulleted, list |
Input components
Input components collect responses from students or users of your DoenetML activity. Response values are stored for author/instructor retrieval if the activity is assigned.
| Component | Description |
|---|---|
<booleanInput> | renders a checkbox |
<choice> | defines a multiple-choice response |
<choiceInput> | defines a multiple-choice block |
<mathInput /> | renders a user-input field that stores mathematical content |
<matrixInput /> | renders an empty matrix with blanks for user-input of entries |
<orbitalDiagramInput> | renders an interactive table for input of orbital diagrams |
<slider> | renders a sliding bar for interactively adjusting values |
<spreadsheet> | renders a basic spreadsheet tool |
<subsetOfRealsInput /> | renders an interactive number line applet |
<textInput /> | renders an input field for text responses |
Graphical components
Graphical components are any objects that can be placed on a <graph>. The following components are not considered Graphical Components, but they may be placed on a graph when given an anchor attribute for location:
<textInput/><math><m>(or any Mathematical Display component)<image/><booleanInput/>
| Component | Description |
|---|---|
<angle> | angle graphical component |
<attractTo> | attracts a point to a named graphical component |
<attractToGrid> | defines snapping behavior of GraphicalComponents to gridlines in a <graph> |
<attractToAngles> | under development |
<attractToConstraint> | under development |
<bestFitLine> | computes a linear regression on a set of points, renders a line when nested inside a <graph> |
<bezierControls> | container element for control vectors of a spline curve |
<circle> | circle Graphical Component |
<constrainTo> | constrain a <point> to a named component |
<constrainToAngle> | under development |
<constrainToGrid> | snap points to a specified grid |
<constraints> | container element for constraint components |
<constraintUnion> | container element for a union of constraint components |
<controlVectors> | define individual control vectors for a spline curve within a <bezierControls> block component |
<curve> | spline graphical component |
<endpoint> | an extension of the <point> component which allows open and toggle-open style points |
<function> | mathematical function |
<graph> | renders a 2D cartesian graph |
<intersection> | render intersections between graphical objects |
<label> | adds a label to its parent component |
<legend> | renders a legend when nested within a <graph> |
<line> | renders a line when nested inside a <graph> |
<lineSegment> | renders a line segment when nested inside a <graph> |
<parabola> | parabola Graphical Component |
<pegboard> | a Graphical Component that renders dots at grid intersections |
<piecewiseFunction> | define piecewise functions for graphing and evaluation |
<point> | point Graphical Component |
<polygon/> | polygon Graphical Component |
<polyline/> | polyline Graphical Component |
<ray> | ray Graphical Component |
<rectangle> | rectangle Graphical Component |
<regionBetweenCurveXAxis> | shade a region on a graph between a specified function and the x-axis |
<regularPolygon> | regular polygon graphical component |
<triangle> | triangle Graphical Component |
<vector> | renders a vector inside a <graph> |
<xLabel> | labels the horizontal axis on a <graph> |
<yLabel> | labels the vertical axis on a <graph> |
Display Math components
Display math components take arguments written in LaTeX. No computations or simplifications can be performed with these components, as they do not have access to the CAS.
Additionaly, Evaluation Components (such as <answer>) and Input Components (such as <mathInput>) cannot be embedded or nested within Display Math Components.
| Component | Description |
|---|---|
<m> | inline mathematical display text |
<md> | block component for centered, aligned equations; container for <mrow> |
<mdn> | block component for centered, numbered, and aligned equations; container for <mrow> |
<me> | centered mathematical display text |
<men> | centered, numbered mathematical display text |
<mrow> | defines individual row content when nested within an <md> or <mdn> |
Math components
Mathematical content can be defined and rendered with Math Components. These components can be simplified and used in computations.
| Component | Description |
|---|---|
<coords> | math component that renders a set of coordinates |
<derivative> | renders or graphs the derivative of basic elementary functions |
<function> | mathematical function |
<functionIterates> | evaluate a function over a specified number of iterations of its argument |
<integer> | defines an integer |
<math> | defines a mathematical expression for computations |
<mathList> | list of <math> values separated by commas |
<matrix> | defines a matrix for use in computations |
<number> | defines numerical content |
<numberList> | defines a list of <number> components |
<odesystem> | computes a numerical solution to a system of ordinary differential equations |
<periodicSet /> | a set of numbers defined by their periodicity |
<rightHandSide> | used with <odeSystem> to define the right-hand side of a differential equation |
<samplePrimeNumbers/> | generates randomly sampled prime numbers within a specified range |
<sampleRandomNumbers/> | generates randomly sampled numbers from a specified distribution |
<select> | select values from a list or set of <option>s to create document variants |
<selectFromSequence> | generates immutable random values within a predefined range to create document variants |
<selectPrimeNumbers/> | generates immutable random prime numbers to create document variants |
<selectRandomNumbers> | generates immutable random numbers from a specified distribution to create document variants |
<sequence /> | generate a sequence with predefined parameters |
<setSmallToZero> | replaces small numerical values with a precise zero value |
<sign> | returns the result of the sign function of the enclosed argument |
<solveEquations> | under development |
<subsetOfReals> | defines an interval or a subset on the number line |
<subsetOfRealsInput /> | renders an interactive number line applet |
<tupleList> | a list of tuples (points or intervals) |
Math operator components
Math Operator components perform computations or take actions on the math components they reference or the values they enclose.
| Component | Description |
|---|---|
<abs> | absolute value |
<ceil> | ceiling function |
<clampFunction> | |
<clampNumber> | rounds a number to within a specified interval |
<convertSetToList> | renders an unformatted set of values as a list enclosed in parentheses and separated by commas |
<count> | renders the length of its list of arguments |
<evaluate> | evaluate a function |
<extrema> | |
<floor> | renders the result of the floor function applied to the enclosed argument |
<gcd> | renders the greatest common divisor of its arguments |
<intComma> | inserts commas into a large integer when rendering |
<max> | renders the maximum value of its arguments |
<mean> | renders the arithmetic mean of a list of numerical values |
<median> | renders the median of the enclosed argument |
<min> | renders the minimum value of its arguments |
<mod> | renders the value of , where and are the two listed arguments |
<product> | renders the product of its arguments |
<round> | round a number to a specified place value |
<standardDeviation> | renders the standard deviation of its arguments |
<sum> | renders the sum of its arguments |
<summaryStatistics> | |
<variance> | renders the variance of its arguments |
<wrapFunctionPeriodic> | |
<wrapNumberPeriodic> | wraps a number line around a circle |
General operator components
These components perform actions on Math components as well as other component types.
| Component | Description |
|---|---|
<animateFromSequence> | renders an animation of a changing component or component property |
<callAction> | triggers an action when clicked or in response to a specified user interaction |
<case> | defines the condition within a <conditionalContent> block |
<collect /> | gathers multiple data instances of a specified type from a graph or a sectional component and stores in a list |
<conditionalContent> | defines a section of content rendered upon a specific condition |
<customAttribute> | used within a <module> to create unique custom attributes specific to that module |
<displayDoenetML> | |
<extract> | extract data from a component or group of components |
<extractMath> | extract data (such as number of operands, or individual operands) from mathematical expressions |
<extractMathOperator> | |
<group> | groups multiple components into one component which can be referenced with a single name |
<map> | takes a list of <sources> and applies a <template> to each source in turn |
<module> | define a local template for a custom doenetML component or widget for re-use within the document |
<option> | specifies selection items within a <select> block |
<paginator> | define a paginated section of content within a larger <document> |
<paginatorControls /> | render navigation buttons for progression through content in a <paginator> |
<ref> | creates a link to another document, or a referenced component’s location within the same document |
<shuffle> | shuffle a list, or a listing of referenced components |
<sort> | sort components based on their values in numerical or alphabetical order |
<sources> | used within a <map> to define input values for <template> and alias |
<split> | splits multi-digit numbers or text strings into individual characters |
<spreadsheet> | renders a basic spreadsheet tool |
<styleDefinition> | defines custom styling for graphical elements outside the default styleNumbers (1-6) |
<styleDefinitions> | container element for the custom <styleDefinition> in a document |
<substitute> | replace a math, character or string with a user-specified alternative |
<template> | defines operations to apply to individual <sources> within a <map> |
<triggerSet> | groups a set of <updateValue> or <callAction> components which share a single trigger condition |
<updateValue> | changes the value or property of a named component |
<variantControl> | |
<variantNames> | |
<video /> | embeds a video |
Logic components
Logic components define boolean conditions or are used in logical expressions.
| Component | Description |
|---|---|
<and> | functions as the boolean operator and or & |
<boolean> | renders the boolean true or false value of the enclosed expression |
<booleanInput> | renders a checkbox |
<booleanList> | list of <boolean> values separated by commas |
<else> | defines a logical else condition within a <conditionalContent> block |
<isBetween> | returns whether a value is within a specified interval |
<isInteger> | returns whether a value is an integer |
<isNumber> | returns whether a value is a number |
<not> | used in the construction of boolean conditions |
<or> | functions as the boolean operator or |
<xor> | functions as the exclusive or boolean operator |
Evaluation components
These components are used in answer validation, evaluation, or the awarding of credit.
| Component | Description |
|---|---|
<answer> | defines an answer block for response validation |
<award> | specifies conditions for awarding credit where multiple user responses are considered |
<considerAsResponses> | specifies components involved in response data collection when the component occurs outside an <answer> block |
<feedback> | hidden content triggered in response to specific user interactions |
<feedbackDefinition> | define a recurring feedback for repeated use within a document |
<feedbackDefinitions> | container element for <feedback> definitions |
<hasSameFactoring> | check to see if two expressions are factored in the same way |
<matchesPattern> | evaluate whether an expression matches the pattern of a defined mathematical template |
<when> | defines logical conditions within an <award> |
Text components
Text components are values containing strings that are not necessarily embedded in paragraphs.
| Component | Description |
|---|---|
<text> | a stored text value, or string |
<textList> | list of <text> values separated by commas |
Subject-specific components
These components are classified based on their relevance to a particular subject.