Merge branch 'main' into issue-46

Author: cjsha

articles/getting-started/property-categories.md

@@ -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.

template/ManagedReference.extension.js

@@ -28,38 +28,50 @@ function processChildProperty(child, sharedModel) {
   const enumFields = sharedModel[`~/api/${child.syntax.return.type.uid}.yml`]?.type === 'enum' ?
     extractEnumData(sharedModel[`~/api/${child.syntax.return.type.uid}.yml`]) :
     [];
+    const acquisition = child?.attributes.some(attribute => attribute.type === 'System.ComponentModel.CategoryAttribute' && attribute?.arguments[0].value === 'Acquisition');
+    const configuration = child?.attributes.some(attribute => attribute.type === 'System.ComponentModel.CategoryAttribute' && attribute?.arguments[0].value === 'Configuration');
   return {
     'name': child.name[0].value,
     'type': child.syntax.return.type.specName[0].value,
-    'propertyDescription': {
+    'propertyDescription': 
+    {
       'text': addCodeTag([child.summary, child.remarks].join('')),
       'hasEnum': enumFields.length > 0,
       'enum': enumFields,
-    }
+    },
+    'configuration': configuration,
+    'acquisition': acquisition
   }
 }
 
+const filterProperties = propertyCandidate => propertyCandidate.type === 'property' && !propertyCandidate?.attributes.some(attribute => 
+  attribute.type === 'System.ComponentModel.BrowsableAttribute' && attribute.arguments[0].value === false);
+
 function extractPropertiesData(model, sharedModel) {
   return model?.children
-    .filter(child => child.type === 'property' && child.syntax)
+    .filter(filterProperties)
     .map(child => processChildProperty(child, sharedModel));
 }
 
 function extractPropertiesFromInheritedMembersData(model, sharedModel) {
   return model.inheritedMembers
-    .filter(inheritedMember => inheritedMember.type === 'property')
-    .map(inheritedMember => (
-      processChildProperty(
+    .filter(filterProperties)
+    .map(inheritedMember => 
+    (
+      processChildProperty
+      (
         sharedModel[`~/api/${inheritedMember.parent}.yml`].children.find(inheritedMemberChild => inheritedMemberChild.uid === inheritedMember.uid),
         sharedModel
       )
-    ));
+    )
+  );
 }
 
 function extractConstituentOperatorsData(model) {
   return model?.children
     .filter(child => child.type === 'property' && model.__global._shared?.[`~/api/${child.syntax.return.type.uid}.yml`].type === 'class')
-    .map(child => {
+    .map(child => 
+      {
       const deviceModel = model.__global._shared?.[`~/api/${child.syntax.return.type.uid}.yml`];
       const properties = sortPropertiesData(extractPropertiesData(deviceModel, model.__global._shared));
       return {
@@ -69,7 +81,8 @@ function extractConstituentOperatorsData(model) {
         'hasProperties': properties === undefined || properties.length === 0 ? false : true,
         'properties': properties,
       };
-    });
+    }
+  );
 }
 
 function extractOperatorData(model) {

template/partials/propertyTable.tmpl.partial

@@ -10,6 +10,24 @@
   <tr>
     <td style = "white-space: nowrap;">
       <code>{{{name}}}</code>
+      {{#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}}}