From 40e154fdbde43f9b8b857c71cbf176c406a00fc2 Mon Sep 17 00:00:00 2001 From: =?utf8?q?C=C3=A9dric=20Aguerre?= Date: Tue, 14 Jun 2016 15:36:56 +0200 Subject: [PATCH] Fix minor typo: the correct variable name is SALOME_PLUGINS_PATH --- doc/salome/gui/input/using_pluginsmanager.doc | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/salome/gui/input/using_pluginsmanager.doc b/doc/salome/gui/input/using_pluginsmanager.doc index 65a76920d..fef46a05a 100644 --- a/doc/salome/gui/input/using_pluginsmanager.doc +++ b/doc/salome/gui/input/using_pluginsmanager.doc @@ -57,7 +57,7 @@ def myplugin2(context): salome_pluginsmanager.AddFunction('My plugin n°1', 'This action runs the plugin n°1', myplugin1) salome_pluginsmanager.AddFunction('My plugin n°2', 'This action runs the plugin n°2', myplugin2) ... -\endcode +\endcode The procedure is to define a function that implements the plugin, and to declare this function to the plugins manager. The implementation @@ -84,9 +84,9 @@ for plugins. The possible directories are (in search order): is the name of the module in low letters). -# The directory ~/.config/salome/Plugins for personnal end user plugins. --# Any path in the shell variable SALOME_PLUGIN_PATH (each path must be +-# Any path in the shell variable SALOME_PLUGINS_PATH (each path must be separated by a comma ":" for unix and ";" for windows). This - variable should be set and exported before running the SALOME application. + variable should be set and exported before running the SALOME application. \section S3_SALOMEPLUGINS A complete example @@ -95,7 +95,7 @@ your studies (a simple and standard SALOME script, that every end user is capable to write if he reads the documentation and follows the training course): -\code +\code # Intialize the geompy factory with the active study import salome import GEOM @@ -153,19 +153,19 @@ Sometimes it can be useful to retrieve an object of the object browser to perfor an action on it, for example, to select a mesh and display some information related to it. Some important methods and objects to use are as follows: --# context.sg.getObjectBrowser(): to connect the signal event - `selectionChanged()` to a custom slot +-# context.sg.getObjectBrowser(): to connect the signal event + `selectionChanged()` to a custom slot -# context.salome.sg.getAllSelected(): to get the list of selected object - in the object browser --# objId = context.salome.sg.getSelected(0): + in the object browser +-# objId = context.salome.sg.getSelected(0): to get the first selected object in the object browser -# salomeObj = context.salome.study.FindObjectID(objId).GetObject(): to retrieve the salome object from selection. It can be a GEOM, SMESH, or any - other module object. + other module object. If it is a mesh, then it is possible to call methods of the SMESH::SMESH_Mesh interface on the object, for example GetShapeToMesh(). - If it is not a mesh, this call will raise an exception. + If it is not a mesh, this call will raise an exception. So it is possible to write the code retrieving the shape a mesh is built on in the following way: \code mesh = None @@ -190,7 +190,7 @@ $GUI_ROOT_DIR/share/salome/plugins/gui/demo/salome_plugins.py and turn the variable DEMO_IS_ACTIVATED to True. The demo examples are: --# \b trihedron: create a trihedron and display it with fit on the size +-# \b trihedron: create a trihedron and display it with fit on the size -# \b tube_shapewithgui: create a geom object from parameters given by a dialog box. -# \b tube_meshwithgui: create a mesh object from parameters given by a @@ -201,7 +201,7 @@ The demo examples are: -# \b runSalomeShellSession: run a SALOME prepared shell session in a xterm. -# \b minmax: computes the min and max values of a control on a selected mesh. - \note This plugin is available in the SMESH module only. To activate it, edit + \note This plugin is available in the SMESH module only. To activate it, edit the file $GUI_ROOT_DIR/share/salome/plugins/gui/demo/smesh_plugins.py and turn the variable DEMO_IS_ACTIVATED to True. -- 2.39.2