From 5d16640ceef3985b29883fb8703d447de381077e Mon Sep 17 00:00:00 2001
From: rivers <rivers@dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b>
Date: Thu, 25 Mar 2010 20:12:57 +0000
Subject: [PATCH] Documented input links

git-svn-id: https://subversion.xor.aps.anl.gov/synApps/areaDetector/trunk@10380 dc6c5ff5-0b8b-c028-a01f-ffb33f00fc8b
---
 documentation/NDPluginOverlay.html | 76 ++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)

diff --git a/documentation/NDPluginOverlay.html b/documentation/NDPluginOverlay.html
index b885ce3..cd20c99 100755
--- a/documentation/NDPluginOverlay.html
+++ b/documentation/NDPluginOverlay.html
@@ -151,6 +151,31 @@
           longout<br />
           longin</td>
       </tr>
+      <tr>
+        <td>
+          N.A.</td>
+        <td>
+          N.A.</td>
+        <td>
+          r/w</td>
+        <td>
+          Link to fetch the desired X position of this overlay. The .DOL field of this record
+          can be set to another record which will then change PositionX whenever the other
+          record updates. The link <i>must</i> have the "CP" attribute, so that this record
+          processes whenever the record it is linked to changes. For example, the link could
+          be set to "13PS1:Stats1:CentroidX_RBV CP NMS" to fetch its position from the X centroid
+          calculated by an NDPluginStats plugin, or to "13PS1:ROI1:MinX_RBV CP MS" to fetch
+          its position from the X position of an ROI. If this link field is blank or points
+          to a non-existent record then the X position of the overlay can be manually controlled.
+          Note that this linking is done entirely in the EPICS database, and not in the plugin
+          code.</td>
+        <td>
+          N.A.</td>
+        <td>
+          $(P)$(R)PositionXLink</td>
+        <td>
+          longout</td>
+      </tr>
       <tr>
         <td>
           NDPluginOverlay<br />
@@ -170,6 +195,23 @@
           longout<br />
           longin</td>
       </tr>
+      <tr>
+        <td>
+          N.A.</td>
+        <td>
+          N.A.</td>
+        <td>
+          r/w</td>
+        <td>
+          Link to fetch the desired Y position of this overlay. See the notes for PositionXLink
+          above.</td>
+        <td>
+          N.A.</td>
+        <td>
+          $(P)$(R)PositionYLink</td>
+        <td>
+          longout</td>
+      </tr>
       <tr>
         <td>
           NDPluginOverlay<br />
@@ -189,6 +231,23 @@
           longout<br />
           longin</td>
       </tr>
+      <tr>
+        <td>
+          N.A.</td>
+        <td>
+          N.A.</td>
+        <td>
+          r/w</td>
+        <td>
+          Link to fetch the desired X size of this overlay. See the notes for PositionXLink
+          above.</td>
+        <td>
+          N.A.</td>
+        <td>
+          $(P)$(R)SizeXLink</td>
+        <td>
+          longout</td>
+      </tr>
       <tr>
         <td>
           NDPluginOverlay<br />
@@ -208,6 +267,23 @@
           longout<br />
           longin</td>
       </tr>
+      <tr>
+        <td>
+          N.A.</td>
+        <td>
+          N.A.</td>
+        <td>
+          r/w</td>
+        <td>
+          Link to fetch the desired Y size of this overlay. See the notes for PositionXLink
+          above.</td>
+        <td>
+          N.A.</td>
+        <td>
+          $(P)$(R)SizeYLink</td>
+        <td>
+          longout</td>
+      </tr>
       <tr>
         <td>
           NDPluginOverlay<br />