]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Introduction help page updated, images moved to separate folder
authorGrigory ZHIVOTOVSKY <gzy@salomex.nnov.opencascade.com>
Wed, 12 Sep 2018 09:24:15 +0000 (12:24 +0300)
committerGrigory ZHIVOTOVSKY <gzy@salomex.nnov.opencascade.com>
Wed, 12 Sep 2018 09:24:15 +0000 (12:24 +0300)
13 files changed:
doc/gui/CMakeLists.txt
doc/gui/Introduction.rst
doc/gui/abort_operation.png [deleted file]
doc/gui/button_cancel.png [deleted file]
doc/gui/button_help.png [deleted file]
doc/gui/button_ok.png [deleted file]
doc/gui/images/abort_operation.png [new file with mode: 0755]
doc/gui/images/button_cancel.png [new file with mode: 0644]
doc/gui/images/button_help.png [new file with mode: 0644]
doc/gui/images/button_ok.png [new file with mode: 0644]
doc/gui/images/main_menu.png [new file with mode: 0755]
doc/gui/images/main_window.png [new file with mode: 0755]
doc/gui/new.txt [deleted file]

index 40e5dd6656b92e4498e41420d613b9ce02a1f829..abdaa6c81af9f48695a5b95037bba3adcfa29d2c 100644 (file)
@@ -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}
index fe2de0aaeba945c742f2d89b360758b97140e1b2..1e7f32dfb1993540d619dbf4118191e028f8f17a 100644 (file)
@@ -10,10 +10,18 @@ Application desktop
 \r
 The main window of the application consists of the following components:\r
 \r
-- :ref:`main_menu`\r
-- :ref:`doc_windows`\r
-- :ref:`viewer` \r
+- :ref:`main_menu`;\r
+- :ref:`doc_windows`;\r
+- :ref:`viewer`;\r
+- status bar.    \r
 \r
+.. image:: images/main_window.png\r
+   :align: center\r
+\r
+.. centered::\r
+   Main window of SHAPER module\r
+\r
+  \r
 .. _main_menu:\r
 \r
 Main menu \r
@@ -21,6 +29,34 @@ Main menu
 \r
 Main menu provides access to all commands of the application.\r
 \r
+.. image:: images/main_menu.png\r
+   :align: center\r
+\r
+.. centered::\r
+   Main menu\r
+\r
+Main menu includes standard Salome items:\r
+\r
+- File;\r
+- Edit;\r
+- View;\r
+- Tools;   \r
+- Window;\r
+- Help;\r
+    \r
+and items specific for SHAPER module:\r
+\r
+- :ref:`partPlugin`;\r
+- :ref:`sketchPlugin`;\r
+- :ref:`constructionPlugin`;\r
+- :ref:`buildPlugin`;\r
+- :ref:`primitivesPlugin`;\r
+- :ref:`gdmlPlugin`;\r
+- :ref:`featuresPlugin`;  \r
+- :ref:`macrosPlugin`. \r
+\r
+\r
+  \r
 .. _doc_windows:\r
 \r
 Dock windows\r
@@ -33,14 +69,19 @@ Standard dock windows are:
 - :ref:`python console`\r
 - :ref:`property_panel`\r
 \r
-\r
 Dock windows can be placed in three dock areas:\r
 - left, \r
 - right, \r
 - bottom.\r
 \r
-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. \r
-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  \r
+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.\r
+\r
+The Property Panel is shown on operation start at left dock area of the main window by default.\r
+\r
+If Object Browser is shown at the same side then they will be tabbed.\r
+\r
+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`\r
+\r
 \r
 .. _object_browser: \r
 \r
@@ -69,32 +110,32 @@ Property panel consists of two parts:
   - **Cancel/Close** calls **Abort operation** dialog box to confirm  operation abort,\r
   - **Help** calls User's guide opened on page describing the current operation.\r
 \r
-.. image:: button_ok.png\r
+.. image:: images/button_ok.png\r
    :align: center\r
 \r
 .. centered::\r
    **OK**  button\r
 \r
-.. image:: button_cancel.png\r
+.. image:: images/button_cancel.png\r
    :align: center\r
 \r
 .. centered::\r
    **Cancel**  button\r
 \r
-.. image:: button_help.png\r
+.. image:: images/button_help.png\r
    :align: center\r
 \r
 .. centered::\r
    **Help**  button\r
 \r
-.. image:: abort_operation.png\r
+.. image:: images/abort_operation.png\r
    :align: center\r
 \r
 .. centered::\r
    **Abort operation** dialog box\r
 \r
 \r
- **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.\r
+**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.\r
 \r
 .. _inspection_panel: \r
 \r
diff --git a/doc/gui/abort_operation.png b/doc/gui/abort_operation.png
deleted file mode 100755 (executable)
index ad64065..0000000
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 (file)
index 9af30a2..0000000
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 (file)
index 1de7061..0000000
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 (file)
index 0297138..0000000
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 (executable)
index 0000000..ad64065
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 (file)
index 0000000..9af30a2
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 (file)
index 0000000..1de7061
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 (file)
index 0000000..0297138
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 (executable)
index 0000000..9898ca7
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 (executable)
index 0000000..c10cdd0
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 (executable)
index a9a7d58..0000000
Binary files a/doc/gui/new.txt and /dev/null differ