From 5258625d18abf7c4bd2837a49fae016895b6fe07 Mon Sep 17 00:00:00 2001 From: dbv Date: Tue, 1 Mar 2016 11:04:47 +0300 Subject: [PATCH] Issue #317: Add Help Menu Moved technical documentation to tui sub-folder Added project for gui documentation --- CMakeLists.txt | 4 +++ doc/CMakeLists.txt | 24 ++---------------- doc/gui/CMakeLists.txt | 12 +++++++++ doc/gui/index.html | 1 + doc/tui/CMakeLists.txt | 24 ++++++++++++++++++ doc/{ => tui}/Modules.doc | 0 .../OpenParts/general_architecture.doc | 0 doc/{ => tui}/Shaper/general_architecture.doc | 0 doc/{ => tui}/doxyfile.in | 0 doc/{ => tui}/first_feature_help.doc | 0 doc/{ => tui}/general_architecture_1.png | Bin doc/{ => tui}/index.doc | 0 src/SHAPERGUI/CMakeLists.txt | 14 ++++++++-- .../{LightApp.xml => LightApp.xml.in} | 2 +- .../{SalomeApp.xml => SalomeApp.xml.in} | 4 +-- 15 files changed, 58 insertions(+), 27 deletions(-) create mode 100644 doc/gui/CMakeLists.txt create mode 100644 doc/gui/index.html create mode 100644 doc/tui/CMakeLists.txt rename doc/{ => tui}/Modules.doc (100%) rename doc/{ => tui}/OpenParts/general_architecture.doc (100%) rename doc/{ => tui}/Shaper/general_architecture.doc (100%) rename doc/{ => tui}/doxyfile.in (100%) rename doc/{ => tui}/first_feature_help.doc (100%) rename doc/{ => tui}/general_architecture_1.png (100%) rename doc/{ => tui}/index.doc (100%) rename src/SHAPERGUI/resources/{LightApp.xml => LightApp.xml.in} (96%) rename src/SHAPERGUI/resources/{SalomeApp.xml => SalomeApp.xml.in} (91%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 257524079..5658cf1f6 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -48,6 +48,8 @@ IF(${HAVE_SALOME}) SET(SHAPER_INSTALL_SWIG bin/salome CACHE INTERNAL "" FORCE) SET(SHAPER_INSTALL_QM_RESOURCES share/salome/resources/shaper CACHE INTERNAL "" FORCE) SET(SHAPER_INSTALL_XML_RESOURCES share/salome/resources/shaper CACHE INTERNAL "" FORCE) + SET(SHAPER_INSTALL_GUI_DOC share/doc/salome/gui/SHAPER CACHE INTERNAL "" FORCE) + SET(SHAPER_INSTALL_TUI_DOC share/doc/salome/tui/SHAPER CACHE INTERNAL "" FORCE) ELSE(${HAVE_SALOME}) SET(SHAPER_INSTALL_ADDONS addons CACHE INTERNAL "" FORCE) SET(SHAPER_INSTALL_BIN bin CACHE INTERNAL "" FORCE) @@ -58,6 +60,8 @@ ELSE(${HAVE_SALOME}) SET(SHAPER_INSTALL_SWIG swig CACHE INTERNAL "" FORCE) SET(SHAPER_INSTALL_QM_RESOURCES bin CACHE INTERNAL "" FORCE) SET(SHAPER_INSTALL_XML_RESOURCES plugins CACHE INTERNAL "" FORCE) + SET(SHAPER_INSTALL_GUI_DOC doc CACHE INTERNAL "" FORCE) + SET(SHAPER_INSTALL_TUI_DOC doc CACHE INTERNAL "" FORCE) ENDIF(${HAVE_SALOME}) #IF(CMAKE_BUILD_TYPE MATCHES Release) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 9cf05cb3f..9dadd55c2 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,24 +1,4 @@ # Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE -IF (WIN32) - FIND_PROGRAM(DOXYGEN_EXECUTABLE Doxygen) -ELSE (WIN32) - FIND_PROGRAM(DOXYGEN_EXECUTABLE doxygen) -ENDIF(WIN32) - -IF(HAVE_SALOME) - SET(EXCLUDE_DOC_DIR "*/AppElements/* */OpenParts/*") -ELSE(HAVE_SALOME) - SET(EXCLUDE_DOC_DIR "*/Shaper/*") -ENDIF(HAVE_SALOME) - -CONFIGURE_FILE(doxyfile.in - "${CMAKE_CURRENT_BINARY_DIR}/doxyfile" - IMMEDIATE @ONLY) - -ADD_CUSTOM_TARGET(INSTALL_DOCS - COMMAND "${DOXYGEN_EXECUTABLE}" - COMMAND "${CMAKE_COMMAND}" --build "${PROJECT_BINARY_DIR}" --target install --config ${CMAKE_BUILD_TYPE} - WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc" -) -INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tui DESTINATION doc OPTIONAL) +ADD_SUBDIRECTORY(gui) +ADD_SUBDIRECTORY(tui) diff --git a/doc/gui/CMakeLists.txt b/doc/gui/CMakeLists.txt new file mode 100644 index 000000000..d075f75e7 --- /dev/null +++ b/doc/gui/CMakeLists.txt @@ -0,0 +1,12 @@ +# Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE + +SET(HTML_RESOURCES + index.html +) + +ADD_CUSTOM_TARGET(INSTALL_GUI_DOCS + SOURCES ${HTML_RESOURCES} + COMMAND "${CMAKE_COMMAND}" --build "${PROJECT_BINARY_DIR}" --target install --config ${CMAKE_BUILD_TYPE} + WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc/gui" +) +INSTALL(FILES ${HTML_RESOURCES} DESTINATION ${SHAPER_INSTALL_GUI_DOC} OPTIONAL) diff --git a/doc/gui/index.html b/doc/gui/index.html new file mode 100644 index 000000000..a53e19f54 --- /dev/null +++ b/doc/gui/index.html @@ -0,0 +1 @@ +The documentation for the SHAPER module will come soon. \ No newline at end of file diff --git a/doc/tui/CMakeLists.txt b/doc/tui/CMakeLists.txt new file mode 100644 index 000000000..d5c50f223 --- /dev/null +++ b/doc/tui/CMakeLists.txt @@ -0,0 +1,24 @@ +# Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE + +IF (WIN32) + FIND_PROGRAM(DOXYGEN_EXECUTABLE Doxygen) +ELSE (WIN32) + FIND_PROGRAM(DOXYGEN_EXECUTABLE doxygen) +ENDIF(WIN32) + +IF(HAVE_SALOME) + SET(EXCLUDE_DOC_DIR "*/AppElements/* */OpenParts/*") +ELSE(HAVE_SALOME) + SET(EXCLUDE_DOC_DIR "*/Shaper/*") +ENDIF(HAVE_SALOME) + +CONFIGURE_FILE(doxyfile.in + "${CMAKE_CURRENT_BINARY_DIR}/doxyfile" + IMMEDIATE @ONLY) + +ADD_CUSTOM_TARGET(INSTALL_TUI_DOCS + COMMAND "${DOXYGEN_EXECUTABLE}" + COMMAND "${CMAKE_COMMAND}" --build "${PROJECT_BINARY_DIR}" --target install --config ${CMAKE_BUILD_TYPE} + WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/doc/tui" +) +INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tui/ DESTINATION ${SHAPER_INSTALL_TUI_DOC} OPTIONAL) diff --git a/doc/Modules.doc b/doc/tui/Modules.doc similarity index 100% rename from doc/Modules.doc rename to doc/tui/Modules.doc diff --git a/doc/OpenParts/general_architecture.doc b/doc/tui/OpenParts/general_architecture.doc similarity index 100% rename from doc/OpenParts/general_architecture.doc rename to doc/tui/OpenParts/general_architecture.doc diff --git a/doc/Shaper/general_architecture.doc b/doc/tui/Shaper/general_architecture.doc similarity index 100% rename from doc/Shaper/general_architecture.doc rename to doc/tui/Shaper/general_architecture.doc diff --git a/doc/doxyfile.in b/doc/tui/doxyfile.in similarity index 100% rename from doc/doxyfile.in rename to doc/tui/doxyfile.in diff --git a/doc/first_feature_help.doc b/doc/tui/first_feature_help.doc similarity index 100% rename from doc/first_feature_help.doc rename to doc/tui/first_feature_help.doc diff --git a/doc/general_architecture_1.png b/doc/tui/general_architecture_1.png similarity index 100% rename from doc/general_architecture_1.png rename to doc/tui/general_architecture_1.png diff --git a/doc/index.doc b/doc/tui/index.doc similarity index 100% rename from doc/index.doc rename to doc/tui/index.doc diff --git a/src/SHAPERGUI/CMakeLists.txt b/src/SHAPERGUI/CMakeLists.txt index a70ef0845..a7546df0b 100644 --- a/src/SHAPERGUI/CMakeLists.txt +++ b/src/SHAPERGUI/CMakeLists.txt @@ -25,8 +25,8 @@ SET(PROJECT_SOURCES ) SET(PROJECT_RESOURCES - resources/LightApp.xml - resources/SalomeApp.xml + ${CMAKE_CURRENT_BINARY_DIR}/LightApp.xml + ${CMAKE_CURRENT_BINARY_DIR}/SalomeApp.xml resources/shaper.png ) @@ -68,5 +68,15 @@ ADD_DEPENDENCIES(SHAPER XGUI) # The Qt5Widgets_LIBRARIES variable also includes QtGui and QtCore TARGET_LINK_LIBRARIES(SHAPER ${PROJECT_LIBRARIES}) +# configuration +CONFIGURE_FILE( + "${CMAKE_CURRENT_SOURCE_DIR}/resources/LightApp.xml.in" + "${CMAKE_CURRENT_BINARY_DIR}/LightApp.xml" + ) +CONFIGURE_FILE( + "${CMAKE_CURRENT_SOURCE_DIR}/resources/SalomeApp.xml.in" + "${CMAKE_CURRENT_BINARY_DIR}/SalomeApp.xml" + ) + INSTALL(TARGETS SHAPER DESTINATION ${SHAPER_INSTALL_BIN}) INSTALL(FILES ${PROJECT_RESOURCES} DESTINATION ${SHAPER_INSTALL_RESOURCES}) diff --git a/src/SHAPERGUI/resources/LightApp.xml b/src/SHAPERGUI/resources/LightApp.xml.in similarity index 96% rename from src/SHAPERGUI/resources/LightApp.xml rename to src/SHAPERGUI/resources/LightApp.xml.in index 4fc4cc72a..2869cf359 100644 --- a/src/SHAPERGUI/resources/LightApp.xml +++ b/src/SHAPERGUI/resources/LightApp.xml.in @@ -23,7 +23,7 @@ - +
diff --git a/src/SHAPERGUI/resources/SalomeApp.xml b/src/SHAPERGUI/resources/SalomeApp.xml.in similarity index 91% rename from src/SHAPERGUI/resources/SalomeApp.xml rename to src/SHAPERGUI/resources/SalomeApp.xml.in index cef46113b..ef7b146bd 100644 --- a/src/SHAPERGUI/resources/SalomeApp.xml +++ b/src/SHAPERGUI/resources/SalomeApp.xml.in @@ -27,7 +27,7 @@ - +
@@ -38,6 +38,6 @@
- +
-- 2.39.2