Changeset 1057 for cssboy_deployment/docs/source/instructions.rst

Timestamp:

Aug 3, 2012 4:20:01 PM (11 years ago)

Author:

jemian

Message:

corrections & rearrangements

Location:

cssboy_deployment/docs

Files:

• . (modified) (1 prop)
• source/instructions.rst (modified) (6 diffs)

cssboy_deployment/docs/source/instructions.rst

@@ -8 +8 @@
         related to installation or configuration of CSS-BOY.  It needs to be 
         set into some sort of order.
+
+
+.. note:: This comes from a SVN repo::
+
+        svn co https://subversion.xray.aps.anl.gov/bcdaext/cssboy_deployment cssboy_deployment
 
 Install OPI screens (and other resources such as image files, javascript,
@@ -68 +73 @@
 
 
+
+
+Getting the synApps OPI screens from some place
+-----------------------------------------------------
+
+To get the synApps OPI screens, you need to do one of the following 
+(subject to revision):
+
+#. import synApps project from /APSshare
+        path:   /APSshare/epics/synApps_5_6/support/all_opi
+
+
+#. checkout synApps development trunk from SVN, then import as project
+        There is a script to do the checkout::
+
+                https://subversion.xor.aps.anl.gov/synApps/support/trunk/checkout.csh 
+        
+        One way is to place this file in */usr/local/epics* and then run it.
+        It will create a directory called *synAppsSVN/support* that contains
+        the development trunk.
+
+
+
 add OPI screens from synApps as a CSS project
-+++++++++++++++++++++++++++++++++++++++++++++
+--------------------------------------------------------------------------
 
 #. Open the ``CSS_EPICS_3.1.1`` (or whatever version) directory
@@ -105 +133 @@
 
 define synApps default fonts and colors
-+++++++++++++++++++++++++++++++++++++++++++++
+---------------------------------------------
 
 #. Select menu ``Edit-->Preferences ...``
@@ -120 +148 @@
 
    then you've got a typo or some other error.  Repeat these steps to fix it.
-
-
-Define a project for your EPICS installation
-+++++++++++++++++++++++++++++++++++++++++++++
-
-Screens for your instrument or beam line or other installation of EPICS
-may already be available.  If so, you might import them by following the steps
-above used to import synApps.  If you need to develop your own screens,
-then follow these steps:
-
-#. Select menu ``File-->New``
-#. Open ``General`` category,
-   select ``Project``,
-   click ``Next`` button
-#. Give it a Project name, something short such as *44ID* or *iocPRJ*
-   (try to avoid using spaces, it makes things harder later on), 
-#. In the ``Navigator`` view,
-   open the new project by double-clicking (or any other equivalent way)
-
-Create an OPI file
-******************
-
-#. Select menu ``File-->New``
-#. Open ``BOY`` category,
-   select ``OPI File``,
-   click ``Next`` button
-#. Select the folder to contain your new OPI screen,
-   type the name of the new OPI file in the box,
-   click ``Finish`` button
-
-Your new screen will appear in a CSS-BOY editing window.
-You might consider changing to the *OPI Editor* perspective
-as this will provide much more help in editing the screen.
-
-Once you have setup the CSS-BOY project for your EPICS installation,
-you might want one particular file to be the default  *main* file
-for your CSS-BOY workspace.  Edit the menu for *Top OPIs* via:
-``Edit --> Preferences ... --> CSS Applications --> Display``
-
-
-Setting the OPI Search Path
-------------------------------------
-
-.. note:: This could be set in a ``.ini`` file.  Needs some research...
-        Check the help for "Setting Preferences"
-        
-        The default preferences can be set in ``plugin_customization.ini`` 
-        file which is located in the root of the "Product" plugin directory 
-        or jar file. It is ideally used to provide site-specific default
-        preferences. For example, you can change the default BOY preferences 
-        in this file with corresponding preference keys::
-
-                org.csstudio.opibuilder/color_file=http://your_site.gov/color.def
-                org.csstudio.opibuilder/font_file=http://your_site.gov/font.def
-                org.csstudio.opibuilder/opi_gui_refresh_cycle=100
-                org.csstudio.opibuilder/no_edit=true
-                org.csstudio.opibuilder/macros="N","North"|"W","West"|"SYS","LLRF"|"SubSys","HPM"
-                #popup console level, it can be NO_POP, INFO, or ALL
-                org.csstudio.opibuilder/popup_console=NO_POP 
-
- You can also give a different customization file with the command line option -pluginCustomization when starting CSS.
-
-
-Getting the synApps OPI screens
--------------------------------------
-
-To get the synApps OPI screens, you need to do one of the following 
-(subject to revision):
-
-#. import synApps project from /APSshare
-        path:   /APSshare/epics/synApps_5_6/support/all_opi
-
-
-#. checkout synApps development trunk from SVN, then import as project
-        There is a script to do the checkout::
-
-                https://subversion.xor.aps.anl.gov/synApps/support/trunk/checkout.csh 
-        
-        One way is to place this file in */usr/local/epics* and then run it.
-        It will create a directory called *synAppsSVN/support* that contains
-        the development trunk.
-
-
-Importing the synApps OPI screens
--------------------------------------
-
-To import synApps OPI screens as a project in CSS-BOY::
-
-        Menu "File"
-          -->  "Import ..."
-          open  "General"
-          select "Existing projects into workspace"
-        button [Next]
-        under "Select root directory:", browse to or enter path on file system
-        make sure checkbox is marked for "synApps"
-        button [Finish]
-
+   
+.. note::  The ``color.def`` (or ``font.def``) file might not be found 
+        at the root of the synApps repository.
+        Another place to find it is in the *xxx* module, at this path::
+        
+                /synApps/xxx/xxxApp/op/opi/
+
+.. caution::  Looks like things are here twice!  Be prepared.
+
+OPI Search Path
+---------------------------------------------
+
+.. warning:: Don't rely on this section here.  A better one is up ahead!  See: :ref:`Setting the OPI Search Path`.
 
 You will also need to get the synApps project onto your OPI search path.  Here is how::
@@ -250 +194 @@
         C:\Users\Pete\Downloads\sns_css_3.1.1-win32.win32.x86_64\CSS_3.1.1\plugins\org.csstudio.sns.product_3.1.1.20120718
 
+
+Define a project for your EPICS installation
++++++++++++++++++++++++++++++++++++++++++++++
+
+Screens for your instrument or beam line or other installation of EPICS
+may already be available.  If so, you might import them by following the steps
+above used to import synApps.  If you need to develop your own screens,
+then follow these steps:
+
+#. Select menu ``File-->New``
+#. Open ``General`` category,
+   select ``Project``,
+   click ``Next`` button
+#. Give it a Project name, something short such as *44ID* or *iocPRJ*
+   (try to avoid using spaces, it makes things harder later on), 
+#. In the ``Navigator`` view,
+   open the new project by double-clicking (or any other equivalent way)
+
+Create an OPI file
++++++++++++++++++++++
+
+#. Select menu ``File-->New``
+#. Open ``BOY`` category,
+   select ``OPI File``,
+   click ``Next`` button
+#. Select the folder to contain your new OPI screen,
+   type the name of the new OPI file in the box,
+   click ``Finish`` button
+
+Your new screen will appear in a CSS-BOY editing window.
+You might consider changing to the *OPI Editor* perspective
+as this will provide much more help in editing the screen.
+
+Once you have setup the CSS-BOY project for your EPICS installation,
+you might want one particular file to be the default  *main* file
+for your CSS-BOY workspace.  Edit the menu for *Top OPIs* via:
+``Edit --> Preferences ... --> CSS Applications --> Display``
+
+
+.. _Setting the OPI Search Path:
+
+Setting the OPI Search Path
+------------------------------------
+
+.. note:: This could be set in a ``.ini`` file.  Needs some research...
+        Check the help for "Setting Preferences"
+        
+        The default preferences can be set in ``plugin_customization.ini`` 
+        file which is located in the root of the "Product" plugin directory 
+        or jar file. It is ideally used to provide site-specific default
+        preferences. For example, you can change the default BOY preferences 
+        in this file with corresponding preference keys::
+
+                org.csstudio.opibuilder/color_file=http://your_site.gov/color.def
+                org.csstudio.opibuilder/font_file=http://your_site.gov/font.def
+                org.csstudio.opibuilder/opi_gui_refresh_cycle=100
+                org.csstudio.opibuilder/no_edit=true
+                org.csstudio.opibuilder/macros="N","North"|"W","West"|"SYS","LLRF"|"SubSys","HPM"
+                #popup console level, it can be NO_POP, INFO, or ALL
+                org.csstudio.opibuilder/popup_console=NO_POP 
+
+ You can also give a different customization file with the command line option -pluginCustomization when starting CSS.
+
+.. used to show "importing synApps screens" here
 
 Calling the synApps OPI screens
@@ -302 +310 @@
         #        {Workspace}/.metadata/.plugins/org.eclipse.core.runtime/.settings
 
-::
-                             {Workspace}\.metadata\.plugins\org.eclipse.core.runtime\.settings\org.csstudio.opibuilder.prefs
+.. code-block:: text
+    :linenos:
+
+                                 {Workspace}\.metadata\.plugins\org.eclipse.core.runtime\.settings\org.csstudio.opibuilder.prefs
         C:\Users\Pete\CSS-Workspaces\Default\.metadata\.plugins\org.eclipse.core.runtime\.settings\org.csstudio.opibuilder.prefs
+
+
+Here is an example of the *org.csstudio.opibuilder.prefs* file on my Ubuntu system:
+
+.. code-block:: text
+        :linenos:
+        
+        color_file=/iocPRJ/color.def
+        eclipse.preferences.version=1
+        font_file=/iocPRJ/font.def
+        opi_search_path=/synApps/areaDetector/ADApp/op/opi | ... you get the idea, it's a long line
+        popup_console=ALL
+        top_opis=/iocPRJ/prj.opi
+
 
 Set OPI Search Path from .ini file