Manual copied from ANSTO branch and committed to RELEASE-3_0 branch.

This directory was accidentally omitted from the merge-release branch during the PSI code merge.

site_ansto/manual/dbSICSch0_TEMPLATE.xml

@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?>
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+    version="5.0">
+    <info><title>Chapter Title</title><author>
+            <personname>Ferdi Franceschini</personname>
+        </author>
+        <date>2008-08-29 16:47</date>
+    </info>
+    <sect1>
+        <title>Configuration</title>
+        <para>How to get this running in SICe.g. edit</para>
+        <para>
+            <literal>/usr/local/sics/extraconfig.tcl</literal> file </para>
+        <para><command>select_environment_controller "11TMagnet"</command></para>
+        <para>Make sure that the other entries are commented out, save the file and restart SICS.</para>
+        <para>This will set up the lakeshore temperature controller as well as the magnet power
+            supply control. They will appear as <varname>tc1</varname> and <varname>ips120</varname>
+            under the <varname>sample</varname> group in GumTree.</para>
+    </sect1>
+    <sect1>
+        <title>Commands</title>
+        <para>General description of commands are doing.</para>
+        <variablelist>
+            <varlistentry>
+                <term><command>hset /sample/ips120/Control/A 0</command></term>
+                <listitem>
+                    <para>What the command does</para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term><command>drive ips120_driveable </command><replaceable>n</replaceable></term>
+                <listitem>
+                    <para>Drive the magnet to <replaceable>n</replaceable> Tesla</para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </sect1>
+    <sect1>
+        <title>Parameters</title>
+        <variablelist>
+            <varlistentry>
+                <term><command>/sample/ips120/sensor/value </command></term>
+                <listitem>
+                    <para>Parameters that set the state of the command object. </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </sect1>
+    <sect1>
+        <title>Description</title>
+        <para>Explanation of what a command is doing when it is more than just setting a target
+            value. e.g. changing magnetic field in a superconducting magnet. </para>
+    </sect1>
+    <sect1>
+        <title>Known Issues</title>
+        <para>Alerts the user to known operational problems</para>
+    </sect1>
+    <sect1>
+        <title>Troubleshooting</title>
+        <para>What to do if things go wrong</para>
+    </sect1>
+</chapter>