Skip to content

Commit 298b777

Browse files
authored
Add tooltips to badges (#263)
Also, separate Acquisition/Configuration and Device/Device Group properties into separate tables for the purpose of implying that these are the two binary categorizations
1 parent ba62ab1 commit 298b777

File tree

4 files changed

+31
-45
lines changed

4 files changed

+31
-45
lines changed

api/overview.md

Lines changed: 11 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -26,36 +26,14 @@ distinguishing when a property change will be applied to hardware and the scope
2626
of the property's effect. The following tags are used throughout the
2727
documentation designate these property categories:
2828

29-
<span class="badge oe-badge-border oe-badge-yellow"
30-
id="configuration">Configuration</span> properties have an effect on hardware
31-
when a workflow is started and are used to initialize the hardware state. If
32-
they are changed while a workflow is running, they will not have an effect until
33-
the workflow is restarted. For example, CreateContext's
34-
<xref:OpenEphys.Onix1.CreateContext.Index> Configuration property is used to
35-
specify the hardware prior to starting a recording, and editing this property
36-
has no effect until the workflow is started or restarted.
37-
38-
<span class="badge oe-badge-border oe-badge-blue"
39-
id="acquisition">Acquisition</span> properties have an immediate effect on
40-
hardware when the workflow is running. For example, the
41-
<xref:OpenEphys.Onix1.Headstage64ElectricalStimulatorTrigger.InterPulseInterval>
42-
property allows dynamically configuring the duration between electrical
43-
stimulation pulses. Along with its other Acquisition properties, the entire
44-
electrical stimulation pattern can be modulated in real-time while the workflow
45-
is running.
46-
47-
<span class="badge oe-badge-border oe-badge-green" id="device-group">Device
48-
Group</span> properties are only available through [Device Group configuration
49-
operators](xref:configure). These properties are used to configure a group of
50-
devices. For example, ConfigureNeuropixelsV2eHeadstage's
51-
<xref:OpenEphys.Onix1.ConfigureHeadstageNeuropixelsV2e.Port> property
52-
configures the port name for all devices on the NeuropixelsV2e Headstage (which
53-
in turn automatically configures each device's address).
54-
55-
<span class="badge oe-badge-border oe-badge-purple" id="device">Device</span>
56-
properties are available through [Device configuration
57-
operators](xref:device-configure) and Device Group configuration operators which
58-
typically combine multiple individual devices. These properties are used to
59-
configure a single device. For example, ConfigureBreakoutBoard's
60-
<xref:OpenEphys.Onix1.ConfigureBreakoutBoard.AnalogIO> properties configure the
61-
Breakout Board's Analog I/O device.
29+
| Category | Description |
30+
|----------|-------------|
31+
| <span class="badge oe-badge-border oe-badge-yellow" id="configuration">Configuration</span> | Configuration properties have an effect on hardware when a workflow is started and are used to initialize the hardware state. If they are changed while a workflow is running, they will not have an effect until the workflow is restarted. For example, CreateContext's <xref:OpenEphys.Onix1.CreateContext.Index> Configuration property is used to specify the hardware prior to starting a recording, and editing this property has no effect until the workflow is started or restarted. |
32+
| <span class="badge oe-badge-border oe-badge-blue" id="acquisition">Acquisition</span> | Acquisition properties have an immediate effect on hardware when the workflow is running. For example, the <xref:OpenEphys.Onix1.Headstage64ElectricalStimulatorTrigger.InterPulseInterval> property allows dynamically configuring the duration between electrical stimulation pulses. Along with its other Acquisition properties, the entire electrical stimulation pattern can be modulated in real-time while the workflow is running. |
33+
34+
### Device Group and Device Properties
35+
36+
| Category | Description |
37+
|--------- |-------------|
38+
| <span class="badge oe-badge-border oe-badge-green" id="device-group">Device Group</span> | Device Group properties are only available through [Device Group configuration operators](xref:configure). They are used to configure a group of devices. For example, ConfigureNeuropixelsV2eHeadstage's <xref:OpenEphys.Onix1.ConfigureHeadstageNeuropixelsV2e.Port> property configures the port name for all devices on the NeuropixelsV2e Headstage (which in turn automatically configures each device's address). |
39+
| <span class="badge oe-badge-border oe-badge-purple" id="device">Device</span> | Device properties are available through [Device configuration operators](xref:device-configure) and Device Group configuration operators which combine multiple individual device configuration operators. They are used to configure a single device. For example, ConfigureBreakoutBoard's <xref:OpenEphys.Onix1.ConfigureBreakoutBoard.AnalogIO> properties configure the Breakout Board's Analog I/O device. |

template/partials/class.tmpl.partial

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,20 @@
3737

3838
{{^constituentOperator}}
3939
<a class="xref" href="~/api/OpenEphys.Onix1.html#device-group">
40-
<button class="badge oe-badge-border oe-badge-green">Device Group</button>
40+
<button class="badge oe-badge-border oe-badge-green" data-bs-toggle="tooltip"
41+
title="Device Group properties are only available through Device Group configuration operators. These properties are used to configure a group of devices.">
42+
Device Group
43+
</button>
4144
</a>
4245
<p>These are properties of the {{{oe.name}}} <a class="xref" href="~/api/configure.html">Device Group configuration operator</a>:</p>
4346
{{/constituentOperator}}
4447

4548
{{#constituentOperator}}
4649
<a class="xref" href="~/api/OpenEphys.Onix1.html#device">
47-
<button class="badge oe-badge-border oe-badge-purple">Device</button>
50+
<button class="badge oe-badge-border oe-badge-purple" data-bs-toggle="tooltip"
51+
title="Device properties are available through Device configuration operators and Device Group configuration operators which typically combine multiple individual devices. These properties are used to configure a single device.">
52+
Device
53+
</button>
4854
</a>
4955
<p>{{{object}}} is a {{{type}}} device operator contained by the {{{oe.name}}} operator with the following properties:</p>
5056
{{/constituentOperator}}

template/partials/propertyTable.tmpl.partial

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,26 @@
1010
<tr>
1111
<td style = "white-space: nowrap;">
1212
<code id="{{{id}}}">{{{name}}}</code>
13-
{{#acquisition}}
13+
{{#acquisition}}
1414
<div>
1515
<a class="xref" href="~/api/OpenEphys.Onix1.html#acquisition">
16-
<button class="badge oe-badge-border oe-badge-blue">
16+
<button class="badge oe-badge-border oe-badge-blue" data-bs-toggle="tooltip"
17+
title="Configuration properties have an effect on hardware when a workflow is started and are used to initialize the hardware state. If they are changed while a workflow is running, they will not have an effect until the workflow is restarted.">
1718
Acquisition
1819
</button>
1920
</a>
2021
</div>
21-
{{/acquisition}}
22-
{{#configuration}}
22+
{{/acquisition}}
23+
{{#configuration}}
2324
<div>
2425
<a class="xref" href="~/api/OpenEphys.Onix1.html#configuration">
25-
<button class="badge oe-badge-border oe-badge-yellow">
26+
<button class="badge oe-badge-border oe-badge-yellow" data-bs-toggle="tooltip"
27+
title="Acquisition properties have an immediate effect on hardware when the workflow is running.">
2628
Configuration
2729
</button>
2830
</a>
2931
</div>
30-
{{/configuration}}
32+
{{/configuration}}
3133
</td>
3234
<td style = "white-space: nowrap;">
3335
{{{type}}}

template/public/main.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export default {
1818
title: 'Discord'
1919
}
2020
],
21-
start: () => {
22-
WorkflowContainer.init();
23-
}
24-
}
21+
start: () => {
22+
WorkflowContainer.init();
23+
}
24+
}

0 commit comments

Comments
 (0)