X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=doc%2Fsalome%2Fkernel_salome.dox;h=75deb29601f9bc856fb4ab1e3c527b170772f237;hb=e63d2a70e527b5911284cde1c19e03f077b10954;hp=20acf889c514775993c6bb4c559bad28208341d9;hpb=288dc1c84630e521220d796b7c88c518f34856d5;p=modules%2Fkernel.git

diff --git a/doc/salome/kernel_salome.dox b/doc/salome/kernel_salome.dox
index 20acf889c..75deb2960 100644
--- a/doc/salome/kernel_salome.dox
+++ b/doc/salome/kernel_salome.dox
@@ -3,6 +3,18 @@
 \page kernel_salome Using salome.py module
 
 
+The Python module salome.py provides a functionality to access main
+SALOME features from the Python console (either embedded in GUI
+desktop or external one).
+
+To use salome.py module, import it into the Python interpreter and
+initialize it by calling \c salome_init() function:
+
+\code
+import salome
+salome.salome_init()
+\endcode
+
 The salome.py Python module provides a set of variables and functions
 allowing access to different elements of the current SALOME
 session.
@@ -100,6 +112,7 @@ study = salome.myStudyManager.GetStudyByName("/home/user/MyStudy.hdf")
 # ...
 \endcode
 
+\anchor salome_myStudy
 \li \b myStudy Reference to the current (active) study
 
 This variable can be used to manipulate with the date of the study:
@@ -284,13 +297,37 @@ name_1 = salome.generateName() # name_1 is something like "Study682"
 name_1 = salome.generateName("Obj") # name_1 is something like "Obj32"
 \endcode
 
-\li \b sg SWIG interface to the SALOME GUI
+\li \b GetComponentVersion() Get version of component data stored in
+the study
 
-This variable provides an access to some GUI functions.
+This function allows to obtain the version of the component data
+stored in the current study.
+\note This function does not provide a current version of the
+component being used but that one initially stored in the study
+document.
+
+The first parameter specifies the name of the component. If the
+specified component data is not stored in the study, the result value
+is "no component data". If the version of data is undefined, the
+result is "unknown".
+
+The second parameter (\c False by default), when set to \c True,
+allows to retrieve all versions of the component data stored in the
+study. This is useful to check if version information is valid (the
+data might be updated and/or re-stored in %SALOME of versions different
+from initial one). 
+
+\code
+# get initial version of GEOM module data stored in the study
+geom_version = salome.GetComponentVersion('GEOM')
+# get all versions of GEOM module data stored in the study
+all_geom_versions = salome.GetComponentVersion('GEOM', True)
+\endcode
 
-\b Note, that this variable is only available if you use salome.py
-Python module within the GUI desktop (since SWIG library is linked directly to the GUI library).
-See GUI documentation for more information.
+This function is introduced in %SALOME 6.6.0 (it does not work with
+studies created before version 6.6.0).
 
+\note The study should be initialized before calling this function
+(see \ref salome_myStudy "salome.myStudy").
 
 */