`<note>`

A note section, set off from the main flow of the document

<note> is a Sectional container for a short remark set off from the main flow of the document. It shares the rendering and numbering machinery of <example> and <theorem> — boxed, titled, and auto-numbered — and is present primarily for PreTeXt compatibility, so DoenetML authored against PreTeXt conventions has a direct counterpart.

Use <note> for asides, warnings, or supplementary commentary. For collapsible content (revealed only when the learner clicks), use <aside> instead.

Attributes and Properties

Attributes for `<note>`

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.

boxed

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.

includeAutoNumber

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).

hide

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 `<note name="n">`

Scoring (6)

$n.aggregateScores

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

$n.displayDigitsForCreditAchieved

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

$n.sectionWideCheckWork

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

$n.submitLabel

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

$n.submitLabelNoCorrectness

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

$n.weight

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

Other (17)

$n.asList

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

$n.boxed

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

$n.creditAchieved

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

$n.disabled

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

$n.fixed

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

$n.fixLocation

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

$n.hidden

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

$n.includeAutoName

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

$n.includeAutoNameIfNoTitle

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

$n.includeAutoNumber

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

$n.includeAutoNumberIfNoTitle

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

$n.includeParentNumber

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

$n.noAutoTitle

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

$n.open

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

$n.percentCreditAchieved

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

$n.sectionNumber

text. The displayed number for this section.

$n.title

text. The displayed title text for this section.

Common to all components (4)

$n.doenetML

text. The DoenetML source code that produced this component.

$n.hide

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

$n.isResponse

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

$n.styleNumber

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

Examples

Example: A short note in the document flow

The <note> is rendered as a boxed, titled aside in the document flow. A <title> child supplies the heading; without one, the note is auto-numbered (e.g. Note 1).

Example: Multiple notes are auto-numbered

Without explicit titles each <note> is rendered with an auto-numbered heading, much like <example> or <theorem>.

not number

<note>