--- /dev/null
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/EFICASdoc.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/EFICASdoc.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/EFICASdoc"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/EFICASdoc"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
--- /dev/null
+Add a command
+=============
+
+Eficas allows you to create or edit a dataset. Remember it is always possible to save (or read) invalid datasets.
+Building dataset consists of adding new commands, entering parameter values and if necessary naming concepts.
+see : :ref:`concept-label`.
+|
+Eficas provides two different widgets : first one allows you to manage commands, second one to enter values for each command.
+You can navigate between widgets using arrows or pushbutton.
+
+.. image:: images/CommandeBouton.png
+ :align: right
+
+Command widget shows up at file creation (if the new file is created empty ) or when clicking on :
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Enter commands
+---------------
+
+Eficas main widget provided two distinct areas: The left side always contains the dataset explorer as a tree view. The right widget contains all commands the user is allowed to select.
+If a dataset consists of a single command, tree view area is not displayed.
+
+.. image:: images/ChoixCommande.png
+ :align: center
+
+|
+
+To have command's **documentation** (if available), **simple-click** on the command.
+
+.. image:: images/Documentation1.png
+ :align: center
+
+|
+
+
+To **add** the command **click twice.** The new command is added after the current command (highlighted in the tree view). In case of impossibility, a message is displayed.
+
+.. image:: images/Ordre.png
+ :align: center
+
+|
+
+
+
+If the dataset must comply with building :ref:`rules-label`, a specific icon appears in the command widget.
+
+.. image:: images/Regles.png
+ :align: center
+
+|
+
+
+The user also can choose the way the commands are sorted, either by alphabetical order, either by fonctionnalities.
+Last type of sorting commands is called 'by modelisation' that is to say logical order to prepare data for the code.
+
+.. image:: images/Groupes.png
+ :align: center
+
+|
+
+
+The content filtering system is very simple : only commands containing the expression are shown.
+
+.. image:: images/FiltreCommande.png
+ :align: center
+
+|
+
+
+
+The user can use "Find", which is a filter widget to find a concept or command position in the dataset. The pushbutton "next/suivant" shows the next matching concept/command.
+
+.. image:: images/FindConcept.png
+ :align: center
+
+
--- /dev/null
+Color chart
+===========
+
+a very simple colors chart helps the user to know if a item is valid or not :
+
+* In the Dataset tree view
+
+ - green square : valid objects (Dataset, Command, Concept ...)
+ - red square : unvalid objects
+ - **yellow square** : valid **Concept** the user must name
+ - green diamond : valid group keywords
+ - red diamond : unvalid group keywords
+ - green circle : valid keywords
+ - red circle : unvalid keywords
+
+* In the input data form widget
+ - green circle : valid keywords or unvalid objects
+ - red circle : unvalid keywords or unvalid objects
+
+* In the rules part
+
+ - red is for unobserved rules
+ - black is for observed rules
+
--- /dev/null
+Parameters and comments
+========================
+
+Parameters
+-----------
+The users can define parameters. As parameters, Eficas accepts :
+
+- Real
+- String
+- Integer
+- List
+
+A parameter's definition can use existing parameters such as :
+eps=sqrt((((W / NX) ** 2) + ((H / NY) ** 2)))
+
+right-click menus on tree items allows you to add a parameter.
+
+.. image:: images/Parametres.png
+ :align: center
+
+
+Pushing on "Parametres" Pushbutton opens a dialog containing all already existing parameters. You can define as many parameters as needed
+at once.
+
+.. image:: images/Parametres1.png
+ :align: center
+
+
+to use a parameter, just type its name.
+
+.. image:: images/Parametres2.png
+ :align: center
+
+
+Comments
+---------
+
+Comments may refer to :
+
+- user annotation. In this case, background label is white.
+- generated comment. In this case, background label is light grey.
+
+
+.. image:: images/Commentaire.png
+ :align: center
+
--- /dev/null
+# -*- coding: utf-8 -*-
+#
+# Eficas documentation build configuration file, created by
+# sphinx-quickstart on Thu Oct 1 10:55:47 2015.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Eficas'
+copyright = u'2015, Pascale Noyret'
+
+# 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 = '7.7'
+# The full version, including alpha/beta/rc tags.
+release = '7.7.0'
+
+# 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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# 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'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> 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 = ['_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_domain_indices = True
+
+# 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, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Eficasdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+ # get rid off blank pages
+ 'classoptions': ',openany,oneside',
+ 'babel' : '\\usepackage[english]{babel}',
+
+
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'Eficas.tex', u'Eficas Documentation',
+ u'Pascale Noyret', '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
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'eficasdoc', u'Eficas Documentation',
+ [u'Pascale Noyret'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'Eficas', u'Eficas Documentation',
+ u'Pascale Noyret', 'Eficas', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
--- /dev/null
+.. _icons-label:
+
+=======================
+Using icons in Eficas
+=======================
+
+Icons
+-----
+
+Icons are used because they are presumed to save time, but all actions can be accessed from menus.
+Eficas use a small set of icons. Hopefully, users are familiar with. However, all icons are labelled.
+
+
+.. image:: images/Icons.png
+ :align: center
+
+
+
+
+Shortcuts
+---------
+
+Eficas keybord shortcuts require the user to press a sequence of keys.
+These sequences contain 'Ctrl' for common shortcuts as "Ctrl+C", Alt for accessing action of menu, and 'Shift' for specific actions. Note that 'Shift D' allows expanding/collapsing items
+
+
+
+
--- /dev/null
+.. _salome-label:
+
+Eficas in Salome (For Aster)
+============================
+
+Launching Eficas in Salome
+---------------------------
+First activate Eficas module
+
+.. image:: images/LctDsSalome.png
+ :align: center
+
+
+Use Eficas. When a file is saved, Eficas will create an associated entry in the object browser.
+It is possible to use the file in other modules (see appropriate module's documentation).
+
+.. image:: images/ArbreSalome.png
+ :align: center
+
+Structural Element
+-------------------
+
+Eficas is able to create "structural element" in GEOM or in SMESH in order to
+validate data.
+
+- Create your geometry
+
+.. image:: images/SalomePylone.png
+ :align: center
+
+- Create your Eficas dataseat, and define for example a beam , with AFFE-CARA-ELEM.
+
+- Click on "View3D". Eficas shows you the result in GEOM and creates "beams" .
+ Be aware : these "structural elements" are not "geometry elements". You can't use it.
+ It's also possible to verify normals orientation.
+
+.. image:: images/SalomePyloneSE.png
+ :align: center
+
+
--- /dev/null
+.. _concept-label:
+
+Eficas Concepts
+================
+
+Commands in the Data Set (or JDC Jeu De Commandes )
+---------------------------------------------------
+
+A dataset is made of a collection of commands. Each command have parameters (keywords). They can return concept or not:
+
+* Command not returning concept : they are described as "PROC" in catalogs.
+
+ - example:
+ - DEBUT() is a proc.
+ - for ASTER, it initializes memory and files.
+
+* Command returning a concept :
+ The concept has a specific type (defined in the catalog) and a name (given by the user). These commandes are described as "OPER" in catalogs.
+
+ - example :
+ - MONMAIL=LIRE_MAILLAGE(UNITE=20);
+ - This line creates a new concept MONMAIL of type "maillage", which can be re-used as entry for another keyword.
+
+ When an object is valid, the user has to named it. In tree view, a yellow square shows valid objects that have to be nammed.
+
+Commands are composed of keywords, or groups of keywords. These items are associated according to rules or conditions.
+They are described in the catalog.
+
+
+Keywords
+---------
+
+* Group of keywords (mot-clef facteur )
+
+ This is a list of keywords which jointly have a meaning for the code.
+ It is composed of group of keywords and simple keywords.
+ Some are mandatory, repeatable.
+ This list can depend on conditionnal rules.
+
+
+* Simple keyword (mot-clef simple) .
+
+ This is a parameter. It also can be mandatory or not.
+ It has attributes.
+
+
+Attributes of a keyword
+---------------------------
+
+a parameter (simple keyword or "mot-clef simple") has :
+
+- a type : real, string, complex, integer, matrix, file (existing or allready existing), directory or a concept class which is defined in the catalog.
+- a cardinality.
+
+a parameter (simple keyword or "mot-clef simple") should have :
+
+- a default value
+- a short documentation
+- a long documentation
+- an interval of values
+- a set of discrete values
+
+
+Input data panel depends on both these attributes. Eficas ensures that data are valid. It forces the user to enter a list if needed, it verifies the input type. It displays only possible values.
+
+
+
--- /dev/null
+What's Eficas
+==============
+
+Name's origin
+-------------
+Eficas is the acronym of ' **E**\ diteur de **FI**\ chier de **C**\ ommandes et **A**\ nalyseur **S**\ émantique'.
+That means that Eficas allows users to write a parameter file for a code.
+It handles with syntax and semantic.
+It avoids misuse of commands which are not allowed in a given context.
+It insures integrity of the file.
+
+General Behaviour
+------------------
+* Catalogs
+
+Eficas can be used by multiple codes and handles with multiple versions of each code. It is customized with files named "Catalogs (or Catalogues)" : It contains all commands for a code. Each command has a name and parameters which are defined by developpers.
+
+
+* Outputs
+
+Eficas's output is a commands file (dataset file or Jeux De Données) ".comm". It may be able to produce various file formats such as .xml, .py or specific format. However, you always must have a '.comm" output: this is the only format Eficas is able to reread.
+
+Both commands Files and Catalogs are python file. So you have to remind some
+:ref:`python-label`
+
+
--- /dev/null
+.. _rules-label:
+
+===============================
+Eficas rules
+===============================
+
+All the rules can be combinated, creating more complicated rules.
+
+AU_MOINS_UN
+-----------
+
+ AU_MOINS_UN rule obliges the user to create at least one concept of the list. More than one can be created.
+
+- Example
+
+ Keyword POUTRE in OPER AFFE_CARA_ELEM contains the rule :
+
+ regles=(AU_MOINS_UN(
+ 'POUTRE','COQUE','DISCRET','CABLE','BARRE','MASSIF','ASSE_GRIL','GRILLE'),)
+
+- That means if AFFE_CARA_ELEM is used in the JDC, the user must select one at least of the Keyword between POUTRE, COQUE, DISCRET, CABLE, BARRE, MASSIF, ASSE_GRIL, GRILLE :
+
+ * If the user doesn't select any of these keywords, AFFE_CARA_ELEM is unvalid.
+ * If he selects POUTRE, AFFE_CARA_ELEM is valid.
+ * If he selects both POUTRE and DISCRET, AFFE_CARA_ELEM is valid.
+
+
+UN_PARMI
+--------
+
+ AU_MOINS_UN rule obliges the user to create one and only one concept of the list.
+
+- Example
+
+ Oper AFFE_CHAR_MECA contains the rules :
+
+ regles=(UN_PARMI('VECT_Y','ANGL_VRIL'),
+
+- That means if AFFE_CHAR_MECA is used in the JDC, the user must select VECT_Y or ANGL_VRIL.
+
+ * If the user doesn't select any of these keywords, DEFI_GROUP is unvalid.
+ * If he selects only VECT_Y, DEFI_GROUP is valid.
+ * Eficas will not proposed the keyword ANGL_VRIL if VECT_Y already exists.
+
+
+EXCLUS
+--------
+
+ EXCLUS means that, if one of the keyword is created, the other won't be allowed.
+
+ - Example :
+ DEFI_SQUELETTE contains the rules :
+
+ EXCLUS('SOUS_STRUC','SECTEUR')
+
+- That means if DEFI_SQUELETTE is used in the JDC
+
+ * If the user doesn't select any of these keywords, DEFI_SQUELETTE is valid.
+ * If he selects only SOUS_STRUC, DEFI_SQUELETTE is valid.
+ * If he selects only SECTEUR, DEFI_SQUELETTE is valid.
+ * Eficas will not proposed the keyword SECTEUR if SOUS_STRUC already exists.
+
+ENSEMBLE
+--------
+
+ the rule means that if one keyword is selected, the others have to be also.
+ the keywords order is not meaningful.
+
+- Example
+
+ GRILLE in AFFE_CARA_ELEM, contains :
+
+ ENSEMBLE('ORIG_AXE','AXE')
+
+- That means if GRILLE is used in the JDC
+
+ * If the user doesn't select any of these keywords, GRILLE is valid.
+ * If he selects only ORIG_AXE, GRILLE is invalid.
+ * If he selects both ORIG_AXE and AXE, GRILLE is valid.
+
+PRESENT_PRESENT
+---------------
+
+ the rule means that if the FIRST keyword is selected, the others have to be also.
+
+- Example
+
+ MACRO_MISS_3D contains the rule
+
+ PRESENT_PRESENT('FREQ_MIN','FREQ_MAX','FREQ_PAS')
+
+- That means if MACRO_MISS_3D is used in the JDC
+
+ * If the user doesn't select any of these keywords, GRILLE is valid.
+ * If he selects only FREQ_MAX, GRILLE is valid.
+ * If he selects only FREQ_PAS, GRILLE is valid.
+ * If he selects only FREQ_MIN, GRILLE is invalid.
+ * If he selects both FREQ_MIN, FREQ_MAX and FREQ_PAS, GRILLE is valid.
+
+
+PRESENT_ABSENT
+---------------
+
+ the rule means that if the FIRST keyword is selected, the others aren't allowed.
+
+- Example
+ FORCE_COQUE in AFFE_CHAR_MECA contains
+
+ regles=( PRESENT_ABSENT('FX','PRES','F1','F2','F3','MF1','MF2'),
+
+- That means if FORCE_COQUE is used in the JDC
+
+ * If the user doesn't select any of these keywords, FORCE_COQUE is valid.
+ * If he selects only FX, FORCE_COQUE is valid.
+ * If he selects both PRES and F1, FORCE_COQUE is valid.
+
+
+
+
--- /dev/null
+.. EFICAS documentation master file, created by sphinx-quickstart on Wed Sep 14 11:40:32 2011.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to EFICAS's documentation!
+==================================
+
+This documentation covers the usage of Eficas as data setting tool.
+This is intended for end users who want to use Eficas and not for developpers who want to write a catalog.
+
+The usage of Eficas for a particular code is not described in this guide. Refer to
+code documentation to know how to use Eficas more specifically.
+
+Contents:
+
+.. toctree::
+ :maxdepth: 1
+
+ eficas_presentation
+ lancer_eficas
+ nouveau_JDC
+ ajouter_une_commande
+ parametrer_une_commande
+ color_chart
+ commentaires_parametres
+ eficas_icons
+ widgetInDetails
+ eficas_notions
+ eficas_rules
+ python_rules
+ eficas_in_salome
+
+
+
+
--- /dev/null
+First step
+===========
+
+Build a new dataset.
+---------------------
+Launch Eficas and choose "Nouveau/New" in "File" menu.
+
+.. image:: images/Nouveau.png
+ :align: center
+
+For some codes (Telemac or PSEN), simulation dataset are pre-filled with mandatory keywords. Users complete the dataset with values
+and add new commands if needed. In this case, the window that allows to :ref:`form-label` appears.
+
+
+Open an existing dataset.
+---------------------------
+Launch Eficas and choose "Open/Ouvrir" in "File" menu. It shows up a file Open/Save dialog window.
+
+.. image:: images/Ouvrir.png
+ :align: center
+
+Open a "Recently Used" dataset.
+--------------------------------
+To open a document that you recently used, click "File" , point to "Recently Opened", and then click the item that you want to open.
+
+.. image:: images/Recents.png
+ :align: center
+
+To clear the contents of the list, click 'Delete' item.
+
+
+Data/Jdc Menu.
+----------------
+
+.. image:: images/DataMenu.png
+ :align: center
+
+- Why is dataset unvalid?
+ Click on Validation Report item.
+
+- "Rules for dataset" displays the rules you have to respect when building a dataset
+
+
+- "Source File" item allows to check the source file.
+
+- "Result File" item allows to check the .comm result.
+ It allows you to save the dataset in a file (for Adao Study for example)
+
+- "Comment" item add a comment at the beginning of the dataset.
+
+- "Parameters" allows you to manage parameters for the dataset.
+
+Open Multiple dataset.
+----------------------
+
+You can open multiple datasets. Each file is associated with a different page and is shown by clicking on its tab.
+
+.. image:: images/Multi.png
+ :align: center
+
+
+Open twice the same dataset.
+----------------------------
+You can open twice the same dataset (in order to create a copy and rename it). Eficas warns you :
+
+.. image:: images/Duplication.png
+ :align: center
+
+In case of duplication, Eficas does not assure coherency between the two copies.
+
+
+The dataset is valid.
+---------------------
+Once the dataset is valid, you can lauch your code (in particulary PSEN, Carmel). Use 'run' icon
+or choose "Run" in the menubar.
+
+.. image:: images/Run.png
+ :align: center
+
--- /dev/null
+.. _form-label:
+
+===============
+Edit a command
+===============
+
+Each command has to be setted up. Eficas generates a data entry form.
+This form varies dynamicaly, depending on the context : rules and already existing values.
+
+This widget appears by selecting (clicking) on a command (first level in the tree view).
+
+.. image:: images/DoubleFleche.png
+ :align: right
+
+You can navigate from command to command using the arrows buttons:
+
+
+The command widget
+--------------------
+
+this widget is divided vertically into three separate areas :
+ - the tree view,
+ - the form widget
+ - the optional keywords.
+
+When needed, views provide scrollbar so that the entire information can be viewed.
+
+A bottom widget provides a horizontal bar for presenting documentation as the status bar is used to display error or warning messages.
+
+.. image:: images/Main.png
+ :align: center
+
+|
+|
+
+Edit values
+-------------
+
+Eficas uses many different widgets in order to help you to choose values :
+
+- Line editors for simple values
+- Entry lists widgets
+- Popup lists
+- Group boxes of button
+
+see :ref:`features-label` to know more about each widget.
+
+
+.. image:: images/Erreur.png
+ :align: center
+Eficas does not let you enter invalid values. It checks the type and the cardinality of the value.
+It ensures that the value is in the value domain or proposes a set of discrete values.
+Data entered is checked against a set of rules. Errors are displayed in red to draw attention.
+
+
+Form construction is dynamic
+----------------------------
+
+The form is updated according to values. It asks for the field depending on what's selected.
+
+In the example below:
+
+- if value of 'Initial_Conditions' is 'Zero Elevation', no additional data is needed
+
+.. image:: images/Zero.png
+ :align: center
+
+- if value of 'Initial_Conditions' is 'TPXO satellite altimetry', you have to fill 'Ascii_Database_For_Tide'
+
+.. image:: images/TPXO.png
+ :align: center
+
+Displaying optional keyword
+------------------------------
+
+When you create a new command, the widget opens with the optional keywords of this command.
+
+.. image:: images/OptionnelCommande.png
+ :align: center
+
+When entering in a "group keyword", the optional keywords list is updated to show optional keyword for this specific "group keyword".
+
+.. image:: images/OptionnelCommande1.png
+ :align: center
+
+
+By clicking on command label ("INITIALIZATION") or on keyword label ("Input_files"), the corresponding optional keywords list is displayed.
+
+Sometimes, when a user enters a value for a keyword, optional keywords are dependents on this value. Optional keywords list is updated.
+This is the case for conditionnal keywords
+
+.. image:: images/OptionnelParametersAdao.png
+ :align: center
+
+
+.. image:: images/OptionnelParametersAdao1.png
+ :align: center
+
+Adding/Deleting an optional keyword
+------------------------------------
+
+Optional keywords (if any) are in the right part of the "command window". Just double-click on the checkbox to add the keyword.
+The input data form is redisplayed and the list of possible optional keywords will be updated (for example, if two keywords cannot be simultaneously present).
+
+.. image:: images/DblClickOnOptional.png
+ :align: center
+
+.. image:: images/Poubelle.png
+ :align: right
+To delete a keyword (or a command), just click the garbage icon :
+
+|
+Naming Concepts
+---------------
+
+The icon for a command may be one of three colors: green, yellow or red. These colors represent the status of the command and the color meanings is :
+ - red for unvalid command,
+ - green for valid command,
+ - yellow for commands which have to be named.
+
+.. image:: images/NommerObjet.png
+ :align: center
+
+Tooltips
+--------
+
+**Use tooltips to have information.**
+
+- Tooltips on **labels** display **information about the keyword**. Double-click on the label to display this information in the comment area, at the bottom of the window. This is useful for long text. *(You also can double-click on the keyword in the tree dataset.)*
+
+.. image:: images/ToolTipOnLabel.png
+ :align: center
+
+- Tooltips on **lineEdit** (one-line text editor) display **suggestion** for the input value. Suggestion are not very frequent. They are not default values, because you have to enter it explicitely.
+
+.. image:: images/ToolTipOnLineEdit.png
+ :align: center
+
+- Tooltips on **Red point** display **information about the validity** for the keyword or for the group of keywords.
+By double-clicking on the "red point" a window displaying the same information appears. It should be usefull if text
+is too long to be read at one sitting.
+
+.. image:: images/ToolTipOnRed.png
+ :align: center
+
+- Tooltips on **Commands Button** explain what the icon/button represents, and which action is activated by clicking.
+
+.. image:: images/ToolTipOnButton.png
+ :align: center
+
+
+Context Menus
+--------------
+In the dataset tree, context menus (invoked by right-clicking) allow user to :
+
+- create comments in the tree
+- create parameter
+- comment the command itself
+- delete the node
+
+.. image:: images/Menus.png
+ :align: center
+
+Some commands have associated scripts. They are easy to identify because the "run" icon is present :
+
+.. image:: images/Roue.png
+ :align: right
+
+
+.. image:: images/Scripts.png
+ :align: center
--- /dev/null
+.. _python-label:
+
+===============================
+rules for python syntax
+===============================
+
+Variable names and identifiers are similar to those in many other languages :
+----------------------------------------------------------------------------
+
+* They start with a letter (A_Z or a-z) or underscore "_"".
+* They are followed by letters, numbers or underscores.
+* They are case-sensitive.
+* A string is a sequence of caracters enclosed by a matching pair of single or double quotes.
+
+Eficas does not allow you to use uncorrect names :
+
+.. image:: images/NomPython.png
+
+Some identifiers are reserved words :
+-------------------------------------
+
+* You can't use words of the python language as identifiers.
+* Eficas itself uses identifiers which become reserved words. For example, you can't use the following words, even if it would make some interesting names:
+ - BLOC, EXCLUS, OPER, ASSD,
+ - EVAL, FACT, FORM, JDC,
+ - REGLE, VALIDATOR,
+ - ETAPE, ENTITE
+
+Python's way for assigning values to variables:
+-------------------------------------------------
+
+* Keep in mind that ".comm" are python files. The simplest form of assignement is : variable = value
+* The hash character (#) starts a comment
+* Tuples are enclosed in parentheses.
+* Lists are enclosed in bracked.
+* In tuples or lists, a ',' follows each item especially the last one.
+
+.. image:: images/ListeEtTuple.png
+
--- /dev/null
+.. _features-label:
+
+========================
+Some Widgets Features
+========================
+
+File or Directory
+-----------------
+
++-------------------------------------+--------------------------------------------------+
+| a File parameter has to be : | if catalog's description is : |
++=====================================+==================================================+
+|an existing file | type='Fichier' |
++-------------------------------------+--------------------------------------------------+
+|a directory | type='Repertoire' |
++-------------------------------------+--------------------------------------------------+
+|an existing file with specific suffix| type='Fichier','JDC Files (*.comm);;All Files (*)|
++-------------------------------------+--------------------------------------------------+
+|a non-allready existing file | type=('Fichier',"",'Sauvegarde'), |
++-------------------------------------+--------------------------------------------------+
+|a simple string | type='FichierNoAbs' |
++-------------------------------------+--------------------------------------------------+
+
+The following widget allows users to enter a directory (first) or a file. Magnifier icon is not avalaible when a directory is required.
+
+.. image:: images/FichiersEtRepertoires.png
+
+- to open a file explorer, click on the corresponding icon. If a file suffix is required, content of the directory is filtered before being shown in the dialog, using a semicolon-separated list of filters specified.
+
+- to view file content, click on magnifier icon. It uses xdg-open, which is a desktop-independent tool for opening files (according to suffix convention).
+
+
+List
+-----
+List widgets have a toolbar down, under values area.
+
+.. image:: images/ShowAllValues.png
+
+- Use the Up or Down arrows to move the selection in the list
+- Use the Plus (or Minus) icon to add (delete) a new line
+- Use the magnifier icon to see all the values in a modal widget
+
+|
+
+If lists are not ordered, it is possible to select all values by clicking the button on the right.
+
+.. image:: images/SelectAllInList.png
+
+
+
+Import data from file
+-----------------------
+
+Data import icon provide access to data from ASCII text files.
+Select the character that separates values in your text file and values you want to import.
+
+.. image:: images/Import.png
+ :align: center
+
+
+Matrix
+-------
+Sometimes, matrix dimensions depend on the number of others parameters (for example, correlation matrix).
+If a new variable is entered or if the name changes, matrix becomes invalid.
+Users have to redisplay the header by pushing the refresh icon.
+
+.. image:: images/Matrice.png
+
+
+
