Referencedefinition

<definition>

A sectional component for defining a term or concept

<definition> is a Sectional component that renders a block of content presenting a definition of a term or concept. It behaves like <example> — it accepts a custom <title> or falls back to an auto-generated name and number — but carries the semantic meaning “definition”.

Attributes and Properties

Attributes for <definition>

Scoring (9)
aggregateScores

boolean. Default value: false. Whether to aggregate scores of scored descendants into a section credit-achieved value.

colorCorrectness

boolean. Default value: false. Whether to color-code answers in this section based on correctness.

displayDigitsForCreditAchieved

integer. Default value: 3. Number of significant digits to display for the section's credit achieved value.

forceIndividualAnswerColoring

boolean. Default value: false. Whether to force per-answer color-correctness even when section-wide check work is enabled.

sectionWideCheckWork

boolean. Default value: false. Whether to show a single section-wide check-work button instead of per-answer buttons.

showCorrectness

boolean. Default value: false. Whether to display correctness indicators for answers in this section.

submitLabel

text. Default value: Check Work. Label for the section-wide submit button when correctness is shown.

submitLabelNoCorrectness

text. Default value: Submit Response. Label for the section-wide submit button when correctness is not shown.

weight

number. Default value: 1. Relative weight of this section when aggregated by an enclosing scored section.

Other (12)
asList

boolean. Default value: false. Whether to render this section's children as a list.

boolean. Default value: false. Whether to render this section with a visible box around it.

completedColor

text. Default value: var(--lightGreen). Color used to indicate this section has been completed.

includeAutoName

boolean. Default value: false. Whether to include the auto-generated section name (e.g. "Section") in the rendered title.

includeAutoNameIfNoTitle

boolean. Default value: true. Whether to include the auto-generated name when no explicit title is provided.

boolean. Default value: false. Whether to include the auto-generated section number in the rendered title.

includeAutoNumberIfNoTitle

boolean. Default value: true. Whether to include the auto-generated number when no explicit title is provided.

includeParentNumber

boolean. Default value: false. Whether to prefix this section's number with the parent section's number.

inProgressColor

text. Default value: var(--mainGray). Color used to indicate this section is in progress.

level

integer. The heading level for this section (overrides the default level inferred from nesting).

noAutoTitle

boolean. Default value: false. Whether to suppress the auto-generated title entirely.

notStartedColor

text. Default value: var(--mainGray). Color used to indicate this section has not been started.

Common to all components (9)
copy

reference. Create an independent copy of another component by reference. Enter a references a $name.

disabled

boolean. Default value: false. Whether this component is disabled and cannot be interacted with.

extend

reference. Extend another component by reference, inheriting its children and attributes. Enter a reference as $name.

fixed

boolean. Default value: false. Whether this component's value is fixed and cannot be modified.

fixLocation

boolean. Default value: false. Whether this component's location is fixed (preventing it from being moved while still allowing other modifications).

boolean. Default value: false. Whether to hide this component from the rendered output.

isResponse

boolean. Default value: false. Whether this component is treated as a response for the purposes of assessment.

name

text. The name used to reference this component from elsewhere in the document.

styleNumber

integer. Default value: 1. The style number used to select this component's visual styling from the available style definitions.

Properties for <definition name="d">

Scoring (6)
$d.aggregateScores

boolean. Whether scores of scored descendants are aggregated into this section's credit value.

$d.displayDigitsForCreditAchieved

integer. Number of significant digits to display for the section's credit achieved value.

$d.sectionWideCheckWork

boolean. Whether to show a single section-wide check-work button instead of per-answer buttons.

$d.submitLabel

text. Label for the section-wide submit button when correctness is shown.

$d.submitLabelNoCorrectness

text. Label for the section-wide submit button when correctness is not shown.

$d.weight

number. Relative weight of this section when aggregated by an enclosing scored section.

Other (17)
$d.asList

boolean. Whether to render this section's children as a list.

$d.boxed

boolean. Whether this section is rendered with a visible box around it.

$d.creditAchieved

number. Aggregate credit achieved (between 0 and 1) for scored descendants of this section.

$d.disabled

boolean. Whether this component is disabled and cannot be interacted with.

$d.fixed

boolean. Whether this component's value is fixed and cannot be modified.

$d.fixLocation

boolean. Whether this component's location is fixed (preventing it from being moved while still allowing other modifications).

$d.hidden

boolean. Whether this component is hidden from the rendered output.

$d.includeAutoName

boolean. Whether to include the auto-generated section name (e.g. "Section") in the rendered title.

$d.includeAutoNameIfNoTitle

boolean. Whether to include the auto-generated name when no explicit title is provided.

$d.includeAutoNumber

boolean. Whether to include the auto-generated section number in the rendered title.

$d.includeAutoNumberIfNoTitle

boolean. Whether to include the auto-generated number when no explicit title is provided.

$d.includeParentNumber

boolean. Whether to prefix this section's number with the parent section's number.

$d.noAutoTitle

boolean. Whether to suppress the auto-generated title entirely.

$d.open

boolean. Whether this section is currently open (for collapsible sections).

$d.percentCreditAchieved

number. Aggregate credit achieved as a percentage (between 0 and 100).

$d.sectionNumber

text. The displayed number for this section.

$d.title

text. The displayed title text for this section.

Common to all components (4)
$d.doenetML

text. The DoenetML source code that produced this component.

$d.hide

boolean. Whether to hide this component from the rendered output.

$d.isResponse

boolean. Whether this component is treated as a response for the purposes of assessment.

$d.styleNumber

integer. The style number used to select this component's visual styling from the available style definitions.

Examples

Example: <definition> with default title

When <definition> has no <title>, an auto-generated title (e.g. Definition 1) is rendered. Each <definition> is counted on the same sectional counter as its siblings.

Example: <definition> with custom title

A custom <definition> title is provided by nesting a <title> component.

Example: <definition> containing a <statement>

A nested <statement> is commonly used inside a <definition> to label the declarative content.

Attribute Examples

Attribute Example: boxed

The boxed attribute changes the default formatting to a border with a shaded title banner.

Attribute Example: includeAutoNumber

The includeAutoNumber attribute is false by default. Set it to true to render the definition number in addition to a custom title.

Attribute Example: hide

The hide attribute takes a boolean as input and can be used with any rendered component.

curve (Properties)derivative