Skip to content

Commit

Permalink
Add references to badges
Browse files Browse the repository at this point in the history
  • Loading branch information
cjsha committed Oct 29, 2024
1 parent 430d4e3 commit 06eeea2
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 5 deletions.
13 changes: 10 additions & 3 deletions articles/getting-started/property-categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,15 @@ title: Property Categories

There are specific categories of properties that define when an operator's properties can be modified.

`Configuration` properties only have effect when a workflow is started and are used to initialize the hardware state. If they are changed while a workflow is running they will have no effect.
<span class="badge bg-warning-subtle border border-warning-subtle text-warning-emphasis rounded-pill"
id="configuration">configuration</span> properties have an effect on hardware when a workflow is started and are used to
initialize the hardware state. Even if they are changed while a workflow is running, they will not have an effect until
the workflow is restarted.

`Acquisition` properties can be manipulated when the workflow is running and will have an immediate effect on hardware. For instance stimulus waveform parameters can be modified in real-time and sent to the device multiple times while the workflow is running to shape stimulation patterns.
<span class="badge bg-primary-subtle border border-primary-subtle text-primary-emphasis rounded-pill"
id="acquisition">acquisition</span> properties have an immediate effect on hardware when the workflow is running. For
instance, stimulus waveform properties can be dynamically modified according to parameters in your workflow.

`Devices` properties refer to the individual devices available within a particular aggregate operator. Aggregate operators include <xref:OpenEphys.Onix1.ConfigureHeadstage64>, <xref:OpenEphys.Onix1.ConfigureBreakoutBoard>, and more. Explore other available options under the [aggregate configuration operators](xref:configure) page.
`Devices` properties refer to the individual devices available within a particular aggregate operator. Aggregate
operators include <xref:OpenEphys.Onix1.ConfigureHeadstage64>, <xref:OpenEphys.Onix1.ConfigureBreakoutBoard>, and more.
Explore other available options under the [aggregate configuration operators](xref:configure) page.
20 changes: 18 additions & 2 deletions template/partials/propertyTables.tmpl.partial
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
<tr>
<td style = "white-space: nowrap;">
<code>{{{name}}}</code>
{{#acquisition}}<div style="padding-top: 0.5rem"><small class="mb-3 px-2 py-1 fw-semibold text-primary-emphasis bg-primary-subtle border border-primary-subtle rounded-2">acquisition</small></div>{{/acquisition}}
{{#configuration}}<div style="padding-top: 0.5rem"><small class="mb-3 px-2 py-1 fw-semibold text-warning-emphasis bg-warning-subtle border border-warning-subtle rounded-2">configuration</small></div>{{/configuration}}
{{#acquisition}}
<div>
<a class="xref" href="~/articles/getting-started/property-categories.html#acquisition">
<button class="badge bg-primary-subtle border border-primary-subtle text-primary-emphasis rounded-pill">
acquisition
</button>
</a>
</div>
{{/acquisition}}
{{#configuration}}
<div>
<a class="xref" href="~/articles/getting-started/property-categories.html#configuration">
<button class="badge bg-warning-subtle border border-warning-subtle text-warning-emphasis rounded-pill">
configuration
</button>
</a>
</div>
{{/configuration}}
</td>
<td style = "white-space: nowrap;">
{{{type}}}
Expand Down

0 comments on commit 06eeea2

Please sign in to comment.