From: Grigory ZHIVOTOVSKY <gzy@salomex.nnov.opencascade.com>
Date: Fri, 17 Aug 2018 13:01:05 +0000 (+0300)
Subject: Create Build/Vertex help page
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=a8c336b065165d6a5307c237efbb0ccf5f21bac9;p=modules%2Fshaper.git

Create Build/Vertex help page
---

diff --git a/doc/gui/build_index.py b/doc/gui/build_index.py
old mode 100644
new mode 100755
diff --git a/doc/gui/index.rst.in b/doc/gui/index.rst.in
index fea7b2d6f..fefd59609 100644
--- a/doc/gui/index.rst.in
+++ b/doc/gui/index.rst.in
@@ -9,3 +9,5 @@ Welcome to SHAPER's documentation!
 .. toctree::
    :titlesonly:
    :maxdepth: 1
+
+  
diff --git a/src/IntroductionPlugin/doc/IntroductionPlugin.rst b/src/IntroductionPlugin/doc/IntroductionPlugin.rst
new file mode 100755
index 000000000..30e17a6b0
--- /dev/null
+++ b/src/IntroductionPlugin/doc/IntroductionPlugin.rst
@@ -0,0 +1,81 @@
+
+Introduction to SHAPER
+======================
+
+Application desktop
+-------------------
+
+The main window of the application consists of the following components:
+
+- :ref:`main_menu`
+- :ref:`doc_windows`
+- :ref:`viewer` 
+
+.. _main_menu:
+
+Main menu 
+---------
+
+Main menu provides access to all commands of the application.
+
+.. _doc_windows:
+
+Dock windows
+------------
+
+Standard dock windows are: 
+
+- :ref:`object_browser`
+- :ref:`inspection_panel`
+- :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  
+
+.. _object_browser: 
+
+Object browser 
+^^^^^^^^^^^^^^
+
+.. _property_panel:
+
+Property panel
+^^^^^^^^^^^^^^
+
+By default Property Panel is hidden, and it is shown on operation start.
+
+By default the Property Panel is shown at left side of the main window.
+
+If Object Browser is shown at the same side then they will be tabbed
+
+.. _inspection_panel: 
+
+Inspection panel 
+^^^^^^^^^^^^^^^^
+
+.. _python console:
+
+Python console
+^^^^^^^^^^^^^^
+
+.. _viewer:
+
+Viewer
+------
+
+The application  supports one OCC viewer and is able to show only one 3D space.
+
+This 3d space can be represented in several view windows.
+
+Each of view windows represents its own point of view on the 3d scene.
+
+This point of view can be modified by user with help of viewer commands like panning, zooming, scaling and so on.
+
+Architecture and functionality of viewer is very similar to OCCViewer component from SALOME. 
diff --git a/src/IntroductionPlugin/doc/index.rst_add.in b/src/IntroductionPlugin/doc/index.rst_add.in
new file mode 100755
index 000000000..15b9bc96a
--- /dev/null
+++ b/src/IntroductionPlugin/doc/index.rst_add.in
@@ -0,0 +1,56 @@
+The main window of the application consists of the following components:
+
+- :ref:`main_menu`
+
+.. _main_menu:
+
+Main menu 
+---------
+
+Main menu provides access to all commands of the application.
+
+
+Dock windows
+------------
+
+Standard dock windows are: 
+
+- :ref:`object_browser`
+- :ref:`inspection_panel`
+- :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 a one tab in main menu (see Figure 2) in order to make them more compact. 
+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
+.. _object_browser: 
+
+Object browser 
+^^^^^^^^^^^^^^
+
+.. _property_panel:
+
+Property panel
+^^^^^^^^^^^^^^
+
+By default Property Panel is hidden. It can be shown on operation start if XML description of this operation is not empty. By default the Property Panel is shown at left side. If Object Browser is shown at the same side then they will be tabbed 
+
+.. _inspection_panel: 
+
+Inspection panel 
+^^^^^^^^^^^^^^^^
+
+.. _python console:
+
+Python console
+^^^^^^^^^^^^^^
+
+
+It is supposed that the application only a one OCC viewer will support. It means that the application will be able to show only a one 3d space. This 3d space can be represented in several view windows. Each of view windows will represent its own point of view on the 3d scene. This point of view can be modified by user with help of viewer commands like panning, zooming, scaling and so on. 
+Architecture and functionality of viewer will be very similar to OCCViewer component from SALOME with modifications of view window look&feel.