Changeset 1051

Timestamp:

Jul 18, 2012 10:01:17 AM (11 years ago)

Author:

jemian

Message:

revising instructions

Location:

cssboy_deployment/docs

Files:

• build (deleted)
• source/instructions.rst (modified) (5 diffs)

cssboy_deployment/docs/source/instructions.rst

@@ -41 +41 @@
 where OPI is an EPICS term Operator Programmer Interface) 
 component which is an EPICS display tool.
-For some time, APS developed a custom CSS product [#aps_css]_ to provide
-features and customizations that were not part of the SNS build.
-
-It is recommended now to use the CSS-BOY as built by the team at
-SNS [#css_boy_downloads]_.
-
-.. note:: 
-   You need a Java Runtime Environment (at least) to run CSS.
-   Also, you will need one or more EPICS IOCs to serve PVs
-   or all you can do is use the simulator inside CSS.
-
-#. Visit this URL and download most-recent version of 
+
+        .. tip:: Use the SNS release
+                
+                For some time, APS developed a custom CSS product [#aps_css]_ to provide
+                features and customizations that were not part of the SNS build.
+                
+                It is recommended now to use the CSS-BOY as built by the team at
+                SNS [#css_boy_downloads]_.
+        
+        .. note:: 
+           You need a Java Runtime Environment (at least) to run CSS.
+           Also, you will need one or more EPICS IOCs to serve PVs
+           or all you can do is use the simulator inside CSS.
+
+#. Visit this URL and download the most-recent version of 
    **Basic EPICS** for your OS:
    http://ics-web.sns.ornl.gov/css/products.html
@@ -63 +66 @@
 
 #. Open the ``CSS_EPICS_3.1.0`` (or whatever version) directory
-#. Start ``css`` by double-clicking it
+#. Start ``css`` by double-clicking it.
+   If you use a unix or linux command line, type::
+   
+       ./css &
+   
 #. Select menu ``File-->Import ...``
 #. Open ``General`` category,
@@ -69 +76 @@
    click ``Next`` button
 #. Click ``Browse ...`` button (in *Import* window),
-   navigate to ``/APSshare/epics/synApps_5_6/support/all_opi``,
-   click ``Ok`` button
+   navigate to ``/APSshare/epics/synApps_5_6/support/``
+   (or ``/usr/local/epics/synAppsSVN/support/`` or wherever)
+#. Click ``Ok`` button
 #. Click ``Finish`` button (in *Import* window)
+
+.. note::  If CSS reports that your synApps directory cannot be imported
+        since it is not a *project*, you can make it a project by creating
+        a ``synApps/support/.project`` text XML file with this content::
+
+                <?xml version="1.0" encoding="UTF-8"?>
+                <projectDescription>
+                        <name>synApps</name>
+                        <comment>EPICS synApps</comment>
+                        <projects>
+                        </projects>
+                        <buildSpec>
+                        </buildSpec>
+                        <natures>
+                        </natures>
+                </projectDescription>
+
 
 define synApps default fonts and colors
@@ -182 +207 @@
         click "Ok" until you out of the dialogs.  Now the paths should work.
 
+
+Also, when calling a synApps .opi screen from the instrument or beam line, it is not necessary to use the full path since there is an OPI search path that will locate the screen.  Example, instead of::
+
+   /synApps/motor/motorApp/op/opi/motor3x.opi
+
+you would just call::
+
+   motor3x.opi
 
 
@@ -200 +233 @@
 Perspective   Defined arrangement of Views and Editors in eclipse.
               A Perspective can be customized and saved within
-              the Workspace for later recall.
+              the Workspace for later recall.
 View          One type of display in eclipse, some can be undocked
               (or torn-off) so they can be a spearate window.
-              ??? Are undocked Views saved as part of the 
-              Perspective? ???
+              ??? Are undocked Views saved as part of the 
+              Perspective? ???
 Editor        One type of display in eclipse.
 Navigator     Used to browse the Workspace for files and subdirectories.
 eclipse       Java-based software providing a configurable interactive 
               development environment (IDE).  Eclipse can be highly
-              customized to deliver a specific application,
-              such as CSS or CSS-BOY.
+              customized to deliver a specific application,
+              such as CSS or CSS-BOY.
 CSS           Control System Studio from DESY, based on eclipse
 CSS-BOY       CSS Best Opi Yet EPICS Display software (replacement for medm)
 ============  ==================================================================
 
+
+.. rubric:: The Glossary
+
+.. glossary::
+
+Workspace
+        file system directory containing directories 
+        and files used by a single CSS-BOY user
+
+Project
+        subdirectory within a ``workspace`` containing
+        related files and subdirectories
+
+``.js``
+        javascript file
+
+``.opi``
+        display screen file used by CSS-BOY
+
+Perspective   
+        Defined arrangement of Views and Editors in eclipse.
+        A Perspective can be customized and saved within
+        the Workspace for later recall.
+
+View
+        One type of display in eclipse, some can be undocked
+        (or torn-off) so they can be a spearate window.
+        ??? Are undocked Views saved as part of the 
+        Perspective? ???
+
+Editor
+        One type of display in eclipse.
+
+Navigator
+        Used to browse the Workspace for files and subdirectories.
+
+eclipse
+        Java-based software providing a configurable interactive 
+        development environment (IDE).  Eclipse can be highly
+        customized to deliver a specific application,
+        such as CSS or CSS-BOY.
+
+CSS
+        Control System Studio from DESY, based on eclipse
+
+CSS-BOY
+        CSS Best Opi Yet EPICS Display software (replacement for medm)
+
+
+--------------------
+
 Footnotes
 ---------
 
-.. [#eclipse]           http://eclipse.org
+.. [#eclipse]                   http://eclipse.org
 .. [#css_boy_downloads] http://ics-web.sns.ornl.gov/css/products.html
-.. [#css]               http://css.desy.de
-.. [#aps_css]           http://css.aps.anl.gov
-.. [#synApps]           http://www.aps.anl.gov/bcda/synApps
+.. [#css]                               http://css.desy.de
+.. [#aps_css]                   http://css.aps.anl.gov
+.. [#synApps]                   http://www.aps.anl.gov/bcda/synApps