Skip to content

Latest commit

 

History

History
204 lines (146 loc) · 4.7 KB

README.md

File metadata and controls

204 lines (146 loc) · 4.7 KB
Raw

DoenetML

Monorepo for DoenetML Components. See the packages/* folders for individual components.

What is DoenetML?

Semantic markup for building interactive web activities. Read more about Doenet

<p>Drag the point to the 4th quadrant.</p>
<graph>
    <point xs='2 3'/>
</graph>

Features

  • Internally manages a directed acyclic graph of dependencies to coordinate updates of self-referential worksheets

Quickstart

In root directory, run

npm install
npm run build

To test code, you can use the projects/test-viewer package.

cd packages/test-viewer
npm run dev

Paste demo code into src/test/testCode.doenet and navigate to the URL specified in the console (probably http://localhost:8012 )

Demos

Point and Collect 
<graph name="graph">
	<point name="p1" xs="2 3"/>
	<point name="p2" xs="$p1.y $p1.x"/>
</graph>
<asList>
	<collect source="graph" componentTypes="point"/>
</asList>
Text Input 
<textInput name="t1" prefill="Cake"/>
<text>$t1.value is good.</text>
Sequence and Math Input 
<mathInput name="n1" prefill="4"/>
<mathInput name="n2" prefill="14"/>
<p>
	Count from $n1.value to $n2.value:
	<aslist><sequence name="seq" from="$n1.value" to="$n2.value"/></aslist>.

	And the fifth number is $seq[5].value.
</p>
Point Parallelogram 
<graph>
    <point name="p1" xs="0 4" />
    <point name="p2" xs="3 0" />
    <point name="p3" xs="$p1.x+$p2.x $p1.y+$p2.y" />
</graph>
Boolean Input 
<booleanInput name="bool"/>

I think<text hide="$bool"> therefore I am</text>.

<booleanInput name="bool2"/>
<text hide="$bool2">Yin</text>
<text hide="!$bool2">Yang</text>
Value vs Immediate Value 
<graph name="graph">
	<point name="p1" xs="$n1.value $n2.value"/>
	<point name="p2" xs="$n1.immediateValue+0.5 $n2.immediateValue"/>
</graph>

<mathInput name="n1" prefill="0"/>
<mathInput name="n2" prefill="0"/>

One point uses immediate value plus an offset
Collect Component Index 
<number name="n" copySource="/_mathinput1" />:

<p name="p1">
This paragraphs contains:
number
<number>23</number>
sequence
<aslist><sequence from="1" to="$n"/></aslist>
number
<number>42</number>
number
<number>2</number>
sequence
<aslist><sequence from="$n" to="2*$n"/></aslist>
number
<number>30</number>
</p>

Collect the numbers in that paragraph: <aslist><collect name="c1" source="p1" componentTypes="number"/></aslist>.

The fifth number is $c1[5].value.

Now try changing the number
<mathInput prefill="6"/>

Development

DoenetML features are split into npm workspace located in the packages/* directory. Each package is built using vite. Automatic building of dependencies is handled via the wireit project, which is configured in each workspace's package.json.

Automatic Rebuilding (watch mode)

Because of the complicated build process for some packages, npx vite build --watch will often fail as dependencies get rebuilt. Instead you should use

npm run build --watch

from a package's directory to have wireit manage rebuilding of dependencies. For example, to automatically rebuild doenetml on any change and have that reflected in test-viewer, you could run

cd packages/doenetml
npm run build --watch &
cd ../test-viewer
npm run dev

Since doenetml should include most packages as dependencies, a change to almost any package will cause it to be rebuilt automatically.

Consistency checks

Keeping every package.json file consistent as well as keeping the wireit dependencies correct can be hard. Programs in scripts/ can help.

npx vite-node scripts/ensure-consistency.ts

will show the dependencies imported by each package and cross-reference this with those dependencies specified in its package.json.