From: Grigory ZHIVOTOVSKY Date: Wed, 12 Sep 2018 09:24:15 +0000 (+0300) Subject: Introduction help page updated, images moved to separate folder X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=3c83dd093e8688664b51b7708f61be6e17208403;p=modules%2Fshaper.git Introduction help page updated, images moved to separate folder --- diff --git a/doc/gui/CMakeLists.txt b/doc/gui/CMakeLists.txt index 40e5dd665..abdaa6c81 100644 --- a/doc/gui/CMakeLists.txt +++ b/doc/gui/CMakeLists.txt @@ -26,12 +26,14 @@ SET(DOC_FILES Introduction.rst ) -FILE( COPY ${DOC_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) - CONFIGURE_FILE(${input} ${output}) #sphinx-build -b html -c doc -D latex_paper_size=a4 -d doc/doctree /dn23/PPGP/vsv/SALOME730/SOURCES/PPGP_SRC/doc doc/html +INSTALL(FILES ${DOC_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) + +INSTALL(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/images DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) + INSTALL(CODE " EXECUTE_PROCESS( COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/build_index.py ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR} diff --git a/doc/gui/Introduction.rst b/doc/gui/Introduction.rst index fe2de0aae..1e7f32dfb 100644 --- a/doc/gui/Introduction.rst +++ b/doc/gui/Introduction.rst @@ -10,10 +10,18 @@ Application desktop The main window of the application consists of the following components: -- :ref:`main_menu` -- :ref:`doc_windows` -- :ref:`viewer` +- :ref:`main_menu`; +- :ref:`doc_windows`; +- :ref:`viewer`; +- status bar. +.. image:: images/main_window.png + :align: center + +.. centered:: + Main window of SHAPER module + + .. _main_menu: Main menu @@ -21,6 +29,34 @@ Main menu Main menu provides access to all commands of the application. +.. image:: images/main_menu.png + :align: center + +.. centered:: + Main menu + +Main menu includes standard Salome items: + +- File; +- Edit; +- View; +- Tools; +- Window; +- Help; + +and items specific for SHAPER module: + +- :ref:`partPlugin`; +- :ref:`sketchPlugin`; +- :ref:`constructionPlugin`; +- :ref:`buildPlugin`; +- :ref:`primitivesPlugin`; +- :ref:`gdmlPlugin`; +- :ref:`featuresPlugin`; +- :ref:`macrosPlugin`. + + + .. _doc_windows: Dock windows @@ -33,14 +69,19 @@ Standard dock windows are: - :ref:`python console` - :ref:`property_panel` - Dock windows can be placed in three dock areas: - left, - right, - bottom. -By default object browser window is placed at left area of the main window and Python console is placed as at bottom area of the main menu. -user can close any dock window. To open it again he can use a corresponded command from pop-up menu on static part of main menu +By default object browser window is placed at the left dock area, Inspection panel at the right dock area and Python console at the bottom dock area of the main window and Property Panel is hidden. + +The Property Panel is shown on operation start at left dock area of the main window by default. + +If Object Browser is shown at the same side then they will be tabbed. + +Each dock window can be closed and opened again using a corresponding command from View - Windows pop-up menu on static part of main menu :ref:`main_menu` + .. _object_browser: @@ -69,32 +110,32 @@ Property panel consists of two parts: - **Cancel/Close** calls **Abort operation** dialog box to confirm operation abort, - **Help** calls User's guide opened on page describing the current operation. -.. image:: button_ok.png +.. image:: images/button_ok.png :align: center .. centered:: **OK** button -.. image:: button_cancel.png +.. image:: images/button_cancel.png :align: center .. centered:: **Cancel** button -.. image:: button_help.png +.. image:: images/button_help.png :align: center .. centered:: **Help** button -.. image:: abort_operation.png +.. image:: images/abort_operation.png :align: center .. centered:: **Abort operation** dialog box - **OK** button is disabled if not all input parameters are defined or some errors are found. Error is shown as tooltip and in inspection panel. +**OK** button is disabled if not all input parameters are defined or some errors are found. Error is shown as tooltip and in status bar. .. _inspection_panel: diff --git a/doc/gui/abort_operation.png b/doc/gui/abort_operation.png deleted file mode 100755 index ad64065e7..000000000 Binary files a/doc/gui/abort_operation.png and /dev/null differ diff --git a/doc/gui/button_cancel.png b/doc/gui/button_cancel.png deleted file mode 100644 index 9af30a263..000000000 Binary files a/doc/gui/button_cancel.png and /dev/null differ diff --git a/doc/gui/button_help.png b/doc/gui/button_help.png deleted file mode 100644 index 1de706166..000000000 Binary files a/doc/gui/button_help.png and /dev/null differ diff --git a/doc/gui/button_ok.png b/doc/gui/button_ok.png deleted file mode 100644 index 029713818..000000000 Binary files a/doc/gui/button_ok.png and /dev/null differ diff --git a/doc/gui/images/abort_operation.png b/doc/gui/images/abort_operation.png new file mode 100755 index 000000000..ad64065e7 Binary files /dev/null and b/doc/gui/images/abort_operation.png differ diff --git a/doc/gui/images/button_cancel.png b/doc/gui/images/button_cancel.png new file mode 100644 index 000000000..9af30a263 Binary files /dev/null and b/doc/gui/images/button_cancel.png differ diff --git a/doc/gui/images/button_help.png b/doc/gui/images/button_help.png new file mode 100644 index 000000000..1de706166 Binary files /dev/null and b/doc/gui/images/button_help.png differ diff --git a/doc/gui/images/button_ok.png b/doc/gui/images/button_ok.png new file mode 100644 index 000000000..029713818 Binary files /dev/null and b/doc/gui/images/button_ok.png differ diff --git a/doc/gui/images/main_menu.png b/doc/gui/images/main_menu.png new file mode 100755 index 000000000..9898ca7ee Binary files /dev/null and b/doc/gui/images/main_menu.png differ diff --git a/doc/gui/images/main_window.png b/doc/gui/images/main_window.png new file mode 100755 index 000000000..c10cdd08d Binary files /dev/null and b/doc/gui/images/main_window.png differ diff --git a/doc/gui/new.txt b/doc/gui/new.txt deleted file mode 100755 index a9a7d5808..000000000 Binary files a/doc/gui/new.txt and /dev/null differ