Changeset 1062


Ignore:
Timestamp:
Aug 6, 2012 4:14:17 PM (11 years ago)
Author:
jemian
Message:

ready

Location:
cssboy_deployment/docs/source
Files:
2 deleted
3 edited

Legend:

Unmodified
Added
Removed
  • cssboy_deployment/docs/source/configure.rst

    r1061 r1062  
    2828===================================
    2929
    30 this work has not been done yet,
    31 the screens are not ready,
    32 the instructions are not ready
     30.. warning::  This section needs to be worked out.
     31
     32..
     33        this work has not been done yet,
     34        the screens are not ready,
     35        the instructions are not ready
    3336
    3437.. TODO
     
    7679
    7780
     81.. index::
     82        fonts.def
     83        color.def
     84
    7885synApps default fonts and colors
    7986===========================================================
     
    118125.. TODO
    119126        Do NOT forget to add the APS_sr screens, when they become available
     127
     128.. sidebar::  Recommendation
     129
     130        For starters, define the *OPI Search Path* :ref:`through the Preferences
     131        dialog <through.the.preferences.dialog>`.
     132        If you wish to define it in a text file, define it :ref:`in.the.workspace`.
    120133
    121134Because the many screens from synApps come on many subdirectory paths, a
     
    155168
    156169The *OPI Search Path* may be set by several ways:
     170
    157171* Preferences dialog
    158172* One of several configuration file possibilities.
    159173
    160174
     175.. index:: OPI Search Path; Preferences Dialog
     176.. _through.the.preferences.dialog:
    161177
    162178Setting ``opi_search_path`` from a Preferences Dialog
     
    207223                | /synApps/vme/vmeApp/op/opi/synApps/xxx/xxxApp/op/opi         
    208224
     225
     226
     227.. index:: OPI Search Path; Configuration File
     228
    209229Setting ``opi_search_path`` from a Configuration File
    210230-----------------------------------------------------
     
    216236From the ``plugin_customizations.ini`` file that comes with CSS-BOY, there are these notes:
    217237
    218 Fundamentally, the Eclipse preference mechanism works like this
    219 to allow customization at various levels:
    220 
    221 1. Each plugin might contain default settings that are hardcoded
    222    inside the Java sources of the plugin.
    223 2. In addition, each plugin might have a file preferences.ini
    224    in the root directory of the plugin directory or jar file.
    225    When present, those values override the hardcoded settings.
    226    Ideally, each plugin with preference settings has such a
    227    preferences.ini file to define the defaults because this
    228    provides a convenient place to locate all the available
    229    settings of a plugin in one file.
    230 3. A plugin_customization.ini file like this one, located
    231    in the root of the "Product" plugin directory or jar file
    232    can override all of the above.
    233    It is ideally used to provide site-specific defaults
    234    (as this one does for using CSS at the SNS).
    235 4. When starting CSS (or any Eclipse product), a customization file
    236    with the same format can be provided via the -pluginCustomization
    237    command line option to override settings.
    238    NOTE: Eclipse silently ignores missing customization files.
    239    THERE IS NO ERROR MESSAGE when the specified file does not exist!
    240 5. Finally, each end user can use the CSS/Preferences menu item to
    241    interactively adjust most settings. Those changes are stored in the
    242    workspace directory under::
    243    
    244        {Workspace}/.metadata/.plugins/org.eclipse.core.runtime/.settings
     238        Fundamentally, the Eclipse preference mechanism works like this
     239        to allow customization at various levels:
     240       
     241        1. Each plugin might contain default settings that are hardcoded
     242           inside the Java sources of the plugin.
     243        2. In addition, each plugin might have a file preferences.ini
     244           in the root directory of the plugin directory or jar file.
     245           When present, those values override the hardcoded settings.
     246           Ideally, each plugin with preference settings has such a
     247           preferences.ini file to define the defaults because this
     248           provides a convenient place to locate all the available
     249           settings of a plugin in one file.
     250        3. A plugin_customization.ini file like this one, located
     251           in the root of the "Product" plugin directory or jar file
     252           can override all of the above.
     253           It is ideally used to provide site-specific defaults
     254           (as this one does for using CSS at the SNS).
     255        4. When starting CSS (or any Eclipse product), a customization file
     256           with the same format can be provided via the -pluginCustomization
     257           command line option to override settings.
     258           NOTE: Eclipse silently ignores missing customization files.
     259           THERE IS NO ERROR MESSAGE when the specified file does not exist!
     260        5. Finally, each end user can use the CSS/Preferences menu item to
     261           interactively adjust most settings. Those changes are stored in the
     262           workspace directory under::
     263           
     264               {Workspace}/.metadata/.plugins/org.eclipse.core.runtime/.settings
    245265
    246266The default preferences can be set in ``plugin_customization.ini``
     
    260280 You can also give a different customization file with the command line option -pluginCustomization when starting CSS.
    261281
     282
     283.. index:: OPI Search Path; Configuration File in Workspace
     284
     285.. _in.the.workspace:
    262286
    263287in the Workspace
  • cssboy_deployment/docs/source/index.rst

    r1061 r1062  
    44===================================
    55
    6 Purpose
    7 ---------
    8 
     6.. rubric:: Purpose
    97
    108:index:`CSS` [#css]_ (Control System Studio) was designed at DESY, Hamburg, Germany. 
     
    1513The Spallation Neutron Source at Oak Ridge National Laboratory
    1614maintains and distributes a tool derived from CSS,
    17 :index:`CSS-BOY` (Best Opi Yet --
     15:index:`CSS-BOY` [#css_boy]_ (Best Opi Yet --
    1816where OPI is an EPICS term for Operator - Programmer Interface).
    1917CSS-BOY  is graphical-user interface software for EPICS.  Separate executables are
     
    3533
    3634.. toctree::
    37    :maxdepth: 2
     35   :maxdepth: 1
    3836   
    3937   layout
     
    6361
    6462.. [#css]       Control System Studio: http://css.desy.de
     63.. [#css_boy] CSS-Best Opi Yet: http://ics-web.sns.ornl.gov/css/products.html
    6564.. [#epics]     Experimental Physics and Industrial Control System: http://www.aps.anl.gov/epics
    6665.. [#medm] Motif-based Editing and Display Manager: http://www.aps.anl.gov/epics/extensions/medm/index.php
  • cssboy_deployment/docs/source/install.rst

    r1060 r1062  
    5353====================
    5454
    55 some users want to use this with CSS-BOY
     55.. warning::  This section needs to be worked out.
    5656
    57 http://subclipse.tigris.org/updates  /...
    58 
    59 Problems with getting the architecture and versions and other stuff just right
    60 
    61 Mac user still has problems.  Java-hl support.  Start with svn v1.6 and get both java tools, then upgrade "and pick the other tool." ...
    62 
    63 Mac users of Apple Firewall will be annoyed by a recurrent prompt.
    64 
    65 .. warning:  This needs to be worked out
     57..
     58        some users want to use this with CSS-BOY
     59       
     60        http://subclipse.tigris.org/updates  /...
     61       
     62        Problems with getting the architecture and versions and other stuff just right
     63       
     64        Mac user still has problems.  Java-hl support.  Start with svn v1.6 and get both java tools, then upgrade "and pick the other tool." ...
     65       
     66        Mac users of Apple Firewall will be annoyed by a recurrent prompt.
    6667
    6768:index:`synApps`
Note: See TracChangeset for help on using the changeset viewer.