Referenceaside

<aside>

A note set off from the main flow of the document

<aside> is a Sectional component that renders a collapsible, boxed section of content that is expanded when the user clicks the banner to display supplementary material.

Attributes and Properties

Attributes for <aside>

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

collapsible

boolean. Default value: true. Whether the section can be collapsed and expanded.

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.

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.

postponeRendering

boolean. Whether to delay rendering this section's contents until expanded.

boolean. Default value: false. Whether the collapsible section starts in the open state.

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 <aside name="a">

Scoring (6)
$a.aggregateScores

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

$a.displayDigitsForCreditAchieved

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

$a.sectionWideCheckWork

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

$a.submitLabel

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

$a.submitLabelNoCorrectness

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

$a.weight

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

Other (18)
$a.asList

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

$a.boxed

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

$a.collapsible

boolean. Whether the section can be collapsed and expanded.

$a.creditAchieved

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

$a.disabled

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

$a.fixed

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

$a.fixLocation

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

$a.hidden

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

$a.includeAutoName

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

$a.includeAutoNameIfNoTitle

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

$a.includeAutoNumber

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

$a.includeAutoNumberIfNoTitle

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

$a.includeParentNumber

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

$a.noAutoTitle

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

$a.open

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

$a.percentCreditAchieved

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

$a.sectionNumber

text. The displayed number for this section.

$a.title

text. The displayed title text for this section.

Common to all components (4)
$a.doenetML

text. The DoenetML source code that produced this component.

$a.hide

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

$a.isResponse

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

$a.styleNumber

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

Examples

Example: <aside> with default title

An <aside> with its default title is automatically numbered in sequence with other sectional components on the page.

Example: <aside> with custom title

An <aside> with a custom title does not have automatic numbering.

Attribute Examples

Attribute Example: startOpen

The startOpen attribute overrides the default behavior in which the <aside> section appears closed upon opening the page.

Attribute Example: includeParentNumber

The includeParentNumber attribute is false by default for the <aside> component (and true by default for the <section> component).

In order to include the number of the parent sectional component, set includeParentNumber to true.

Attribute Example: includeAutoNumber

The includeAutoNumber attribute is false by default for the <aside> component. This means that if an aside contains a nested <title>, it will not render the default numbering (although it will still be counted in the numbering scheme behind the scenes).

In order to display the aside number in addition to the custom <title>, set the includeAutoNumber attribute to true.

asListatom