Note Input Example

Location: examples/rappture2/note/

This example demonstrates the <note> input type – read-only HTML content displayed within the input panel.

tool.xml

<?xml version="1.0"?>
<run xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="../../../rappture2web/contract.xsd">
<tool>
  <title>note (rappture2web)</title>
  <about>Example of a Rappture &lt;note&gt; object.

Notes are descriptive explanations to the user. The contents can be arbitrary HTML.
  </about>
  <command>python3 @tool/note.py @driver</command>
  <contract>
    <input>
      <number id="diameter">
        <about>
          <label>Particle diameter d</label>
          <description>Diameter of sphere-shaped nanoparticles.</description>
        </about>
        <units>nm</units>
        <min>2nm</min>
        <max>20nm</max>
        <default>5nm</default>
      </number>
    </input>
    <output>
      <string id="out"><about><label>Particle diameter</label><description>Reports the selected particle diameter.</description></about></string>
    </output>
  </contract>
</tool>
<input>
  <note>
    <contents>file://bysize.html</contents>
  </note>
  <number id="diameter">
    <about>
      <label>Particle diameter d</label>
      <description>Diameter of sphere-shaped nanoparticles.</description>
    </about>
    <units>nm</units>
    <min>2nm</min>
    <max>20nm</max>
    <default>5nm</default>
  </number>
</input>
</run>

Key concepts

• <contents>file://bysize.html</contents> loads HTML from an external file relative to the tool directory.

• Notes can also contain inline HTML directly.

• Notes are non-interactive and are not sent as inputs to the simulation.

Running

rappture2web examples/rappture2/note/