Changeset 1053


Ignore:
Timestamp:
Jul 18, 2012 10:59:37 AM (11 years ago)
Author:
jemian
Message:

documentation changes in progress

Location:
cssboy_deployment/docs/source
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • cssboy_deployment/docs/source/conf.py

    r805 r1053  
    9494html_theme = 'default'
    9595html_theme = 'agogo'
     96html_theme = 'sphinxdoc'
    9697
    9798# Theme options are theme-specific and customize the look and feel of a theme

  • cssboy_deployment/docs/source/instructions.rst

    r1051 r1053  
    44Instructions
    55==========================
     6
     7.. caution:: This documentation is under revision, thus the order may seem a bit scrambled.
    68
    79Install OPI screens (and other resources such as image files, javascript,
    … …  
    2628  workspace.
    2729
    28 Leave the ``CSS`` project for use as a sandbox (special area for files
     30Leave the *CSS* project for use as a sandbox (special area for files
    2931which you are testing or using for a short time and do not wish to treat
    3032as part of everyone's workspace).
    … …  
    5860   **Basic EPICS** for your OS:
    5961   http://ics-web.sns.ornl.gov/css/products.html
     62   
     63   (Alternative URL: https://ics-web.sns.ornl.gov/css/updates/apps/ )
    6064#. Unzip the contents someplace.  Typical for me is:
    61    ``~/Apps/CSS_EPICS_3.1.0``
     65   ``~/Apps/CSS_EPICS_3.1.1``
    6266
    6367
    … …  
    6569+++++++++++++++++++++++++++++++++++++++++++++
    6670
    67 #. Open the ``CSS_EPICS_3.1.0`` (or whatever version) directory
     71#. Open the ``CSS_EPICS_3.1.1`` (or whatever version) directory
    6872#. Start ``css`` by double-clicking it.
    6973   If you use a unix or linux command line, type::
    … …  
    109113#. For Top OPIs, replace with OPI file of your choice
    110114
    111 .. note:: If get a console message that says:
     115.. note:: If you get a console message that says:
    112116
    113117      2012-04-30 15:59:12 ERROR: Failed to read font definition file.
    … …  
    145149
    146150Your new screen will appear in a CSS-BOY editing window.
    147 You might consider changing to the ``OPI Editor`` perspective
     151You might consider changing to the *OPI Editor* perspective
    148152as this will provide much more help in editing the screen.
    149153
    … …  
    154158
    155159
    156 Notes
    157 ------------
    158 
    159 .. note:: This could be set in in a ``.ini`` file.  Needs some research...
    160 
    161 ::
    162 
    163   Edit (Menu)
    164     Preferences
    165       CSS Applications
    166             Display
    167               BOY
    168                     OPI Search Path
    169 
    170   /synApps/areaDetector | /synApps/asyn | /synApps/autosave | /synApps/busy | /synApps/calc | /synApps/camac | /synApps/dac128V | /synApps/delaygen | /synApps/dxp | /synApps/iocStats | /synApps/ip | /synApps/ip330 | /synApps/ipUnidig | /synApps/love | /synApps/mca | /synApps/modbus | /synApps/motor | /synApps/optics | /synApps/quadEM | /synApps/softGlue | /synApps/sscan | /synApps/std | /synApps/vac | /synApps/vme | /synApps/xxx
    171 
    172 **PRJ:** Here are these instructions as I sent them in an email on 2012-06-10::
    173 
    174         To get the synApps OPI screens, you need to do one of the following (subject to change as we improve this process over the next months as all these options are development status):
    175 
    176         import synApps project from /APSshare
    177                 path:   /APSshare/epics/synApps_5_6/support/all_opi
    178 
    179 
    180         checkout from SVN, then import project
    181                 svn co https://subversion.xor.aps.anl.gov/bcdaext/cssboy_deployment/all_opi/ /path/to/a/new/synApps_all_opi
    182 
    183 
    184         To import synApps OPI screens as a project in CSS-BOY:
     160Setting the OPI Search Path
     161------------------------------------
     162
     163.. note:: This could be set in a ``.ini`` file.  Needs some research...
     164        Check the help for "Setting Preferences"
     165       
     166        The default preferences can be set in ``plugin_customization.ini``
     167        file which is located in the root of the "Product" plugin directory
     168        or jar file. It is ideally used to provide site-specific default
     169        preferences. For example, you can change the default BOY preferences
     170        in this file with corresponding preference keys::
     171
     172                org.csstudio.opibuilder/color_file=http://your_site.gov/color.def
     173                org.csstudio.opibuilder/font_file=http://your_site.gov/font.def
     174                org.csstudio.opibuilder/opi_gui_refresh_cycle=100
     175                org.csstudio.opibuilder/no_edit=true
     176                org.csstudio.opibuilder/macros="N","North"|"W","West"|"SYS","LLRF"|"SubSys","HPM"
     177                #popup console level, it can be NO_POP, INFO, or ALL
     178                org.csstudio.opibuilder/popup_console=NO_POP
     179
     180 You can also give a different customization file with the command line option -pluginCustomization when starting CSS.
     181
     182
     183Getting the synApps OPI screens
     184-------------------------------------
     185
     186To get the synApps OPI screens, you need to do one of the following
     187(subject to revision):
     188
     189#. import synApps project from /APSshare
     190        path:   /APSshare/epics/synApps_5_6/support/all_opi
     191
     192
     193#. checkout synApps development trunk from SVN, then import as project
     194        There is a script to do the checkout::
     195
     196                https://subversion.xor.aps.anl.gov/synApps/support/trunk/checkout.csh
     197       
     198        One way is to place this file in */usr/local/epics* and then run it.
     199        It will create a directory called *synAppsSVN/support* that contains
     200        the development trunk.
     201
     202
     203Importing the synApps OPI screens
     204-------------------------------------
     205
     206To import synApps OPI screens as a project in CSS-BOY::
    185207
    186208        Menu "File"
    … …  
    194216
    195217
    196         You will also need to get the synApps project onto your OPI search path.  Here is how:
     218You will also need to get the synApps project onto your OPI search path.  Here is how::
    197219
    198220        Menu "CSS"
    … …  
    201223          open  "Display"
    202224          click on  "BOY"
    203           change text in entry box for "OPI Search Path" to this really long string (all one line)
    204 
    205           /synApps/areaDetector | /synApps/asyn | /synApps/autosave | /synApps/busy | /synApps/calc | /synApps/camac | /synApps/dac128V | /synApps/delaygen | /synApps/dxp | /synApps/iocStats | /synApps/ip | /synApps/ip330 | /synApps/ipUnidig | /synApps/love | /synApps/mca | /synApps/modbus | /synApps/motor | /synApps/optics | /synApps/quadEM | /synApps/softGlue | /synApps/sscan | /synApps/std | /synApps/vac | /synApps/vme | /synApps/xxx
    206 
    207         click "Ok" until you out of the dialogs.  Now the paths should work.
    208 
    209 
    210 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::
     225
     226Change the text in for "OPI Search Path" to this really long string (all one line)::
     227
     228                /synApps/areaDetector/ADApp/op/opi | /synApps/asyn/opi/boy | /synApps/autosave/asApp/op/opi | /synApps/busy/busyApp/op/opi | /synApps/calc/calcApp/op/opi | /synApps/camac/camacApp/op/opi | /synApps/dac128V/dac128VApp/op/opi | /synApps/delaygen/delaygenApp/op/opi | /synApps/dxp/dxpApp/op/opi | /synApps/iocStats/op/opi | /synApps/ip/ipApp/op/opi | /synApps/ip330/ip330App/op/opi | /synApps/ipUnidig/ipUnidigApp/op/opi | /synApps/love/loveApp/op/opi | /synApps/mca/mcaApp/op/opi | /synApps/modbus/modbusApp/op/opi | /synApps/motor/motorApp/op/opi | /synApps/optics/opticsApp/op/opi | /synApps/quadEM/quadEMApp/op/opi | /synApps/softGlue/softGlueApp/op/opi | /synApps/sscan/sscanApp/op/opi | /synApps/std/stdApp/op/opi | /synApps/vac/vacApp/op/opi | /synApps/vme/vmeApp/op/opi | /synApps/xxx/xxxApp/op/opi
     229
     230Keep clicking **Ok** until you dismiss all the dialogs.
     231Now the paths should work.
     232
     233        .. note:: From the CSS-BOY Help files:
     234       
     235                The path which is used to search OPI files if the given OPI path is a relative path
     236                and it doesn't exist on the made up absolute path neither.
     237                For example, you can put an OPI file name abc.opi or a relative path abc/def/my.opi
     238                for Open OPI Action, Top OPIs, Schema OPI and so on.
     239                If this OPI file cannot be found as a relative path to the OPI file, it will search the
     240                OPI Search Path and return the first one found on the search path.
     241                It supports workspace path, local file system path and URL path.
     242                The pathes are separated by the vetical bar delimiter ``|``.  For example::
     243               
     244                        /synApps/areaDetector/ADApp/op/opi | /synApps/asyn/opi/boy
     245
     246
     247
     248Calling the synApps OPI screens
     249-------------------------------------
     250
     251Also, when calling a synApps .opi screen from the instrument or beam line,
     252it is not necessary to use the full path since there is an OPI search path
     253that will locate the screen.  Example, instead of::
    211254
    212255   /synApps/motor/motorApp/op/opi/motor3x.opi
    213256
    214 you would just call::
     257Instead, you just call::
    215258
    216259   motor3x.opi
    217260
    218 
    219 Definitions
    220 -----------
     261.. note::  If you require a specific version of synApps, for example a specific older
     262                        version of areaDetector, create a separate CSS project for it in your
     263                        workspace.
     264
     265.. TODO: could use some instructions how to create this kind of project.  An example would help.
     266
     267
     268
     269Glossary of Terms
     270++++++++++++++++++++++++++++++++
    221271
    222272Some of the terms used by eclipse and CSS and CSS-BOY may be unfamiliar.
    223273
    224 ============  ==================================================================
    225 term
    226 ============  ==================================================================
    227 Workspace     file system directory containing directories
    228               and files used by a single CSS-BOY user
    229 Project       subdirectory within a ``workspace`` containing
    230               related files and subdirectories
    231 ``.js``       javascript file
    232 ``.opi``      display screen file used by CSS-BOY
    233 Perspective   Defined arrangement of Views and Editors in eclipse.
    234               A Perspective can be customized and saved within
    235               the Workspace for later recall.
    236 View          One type of display in eclipse, some can be undocked
    237               (or torn-off) so they can be a spearate window.
    238               ??? Are undocked Views saved as part of the
    239               Perspective? ???
    240 Editor        One type of display in eclipse.
    241 Navigator     Used to browse the Workspace for files and subdirectories.
    242 eclipse       Java-based software providing a configurable interactive
    243               development environment (IDE).  Eclipse can be highly
    244               customized to deliver a specific application,
    245               such as CSS or CSS-BOY.
    246 CSS           Control System Studio from DESY, based on eclipse
    247 CSS-BOY       CSS Best Opi Yet EPICS Display software (replacement for medm)
    248 ============  ==================================================================
    249 
    250 
    251 .. rubric:: The Glossary
    252 
    253274.. glossary::
    254 
    255 Workspace
    256         file system directory containing directories
    257         and files used by a single CSS-BOY user
    258 
    259 Project
    260         subdirectory within a ``workspace`` containing
    261         related files and subdirectories
    262275
    263276``.js``
    … …  
    266279``.opi``
    267280        display screen file used by CSS-BOY
     281
     282CSS
     283        Control System Studio [#css]_ from DESY, based on eclipse
     284
     285CSS-BOY
     286        CSS Best Opi Yet EPICS Display software (replacement for medm)
     287
     288eclipse
     289        Java-based software providing a configurable interactive
     290        development environment (IDE).  Eclipse [#eclipse]_ can be highly
     291        customized to deliver a specific application,
     292        such as CSS or CSS-BOY.
     293
     294Editor
     295        One type of display in eclipse.
     296
     297Navigator
     298        Used to browse the Workspace for files and subdirectories.
    268299
    269300Perspective   
    … …  
    272303        the Workspace for later recall.
    273304
     305Project
     306        subdirectory within a *workspace* containing
     307        related files and subdirectories
     308
    274309View
    275310        One type of display in eclipse, some can be undocked
    276311        (or torn-off) so they can be a spearate window.
    277         ??? Are undocked Views saved as part of the
    278         Perspective? ???
    279 
    280 Editor
    281         One type of display in eclipse.
    282 
    283 Navigator
    284         Used to browse the Workspace for files and subdirectories.
    285 
    286 eclipse
    287         Java-based software providing a configurable interactive
    288         development environment (IDE).  Eclipse can be highly
    289         customized to deliver a specific application,
    290         such as CSS or CSS-BOY.
    291 
    292 CSS
    293         Control System Studio from DESY, based on eclipse
    294 
    295 CSS-BOY
    296         CSS Best Opi Yet EPICS Display software (replacement for medm)
    297 
    298 
    299 --------------------
     312       
     313        ??? Are undocked Views saved as part of the Perspective? ???
     314
     315Workspace
     316        file system directory containing directories
     317        and files used by a single CSS-BOY user
     318
     319
    300320
    301321Footnotes
    302 ---------
     322++++++++++++++++++++++++++++++++
    303323
    304324.. [#eclipse]                   http://eclipse.org
Note: See TracChangeset for help on using the changeset viewer.