updated site

tmtsoftware · Jul 15, 2024 · cd36cde · cd36cde
1 parent 9adef82
commit cd36cde
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 16 deletions.
diff --git a/idbs/3.1.0/modelFiles/modelFiles.html b/idbs/3.1.0/modelFiles/modelFiles.html
@@ -322,15 +322,15 @@ <h2><a href="#inner-document-links" name="inner-document-links" class="anchor"><
 <pre><code>icd-db -s NFIRAOS -o NFIRAOS.html
 </code></pre>
 <p>Note that the name attribute is used in the generated HTML instead of id, since the PDF generator required that. Many of the anchors have the following syntax:</p>
-<p><em>&lt;thisComponent-&gt;action-&lt;itemType-&gt;subsystem.&lt;component.&gt;name</em></p>
+<p><em>thisComponent-action-itemType-subsystem.component.name</em></p>
 <p>where</p>
 <ul>
-  <li><em>$thisComponent</em> is the component being described</li>
-  <li><em>$action</em> is one of {publishes, subscribes, sends, receives}</li>
-  <li><em>$itemType</em> is one of {Event, ObserveEvent, Alarm, Command}</li>
-  <li><em>$subsystem</em> is the subsystem for the item</li>
-  <li><em>$component</em> is the component for the item</li>
-  <li><em>$name</em> is the name of the item being published, subscribed to, or the command being sent or received</li>
+  <li><em>thisComponent</em> is the component being described</li>
+  <li><em>action</em> is one of {publishes, subscribes, sends, receives}</li>
+  <li><em>itemType</em> is one of {Event, ObserveEvent, Alarm, Command}</li>
+  <li><em>subsystem</em> is the subsystem for the item</li>
+  <li><em>component</em> is the component for the item</li>
+  <li><em>name</em> is the name of the item being published, subscribed to, or the command being sent or received</li>
 </ul>
 <p>For example, to link to the description of a published event named <code>heartbeat</code> in the lgsWfs component in the TEST subsystem:</p>
 <pre><code>See: [here](#lgsWfs-publishes-Event-TEST.lgsWfs.heartbeat). 
@@ -1725,6 +1725,28 @@ <h2><a href="#subscribe-model" name="subscribe-model" class="anchor"><span class
   ]
 }
 </code></pre>
+<p>Here is another example <code>subscribe-model.conf</code> that also subscribes to a published image stream:</p>
+<pre><code>subscribe {
+
+  events = [
+    {
+      subsystem = TEST
+      component = lgsWfs
+      name = engMode
+    }
+  ]
+
+  // Components can also subscribe to VIZ image streams
+  images = [
+    {
+      subsystem = TEST
+      component = lgsWfs
+      name = guider1
+      usage = &quot;WFOS guider images use for acquisition&quot;
+    }
+  ]
+}
+</code></pre>
 <p>Events have been redesigned for the CSW PDR. Components write their data and other systems sample it at the rate they need. <code>requiredRate</code> allows a component to state a rate they require to operate properly. It’s up to the publisher to make sure that they can provide that rate. This is part of checking interfaces.</p>
 <p>There is minimal documentation for subscribe items. The full description of an item belongs with the publisher, not the subscriber. The subscriber is only referencing its use of information published by another component.</p>
 <p>The <code>name</code> field must match the name of published item in another component. It must be spelled correctly. The best way is to browse the API of the source system and copy the full path.</p>

diff --git a/idbs/3.1.0/search/search_index.json b/idbs/3.1.0/search/search_index.json
diff --git a/idbs/modelFiles/modelFiles.html b/idbs/modelFiles/modelFiles.html
@@ -322,15 +322,15 @@ <h2><a href="#inner-document-links" name="inner-document-links" class="anchor"><
 <pre><code>icd-db -s NFIRAOS -o NFIRAOS.html
 </code></pre>
 <p>Note that the name attribute is used in the generated HTML instead of id, since the PDF generator required that. Many of the anchors have the following syntax:</p>
-<p><em>&lt;thisComponent-&gt;action-&lt;itemType-&gt;subsystem.&lt;component.&gt;name</em></p>
+<p><em>thisComponent-action-itemType-subsystem.component.name</em></p>
 <p>where</p>
 <ul>
-  <li><em>$thisComponent</em> is the component being described</li>
-  <li><em>$action</em> is one of {publishes, subscribes, sends, receives}</li>
-  <li><em>$itemType</em> is one of {Event, ObserveEvent, Alarm, Command}</li>
-  <li><em>$subsystem</em> is the subsystem for the item</li>
-  <li><em>$component</em> is the component for the item</li>
-  <li><em>$name</em> is the name of the item being published, subscribed to, or the command being sent or received</li>
+  <li><em>thisComponent</em> is the component being described</li>
+  <li><em>action</em> is one of {publishes, subscribes, sends, receives}</li>
+  <li><em>itemType</em> is one of {Event, ObserveEvent, Alarm, Command}</li>
+  <li><em>subsystem</em> is the subsystem for the item</li>
+  <li><em>component</em> is the component for the item</li>
+  <li><em>name</em> is the name of the item being published, subscribed to, or the command being sent or received</li>
 </ul>
 <p>For example, to link to the description of a published event named <code>heartbeat</code> in the lgsWfs component in the TEST subsystem:</p>
 <pre><code>See: [here](#lgsWfs-publishes-Event-TEST.lgsWfs.heartbeat). 
@@ -1725,6 +1725,28 @@ <h2><a href="#subscribe-model" name="subscribe-model" class="anchor"><span class
   ]
 }
 </code></pre>
+<p>Here is another example <code>subscribe-model.conf</code> that also subscribes to a published image stream:</p>
+<pre><code>subscribe {
+
+  events = [
+    {
+      subsystem = TEST
+      component = lgsWfs
+      name = engMode
+    }
+  ]
+
+  // Components can also subscribe to VIZ image streams
+  images = [
+    {
+      subsystem = TEST
+      component = lgsWfs
+      name = guider1
+      usage = &quot;WFOS guider images use for acquisition&quot;
+    }
+  ]
+}
+</code></pre>
 <p>Events have been redesigned for the CSW PDR. Components write their data and other systems sample it at the rate they need. <code>requiredRate</code> allows a component to state a rate they require to operate properly. It’s up to the publisher to make sure that they can provide that rate. This is part of checking interfaces.</p>
 <p>There is minimal documentation for subscribe items. The full description of an item belongs with the publisher, not the subscriber. The subscriber is only referencing its use of information published by another component.</p>
 <p>The <code>name</code> field must match the name of published item in another component. It must be spelled correctly. The best way is to browse the API of the source system and copy the full path.</p>

diff --git a/idbs/search/search_index.json b/idbs/search/search_index.json