From: CEA Support SALOME Date: Mon, 5 Jan 2015 15:17:23 +0000 (+0100) Subject: Script, template and documentation for the generation of default profile X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=2f654f9e46404557200ea9adb0f8947de3cdadf8;p=modules%2Fkernel.git Script, template and documentation for the generation of default profile --- diff --git a/doc/salome/main.dox b/doc/salome/main.dox index a0b26f7f7..8dcfc33df 100644 --- a/doc/salome/main.dox +++ b/doc/salome/main.dox @@ -16,9 +16,9 @@ introductory documentation, listed below. See \subpage SALOME_Application to define your own configuration of %SALOME and run it on one or several computers. This is the recommended way of configuration. -# How to launch %SALOME: - - Using \b NEW \subpage salome_command, based on \ref SALOME_Application. - - In a %SALOME application, see \ref SALOME_Application. - - Using \c runSalome script, see \subpage running_salome_page + - Using a python launcher like the \subpage salome_command. + - Deprecated: Using the shell launchers (runAppli, runSession, runConsole...) alongside configuration files (*.cfg or *.sh), + - Deprecated: Using \c runSalome script, see \subpage running_salome_page -# How to use KERNEL services in Python scripts\n The %SALOME KERNEL offers a list of services available in Python. See \subpage KERNEL_Services. -# How to use KERNEL services from a C++ context\n diff --git a/doc/salome/running_salome.dox b/doc/salome/running_salome.dox index cf1a9ab70..32cf2e8a7 100644 --- a/doc/salome/running_salome.dox +++ b/doc/salome/running_salome.dox @@ -4,11 +4,15 @@ There are two ways to run %SALOME: -1) Using Salome Application Concept approach. +1) Using a python launcher. + +For more details see \ref salome_command. + +2) Deprecated : Using shell launchers. For more details see \ref SALOME_Application. -2) Using \c %runSalome script supplied with %SALOME KERNEL module distribution. +3) Deprecated : Using \c %runSalome script supplied with %SALOME KERNEL module distribution. To launch %SALOME using \c %runSalome script, you have first to set-up proper environment for %SALOME. If you installed %SALOME using diff --git a/doc/salome/salome_application.dox b/doc/salome/salome_application.dox index e91b71e11..bd79433d9 100644 --- a/doc/salome/salome_application.dox +++ b/doc/salome/salome_application.dox @@ -7,11 +7,11 @@ modules, how to define and run this application on one or more computers. \section S1_sal_appl General principles -%A %SALOME application is defined by a set of modules (GEOM, SMESH, ASTER...). %A %SALOME application -lives in an application directory. -%A %SALOME application is a virtual installation of %SALOME in the application directory -(bin, lib, doc, share...), with, for each file (executable, script, data, -library, resources...), symbolic links to the actual files. +%A %SALOME application is defined by : +- a set of modules (GEOM, SMESH, ASTER...) +- a profile: set of informatic resources (images, documentation, tests...) binding the modules together. +- a launcher: python script that creates a context (set of environment variables usable by the SALOME modules) and runs an instance of SALOME. + %A %SALOME User can define several %SALOME Applications. These applications are runnable from the same user account. These applications may share the same @@ -40,7 +40,27 @@ account@computer is via rsh or ssh and must be configured for use without password (key exchange for ssh). Account may be different on each computer. -\section S2_sal_appl Application Directory +\section S2_sal_appl Generation of a profile + +The user can generate a default profile for its application using the following command: +\code +python ${KERNEL_ROOT_DIR}/bin/salome/app-quickstart.py --prefix= --name= --modules= +\endcode + +Likely, the user would like to personalize its application's profile. Then, the profile +can be compiled using the standard cmake procedure: + +\code +cmake +make +make install +\endcode + +This profile can be used within a python launcher - like the \subpage salome_command - by setting +context variable SalomeAppConfig to the path where the profile is installed. + + +\section S3_sal_appl Deprecated Application Directory First, the user must create a %SALOME application configuration file by modifying a copy of ${KERNEL_ROOT_DIR}/bin/salome/config_appli.xml. @@ -67,7 +87,7 @@ some modules needs a special environment not defined in the above script). For a distributed application (several computers), one must copy and adapt CatalogResources.xml from ${KERNEL_ROOT_DIR}/bin/salome/appliskel (see below). -\section S3_sal_appl General rules +\section S4_sal_appl Deprecated general rules The application directory must be created on each computer of the application. The easiest way is to use the same relative path (to ${HOME}) on each computer. @@ -152,7 +172,7 @@ appliPath="my/specific/path/on/this/computer" -\section S4_sal_appl Examples of use +\section S5_sal_appl Deprecated examples of use
  1. diff --git a/src/AppQuickStart/CMakeLists.txt b/src/AppQuickStart/CMakeLists.txt new file mode 100644 index 000000000..07e7a0645 --- /dev/null +++ b/src/AppQuickStart/CMakeLists.txt @@ -0,0 +1,33 @@ +# Copyright (C) 2012-2014 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +ADD_SUBDIRECTORY( ressources ) + +# =============================================================== +# Files to be installed +# =============================================================== + +# These files are executable scripts +SET(SCRIPTS + app-quickstart.py +) + +SALOME_INSTALL_SCRIPTS("${SCRIPTS}" ${SALOME_INSTALL_SCRIPT_SCRIPTS}) + +INSTALL( DIRECTORY app-template DESTINATION ${SALOME_KERNEL_INSTALL_RES_DATA}) diff --git a/src/AppQuickStart/app-quickstart.py b/src/AppQuickStart/app-quickstart.py new file mode 100755 index 000000000..8567a67aa --- /dev/null +++ b/src/AppQuickStart/app-quickstart.py @@ -0,0 +1,268 @@ +#! /usr/bin/env python +# -*- coding: iso-8859-1 -*- +# Copyright (C) 2007-2014 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +import os +import shutil +import optparse + +# Options of this script +def profileQuickStartParser() : + + parser = optparse.OptionParser( usage = "usage: python app-quickstart.py [options]" ) + + parser.add_option('-p', + "--prefix", + metavar="", + type="string", + action="store", + dest="prefix", + default='.', + help="Where the application's sources will be generated. [Default : '.']") + + parser.add_option('-m', + "--modules", + metavar="", + type="string", + action="store", + dest="modules", + default='KERNEL,GUI', + help="List of the application's modules. [Default : KERNEL,GUI]") + + parser.add_option('-n', + "--name", + type="string", + action="store", + dest="name", + help="Name of the application") + + parser.add_option('-v', + "--version", + type="string", + action="store", + dest="version", + default='1.0', + help="Version of the application. [Default : 1.0]") + + parser.add_option('-s', + "--slogan", + type="string", + action="store", + dest="slogan", + default='', + help="Slogan of the application.") + + parser.add_option('-f', + "--force", + action="store_true", + dest="force", + help="Overwrites existing sources") + + return parser + + + +#Create the splash screen +def profileGenerateSplash( resources_dir, appname, version, subtext ): + import Image + import ImageDraw + import ImageFont + + uname = unicode(appname, 'UTF-8') + uversion = unicode(version, 'UTF-8') + + # fonts + fontbig = ImageFont.truetype( os.path.join( resources_dir, 'Anita semi square.ttf' ), 64) + fontsmall = ImageFont.truetype( os.path.join( resources_dir, 'Anita semi square.ttf' ), 20) + textColor = "rgb(255, 250, 250)" + shadowColor = "rgb(0, 0, 0)" + + # dimensions + nbcar = len(uname) + width = 600 + if nbcar > 12: + width = min( width*nbcar/12, 1024) #a little more + height = 300 + borderX = 30 #50 + borderY = 3 #30 + shadowX = 2 + shadowY = shadowX + + # load background image + f0 = os.path.join( resources_dir, "background.png" ) + im = Image.open(f0) + im = im.resize( ( width, height ) ) + draw = ImageDraw.Draw(im) + + # add the name of the application + iw, ih = draw.textsize(uname, font=fontbig) + x = (width - iw) / 2.0 # horizontal center + y = (height - ih) / 2.0 # vertical center + draw.text((x+shadowX, y+shadowY), uname, font=fontbig, fill=shadowColor) + draw.text((x, y), uname, font=fontbig, fill=textColor) + + # add subtext + if len(subtext) > 0: + iw, ih = draw.textsize(subtext, font=fontsmall) + draw.text((borderX+shadowX, height+shadowY-borderY-ih), + subtext, font=fontsmall, fill=shadowColor) + draw.text((borderX, height-borderY-ih), + subtext, font=fontsmall, fill=textColor) + + # add the version if any + if len(version) > 0: + iw, ih = draw.textsize(uversion, font=fontsmall) + draw.text((width+shadowX-borderX-iw, height+shadowY-borderY-ih), + uversion, font=fontsmall, fill=shadowColor) + draw.text((width-borderX-iw, height-borderY-ih), + uversion, font=fontsmall, fill=textColor) + + del draw + return im + + +#Create the application logo +def profileGenerateLogo( appname, font ): + import Image + import ImageDraw + + uname = unicode(appname, 'UTF-8') + + # evaluate size before deleting draw + im = Image.new( "RGBA", (1, 1), (0, 0, 0, 0) ) + draw = ImageDraw.Draw( im ) + + im = Image.new( "RGBA", draw.textsize( uname, font=font ), (0, 0, 0, 0) ) + draw = ImageDraw.Draw(im) + draw.text( (0+1, 0), uname, font=font, fill="rgb(0, 0, 0)" ) + draw.text( (0, -1), uname, font=font, fill="rgb(191, 191, 191)" ) + + del draw + return im + + +#Replace strings in the template +def profileReplaceStrings( src, dst, options ) : + with open( dst, "wt" ) as fout: + with open( src, "rt" ) as fin: + for line in fin: + l = line.replace( '[LIST_OF_MODULES]', options.modules ) + l = l.replace( '[VERSION]', options.version ) + l = l.replace( '[SLOGAN]', options.slogan ) + l = l.replace( '[NAME_OF_APPLICATION]', options.name.upper() ) + l = l.replace( '', options.name ) + l = l.replace( '(name_of_application)', options.name.lower() ) + fout.write( l ) + + +#Generation of a template profile sources +def profileGenerateSources( options, args ) : + + #Set name of several directories + app_dir = options.prefix + app_resources_dir = os.path.join( app_dir, "resources" ) + kernel_root_dir = os.environ["KERNEL_ROOT_DIR"] + bin_salome_dir = os.path.join( kernel_root_dir, "bin", "salome" ) + kernel_resources_dir = os.path.join( kernel_root_dir, "share", "salome", "resources", "kernel" ) + template_dir = os.path.join( kernel_resources_dir, "app-template" ) + + #Check if the directory of the sources already exists and delete it + if os.path.exists( app_dir ) : + if not options.force : + print "Directory %s already exists." %app_dir + print "Use option --force to overwrite it." + return + else : + shutil.rmtree( app_dir ) + + #Copy template directory + os.mkdir( app_dir ) + for root, dirs, files in os.walk( template_dir ) : + dst_dir = root.replace( template_dir, app_dir ) + for d in dirs : + os.mkdir( os.path.join( dst_dir, d ) ) + for f in files : + profileReplaceStrings( os.path.join( root, f ), os.path.join( dst_dir, f ), options ) + + #Complete source directory + contextFiles = [ "salomeContext.py", "salomeContextUtils.py", "parseConfigFile.py" ] + for f in contextFiles : + shutil.copy( os.path.join( bin_salome_dir, f ), os.path.join( app_dir, "src" ) ) + + #Search for python modules Image, ImageDraw and ImageFont + try: + import imp + imp.find_module('Image') + imp.find_module('ImageDraw') + imp.find_module('ImageFont') + found = True + except ImportError: + found = False + + #Generate logo and splash + logo_destination = os.path.join( app_resources_dir, 'app_logo.png') + splash_destination = os.path.join( app_resources_dir, 'splash.png') + about_destination = os.path.join( app_resources_dir, 'about.png') + if found : + import ImageFont + font = ImageFont.truetype( os.path.join( kernel_resources_dir, "Anita semi square.ttf" ) , 18 ) + + #Generate and save logo + app_logo = profileGenerateLogo( options.name, font ) + app_logo.save( logo_destination, "PNG" ) + + #Generate and splash screen and about image + if options.slogan : + subtext = options.slogan + else : + subtext = "Powered by SALOME" + im = profileGenerateSplash( kernel_resources_dir, options.name, options.version, subtext ) + im.save( splash_destination, "PNG" ) + im.save( about_destination, "PNG" ) + else : + gui_resources_dir = os.path.join( os.environ["GUI_ROOT_DIR"], "share", "salome", "resources", "gui" ) + logo_name = os.path.join( gui_resources_dir, "icon_applogo.png" ) + if os.path.exists( logo_name ) : + shutil.copy( logo_name, logo_destination ) + about_name = os.path.join( gui_resources_dir, "icon_about.png" ) + if os.path.exists( about_name ) : + shutil.copy( about_name, about_destination ) + shutil.copy( about_name, splash_destination ) + + #End of script + print "Sources of %s were generated in %s." %( options.name, app_dir ) + + +# ----------------------------------------------------------------------------- + +if __name__ == '__main__': + #Get options and args + (options, args) = profileQuickStartParser().parse_args() + + #Check name of the application + if not options.name : + raise RuntimeError( "A name must be given to the application. Please use option --name." ) + + #Check if the prefix's parent is a directory + if not os.path.isdir( os.path.dirname( options.prefix ) ) : + raise RuntimeError( "%s is not a directory." % os.path.dirname( options.prefix ) ) + + #Generate sources of the profile + profileGenerateSources( options, args ) diff --git a/src/AppQuickStart/app-template/CMakeLists.txt b/src/AppQuickStart/app-template/CMakeLists.txt new file mode 100644 index 000000000..ba99abf4e --- /dev/null +++ b/src/AppQuickStart/app-template/CMakeLists.txt @@ -0,0 +1,110 @@ +# Copyright (C) 2012-2014 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# +CMAKE_MINIMUM_REQUIRED(VERSION 2.8.8 FATAL_ERROR) +PROJECT(Salome__Profile C CXX) + +# Ensure a proper linker behavior: +CMAKE_POLICY(SET CMP0003 NEW) + +# Versioning +# =========== +# Project name, upper case +STRING(TOUPPER ${PROJECT_NAME} PROJECT_NAME_UC) + +SET(${PROJECT_NAME_UC}_MAJOR_VERSION 0) +SET(${PROJECT_NAME_UC}_MINOR_VERSION 0) +SET(${PROJECT_NAME_UC}_PATCH_VERSION 0) +SET(${PROJECT_NAME_UC}_VERSION + ${${PROJECT_NAME_UC}_MAJOR_VERSION}.${${PROJECT_NAME_UC}_MINOR_VERSION}.${${PROJECT_NAME_UC}_PATCH_VERSION}) + +# Find KERNEL +# =========== +SET(KERNEL_ROOT_DIR $ENV{KERNEL_ROOT_DIR} CACHE PATH "Path to the Salome KERNEL") +IF(EXISTS ${KERNEL_ROOT_DIR}) + LIST(APPEND CMAKE_MODULE_PATH "${KERNEL_ROOT_DIR}/salome_adm/cmake_files") + INCLUDE(SalomeMacros) + FIND_PACKAGE(SalomeKERNEL REQUIRED) + KERNEL_WITH_CORBA() # check whether KERNEL builded with CORBA +ELSE(EXISTS ${KERNEL_ROOT_DIR}) + MESSAGE(FATAL_ERROR "We absolutely need a Salome KERNEL, please define KERNEL_ROOT_DIR") +ENDIF(EXISTS ${KERNEL_ROOT_DIR}) + +# User options +# ============ +OPTION(SALOME_BUILD_TESTS "Build SALOME tests" ON) +OPTION(SALOME_BUILD_DOC "Generate SALOME documentation" ON) + +IF(SALOME_BUILD_TESTS) + ENABLE_TESTING() +ENDIF() + +# KERNEL optionals: +IF(SALOME_BUILD_DOC) + FIND_PACKAGE(SalomePython) + FIND_PACKAGE(SalomeSphinx) + SALOME_LOG_OPTIONAL_PACKAGE(Sphinx SALOME_BUILD_DOC) +ENDIF() + + +# Find GUI +# =========== + +SET(GUI_ROOT_DIR $ENV{GUI_ROOT_DIR} CACHE PATH "Path to the Salome GUI") +IF(EXISTS ${GUI_ROOT_DIR}) + LIST(APPEND CMAKE_MODULE_PATH "${GUI_ROOT_DIR}/adm_local/cmake_files") + FIND_PACKAGE(SalomeGUI REQUIRED) + FULL_GUI(TRUE) # check whether GUI builded in full mode and with CORBA + ADD_DEFINITIONS(${GUI_DEFINITIONS}) + INCLUDE_DIRECTORIES(${GUI_INCLUDE_DIRS}) +ELSE(EXISTS ${GUI_ROOT_DIR}) + MESSAGE(FATAL_ERROR "We absolutely need a Salome GUI, please define GUI_ROOT_DIR") +ENDIF(EXISTS ${GUI_ROOT_DIR}) + +# Qt4 +FIND_PACKAGE(SalomeQt4 REQUIRED COMPONENTS QtCore QtGui) +INCLUDE(${QT_USE_FILE}) + +# Directories +# (default values taken from KERNEL) +# =========== +SET(SALOME_INSTALL_SCRIPT_PYTHON "${SALOME_INSTALL_SCRIPT_PYTHON}" CACHE PATH "Install path: SALOME Python scripts") + +# Specific to [NAME_OF_APPLICATION]: +SET(SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_RES_DATA "${SALOME_INSTALL_RES}/(name_of_application)_profile" CACHE PATH "Install path: SALOME [NAME_OF_APPLICATION] specific data") +SET(SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_DOC_GUI "${SALOME_INSTALL_DOC}/gui/${PROJECT_NAME_UC}" CACHE PATH "Install path: SALOME [NAME_OF_APPLICATION] gui documentation") +SET(SALOME_[NAME_OF_APPLICATION]_PROFILE_HTML_STATIC_PATH "${SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_DOC_GUI}/_static" CACHE PATH "Install path: SALOME [NAME_OF_APPLICATION] html static data") + +MARK_AS_ADVANCED(SALOME_INSTALL_SCRIPT_PYTHON) + +INSTALL(CODE "FILE(MAKE_DIRECTORY ${CMAKE_INSTALL_PREFIX}/USERS)") + +# Sources +# ======== +ADD_SUBDIRECTORY( src ) +ADD_SUBDIRECTORY( resources ) +ADD_SUBDIRECTORY( doc ) + +# Additional files +# ================ +SET(_salome_context_API_SCRIPTS + ${KERNEL_ROOT_DIR}/bin/salome/salomeContext.py + ${KERNEL_ROOT_DIR}/bin/salome/salomeContextUtils.py + ${KERNEL_ROOT_DIR}/bin/salome/parseConfigFile.py +) +SALOME_INSTALL_SCRIPTS("${_salome_context_API_SCRIPTS}" ${SALOME_INSTALL_SCRIPT_PYTHON}) diff --git a/src/AppQuickStart/app-template/LICENCE b/src/AppQuickStart/app-template/LICENCE new file mode 100644 index 000000000..b1e3f5a26 --- /dev/null +++ b/src/AppQuickStart/app-template/LICENCE @@ -0,0 +1,504 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/src/AppQuickStart/app-template/README b/src/AppQuickStart/app-template/README new file mode 100644 index 000000000..e69de29bb diff --git a/src/AppQuickStart/app-template/doc/CMakeLists.txt b/src/AppQuickStart/app-template/doc/CMakeLists.txt new file mode 100755 index 000000000..b75081b33 --- /dev/null +++ b/src/AppQuickStart/app-template/doc/CMakeLists.txt @@ -0,0 +1,31 @@ +# Copyright (C) 2012-2014 CEA/DEN, EDF R&D +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +SALOME_CONFIGURE_FILE(conf.py.in conf.py) + +SET(_cmd_options -c ${CMAKE_CURRENT_BINARY_DIR} -b html -d doctrees -D latex_paper_size=a4 ${CMAKE_CURRENT_SOURCE_DIR} html) +SALOME_GENERATE_ENVIRONMENT_SCRIPT(_cmd env_script "${SPHINX_EXECUTABLE}" "${_cmd_options}") + +ADD_CUSTOM_TARGET(html_docs COMMAND ${_cmd}) + +INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target html_docs)") +INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ DESTINATION ${SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_DOC_GUI}) + +SET(make_clean_files html doctrees) +SET_DIRECTORY_PROPERTIES(PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${make_clean_files}") diff --git a/src/AppQuickStart/app-template/doc/README b/src/AppQuickStart/app-template/doc/README new file mode 100644 index 000000000..f5406ebfa --- /dev/null +++ b/src/AppQuickStart/app-template/doc/README @@ -0,0 +1 @@ +This directory contains the sources of 's documentation diff --git a/src/AppQuickStart/app-template/doc/conf.py.in b/src/AppQuickStart/app-template/doc/conf.py.in new file mode 100644 index 000000000..2d168f083 --- /dev/null +++ b/src/AppQuickStart/app-template/doc/conf.py.in @@ -0,0 +1,187 @@ +# -*- coding: utf-8 -*- +# +# This file is execfile()d with the current directory set to its containing dir. +# +# The contents of this file are pickled, so don't put values in the namespace +# that aren't pickleable (module imports are okay, they're removed automatically). +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If your extensions are in another directory, add it here. If the directory +# is relative to the documentation root, use os.path.abspath to make it +# absolute, like shown here. +#sys.path.append(os.path.abspath('.')) + +# General configuration +# --------------------- + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = '(name_of_application)' +copyright = '2010-2014 CEA/DEN, EDF R&D, OPEN CASCADE, ASTEK INDUSTRIE' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '@SALOME[NAME_OF_APPLICATION]_MAJOR_VERSION@.@SALOME[NAME_OF_APPLICATION]_MINOR_VERSION@' +# The full version, including alpha/beta/rc tags. +release = '@SALOME[NAME_OF_APPLICATION]_VERSION@' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directory, that shouldn't be searched +# for source files. +exclude_trees = ['.build','ref','images','CVS'] + +# A list of glob-style patterns that should be excluded when looking for source +# files. They are matched against the source file names relative to the +# source directory, using slashes as directory separators on all platforms. +exclude_patterns = ['**/CVS'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# Options for HTML output +# ----------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +html_theme = 'default' + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['@SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_DOC_GUI@/_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +html_use_modindex = False + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, the reST sources are included in the HTML build as _sources/. +#html_copy_source = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = '(name_of_application)doc' + + +# Options for LaTeX output +# ------------------------ + +# The paper size ('letter' or 'a4'). +latex_paper_size = 'a4' + +# The font size ('10pt', '11pt' or '12pt'). +latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, document class [howto/manual]). +latex_documents = [ + ('index', '(name_of_application).tex', ' User Documentation', 'A. Ribes', 'manual') +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +latex_use_modindex = False diff --git a/src/AppQuickStart/app-template/doc/index.rst b/src/AppQuickStart/app-template/doc/index.rst new file mode 100644 index 000000000..cb2b308ac --- /dev/null +++ b/src/AppQuickStart/app-template/doc/index.rst @@ -0,0 +1,14 @@ + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +'s documentation +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +Outline +=========================== + + +.. toctree:: + :maxdepth: 1 + + intro.rst + link.rst diff --git a/src/AppQuickStart/app-template/doc/intro.rst b/src/AppQuickStart/app-template/doc/intro.rst new file mode 100644 index 000000000..e2baa234e --- /dev/null +++ b/src/AppQuickStart/app-template/doc/intro.rst @@ -0,0 +1,4 @@ +Introduction +========================================== + +Welcome to 's documentation! diff --git a/src/AppQuickStart/app-template/doc/link.rst b/src/AppQuickStart/app-template/doc/link.rst new file mode 100644 index 000000000..33a4a2c8f --- /dev/null +++ b/src/AppQuickStart/app-template/doc/link.rst @@ -0,0 +1,4 @@ +Link +========================================== + +A sample pdf file can be found :download:`here <../resources/doc/sample.pdf>` diff --git a/src/AppQuickStart/app-template/resources/CMakeLists.txt b/src/AppQuickStart/app-template/resources/CMakeLists.txt new file mode 100644 index 000000000..c3a4cae28 --- /dev/null +++ b/src/AppQuickStart/app-template/resources/CMakeLists.txt @@ -0,0 +1,36 @@ +# Copyright (C) 2012-2014 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +# --- resources --- +SET([NAME_OF_APPLICATION]_PROFILE_RESOURCES_FILES + app_icon.png + splash.png + about.png + icon_about.png + app_logo.png +) + +# --- rules --- +INSTALL(FILES ${[NAME_OF_APPLICATION]_PROFILE_RESOURCES_FILES} DESTINATION ${SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_RES_DATA}) + +# --- config --- +SALOME_CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/SalomeApp.xml.in ${CMAKE_CURRENT_BINARY_DIR}/SalomeApp.xml INSTALL ${SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_RES_DATA}) + +# --- sub-directories --- +ADD_SUBDIRECTORY( doc ) diff --git a/src/AppQuickStart/app-template/resources/SalomeApp.xml.in b/src/AppQuickStart/app-template/resources/SalomeApp.xml.in new file mode 100644 index 000000000..3a992ce48 --- /dev/null +++ b/src/AppQuickStart/app-template/resources/SalomeApp.xml.in @@ -0,0 +1,30 @@ + + +
    + + + + + + + + + + + + + + +
    +
    + + + + + + +
    +
    + +
    +     diff --git a/src/AppQuickStart/app-template/resources/about.png b/src/AppQuickStart/app-template/resources/about.png new file mode 100755 index 000000000..dfdc7e618 Binary files /dev/null and b/src/AppQuickStart/app-template/resources/about.png differ diff --git a/src/AppQuickStart/app-template/resources/app_icon.png b/src/AppQuickStart/app-template/resources/app_icon.png new file mode 100755 index 000000000..03e172c3f Binary files /dev/null and b/src/AppQuickStart/app-template/resources/app_icon.png differ diff --git a/src/AppQuickStart/app-template/resources/app_logo.png b/src/AppQuickStart/app-template/resources/app_logo.png new file mode 100644 index 000000000..362c018d7 Binary files /dev/null and b/src/AppQuickStart/app-template/resources/app_logo.png differ diff --git a/src/AppQuickStart/app-template/resources/doc/CMakeLists.txt b/src/AppQuickStart/app-template/resources/doc/CMakeLists.txt new file mode 100644 index 000000000..1e3735ae5 --- /dev/null +++ b/src/AppQuickStart/app-template/resources/doc/CMakeLists.txt @@ -0,0 +1,27 @@ +# Copyright (C) 2012-2014 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +# --- scripts --- + +# scripts / static +SET(_bin_DOCUMENTS + sample.pdf +) + +INSTALL(FILES ${_bin_DOCUMENTS} DESTINATION ${SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_DOC_GUI}) diff --git a/src/AppQuickStart/app-template/resources/doc/README b/src/AppQuickStart/app-template/resources/doc/README new file mode 100644 index 000000000..8f54bbbb4 --- /dev/null +++ b/src/AppQuickStart/app-template/resources/doc/README @@ -0,0 +1 @@ +This directory contains binaries of 's documentation diff --git a/src/AppQuickStart/app-template/resources/doc/sample.pdf b/src/AppQuickStart/app-template/resources/doc/sample.pdf new file mode 100644 index 000000000..1f3b08f0d Binary files /dev/null and b/src/AppQuickStart/app-template/resources/doc/sample.pdf differ diff --git a/src/AppQuickStart/app-template/resources/icon_about.png b/src/AppQuickStart/app-template/resources/icon_about.png new file mode 100755 index 000000000..ec56cacc7 Binary files /dev/null and b/src/AppQuickStart/app-template/resources/icon_about.png differ diff --git a/src/AppQuickStart/app-template/resources/splash.png b/src/AppQuickStart/app-template/resources/splash.png new file mode 100755 index 000000000..dfdc7e618 Binary files /dev/null and b/src/AppQuickStart/app-template/resources/splash.png differ diff --git a/src/AppQuickStart/app-template/src/CMakeLists.txt b/src/AppQuickStart/app-template/src/CMakeLists.txt new file mode 100644 index 000000000..5fcc1bda8 --- /dev/null +++ b/src/AppQuickStart/app-template/src/CMakeLists.txt @@ -0,0 +1,22 @@ +# Copyright (C) 2012-2014 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +# --- sub-directories --- +ADD_SUBDIRECTORY( tests ) +ADD_SUBDIRECTORY( resources ) diff --git a/src/AppQuickStart/app-template/src/resources/CMakeLists.txt b/src/AppQuickStart/app-template/src/resources/CMakeLists.txt new file mode 100644 index 000000000..947046b17 --- /dev/null +++ b/src/AppQuickStart/app-template/src/resources/CMakeLists.txt @@ -0,0 +1,33 @@ +# Copyright (C) 2012-2014 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +INCLUDE(UseQt4Ext) + +# --- resources --- + +# resource files / to be processed by lrelease +SET(_ts_RESOURCES + LightApp_images.ts + LightApp_msg_en.ts + LightApp_msg_fr.ts +) + +# --- rules --- + +QT4_INSTALL_TS_RESOURCES("${_ts_RESOURCES}" "${SALOME_[NAME_OF_APPLICATION]_PROFILE_INSTALL_RES_DATA}") diff --git a/src/AppQuickStart/app-template/src/resources/LightApp_images.ts b/src/AppQuickStart/app-template/src/resources/LightApp_images.ts new file mode 100755 index 000000000..ee44bfc64 --- /dev/null +++ b/src/AppQuickStart/app-template/src/resources/LightApp_images.ts @@ -0,0 +1,23 @@ + + + + + @default + + APP_DEFAULT_ICO + app_icon.png + + + ICO_ABOUT + icon_about.png + + + ABOUT + about.png + + + APP_BASE_LOGO + app_logo.png + + + diff --git a/src/AppQuickStart/app-template/src/resources/LightApp_msg_en.ts b/src/AppQuickStart/app-template/src/resources/LightApp_msg_en.ts new file mode 100755 index 000000000..4f7dfa198 --- /dev/null +++ b/src/AppQuickStart/app-template/src/resources/LightApp_msg_en.ts @@ -0,0 +1,35 @@ + + + + + @default + + ABOUT_COPYRIGHT + Copyright (C) + + + ABOUT_CAPTION + About + + + APP_NAME + [SLOGAN] + + + APP_VERSION + V[VERSION] + + + ABOUT_LICENSE + License description + + + ABOUT_VERSION + Version [VERSION] + + + ABOUT_TITLE + + + + diff --git a/src/AppQuickStart/app-template/src/resources/LightApp_msg_fr.ts b/src/AppQuickStart/app-template/src/resources/LightApp_msg_fr.ts new file mode 100755 index 000000000..ca802094d --- /dev/null +++ b/src/AppQuickStart/app-template/src/resources/LightApp_msg_fr.ts @@ -0,0 +1,35 @@ + + + + + @default + + ABOUT_COPYRIGHT + Copyright (C) + + + ABOUT_CAPTION + A propos de + + + APP_NAME + [SLOGAN] + + + APP_VERSION + V[VERSION] + + + ABOUT_LICENSE + Description de la licence + + + ABOUT_VERSION + Version [VERSION] + + + ABOUT_TITLE + + + + diff --git a/src/AppQuickStart/app-template/src/tests/CMakeLists.txt b/src/AppQuickStart/app-template/src/tests/CMakeLists.txt new file mode 100644 index 000000000..110c031b9 --- /dev/null +++ b/src/AppQuickStart/app-template/src/tests/CMakeLists.txt @@ -0,0 +1,29 @@ +# Copyright (C) 2012-2014 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +# --- scripts --- + +# scripts / static +SET(_bin_SCRIPTS + helloWorld.py +) + +# --- rules --- +SALOME_INSTALL_SCRIPTS("${_bin_SCRIPTS}" ${SALOME_INSTALL_SCRIPT_PYTHON}) + diff --git a/src/AppQuickStart/app-template/src/tests/README b/src/AppQuickStart/app-template/src/tests/README new file mode 100644 index 000000000..ef5ad8fa0 --- /dev/null +++ b/src/AppQuickStart/app-template/src/tests/README @@ -0,0 +1 @@ +This directory contains the tests of diff --git a/src/AppQuickStart/app-template/src/tests/helloWorld.py b/src/AppQuickStart/app-template/src/tests/helloWorld.py new file mode 100644 index 000000000..62c813abc --- /dev/null +++ b/src/AppQuickStart/app-template/src/tests/helloWorld.py @@ -0,0 +1 @@ +print "Hello world" diff --git a/src/AppQuickStart/ressources/Anita semi square.ttf b/src/AppQuickStart/ressources/Anita semi square.ttf new file mode 100644 index 000000000..17776fd89 Binary files /dev/null and b/src/AppQuickStart/ressources/Anita semi square.ttf differ diff --git a/src/AppQuickStart/ressources/CMakeLists.txt b/src/AppQuickStart/ressources/CMakeLists.txt new file mode 100644 index 000000000..e411b268e --- /dev/null +++ b/src/AppQuickStart/ressources/CMakeLists.txt @@ -0,0 +1,30 @@ +# Copyright (C) 2012-2014 CEA/DEN, EDF R&D, OPEN CASCADE +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +# + +# =============================================================== +# Files to be installed +# =============================================================== + +# These files are executable scripts +SET(APPQUICKSTART_RESOURCES_FILES + "Anita semi square.ttf" + background.png +) + +INSTALL( FILES ${APPQUICKSTART_RESOURCES_FILES} DESTINATION ${SALOME_KERNEL_INSTALL_RES_DATA} ) diff --git a/src/AppQuickStart/ressources/background.png b/src/AppQuickStart/ressources/background.png new file mode 100644 index 000000000..66627c859 Binary files /dev/null and b/src/AppQuickStart/ressources/background.png differ diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 8ea2b8ca1..26ed1a052 100755 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -18,6 +18,7 @@ # SET(SUBDIR_BASE + AppQuickStart Basics SALOMELocalTrace HDFPersist