Author: jcouteau Date: 2013-01-21 16:43:25 +0100 (Mon, 21 Jan 2013) New Revision: 122 Url: http://forge.codelutin.com/projects/isis-fish-docs/repository/revisions/122 Log: Begin translating FAQ to english Added: trunk/src/site/en/rst/v4/ trunk/src/site/en/rst/v4/index.rst trunk/src/site/en/rst/v4/user/ trunk/src/site/en/rst/v4/user/FAQ.rst Modified: trunk/src/site/site_en.xml Copied: trunk/src/site/en/rst/v4/index.rst (from rev 121, trunk/src/site/rst/v4/index.rst) =================================================================== --- trunk/src/site/en/rst/v4/index.rst (rev 0) +++ trunk/src/site/en/rst/v4/index.rst 2013-01-21 15:43:25 UTC (rev 122) @@ -0,0 +1,53 @@ +.. - +.. * #%L +.. * IsisFish +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 2011 Ifremer, CodeLutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU General Public License as +.. * published by the Free Software Foundation, either version 3 of the +.. * License, or (at your option) any later version. +.. * +.. * This program 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 General Public License for more details. +.. * +.. * You should have received a copy of the GNU General Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/gpl-3.0.html>. +.. * #L% +.. - + +Documentation version 4 +======================= + +* `FAQ`_ : Frequently asked questions +.. * `Warning`_ +.. * `Installation`_ +.. * `User manual`_ +.. * `Changes in version 4.0`_ +.. * `Migration from 3.x to 4.0`_ +.. * `Tutorials`_ +.. * `Developer manual`_ +.. * `APIs documentation`_ +.. * `ISIS scripts examples`_ +.. * `R scripts examples`_ +.. * `Note to CAPARMOR users`_ + +.. _Warning: user/warning.html +.. _Installation: user/installation.html +.. _User manual: user/usermanual.html +.. _Tutorials: user/tutorials.html +.. _FAQ: user/FAQ.html +.. _Developer manual: devel/index.html +.. _APIs documentation: user/API.html +.. _ISIS scripts examples: user/scripts.html +.. _R scripts examples: user/scriptsR.html +.. _Changes in version 4.0: user/changements40.html +.. _Migration from 3.x to 4.0: user/migrationv3v4.html +.. _Note to CAPARMOR users: user/tutorials/utilCaparmor.rst Copied: trunk/src/site/en/rst/v4/user/FAQ.rst (from rev 121, trunk/src/site/rst/v4/user/FAQ.rst) =================================================================== --- trunk/src/site/en/rst/v4/user/FAQ.rst (rev 0) +++ trunk/src/site/en/rst/v4/user/FAQ.rst 2013-01-21 15:43:25 UTC (rev 122) @@ -0,0 +1,126 @@ +.. - +.. * #%L +.. * IsisFish +.. * +.. * $Id$ +.. * $HeadURL$ +.. * %% +.. * Copyright (C) 1999 - 2011 Ifremer, Code Lutin, Chatellier Eric +.. * %% +.. * This program is free software: you can redistribute it and/or modify +.. * it under the terms of the GNU General Public License as +.. * published by the Free Software Foundation, either version 3 of the +.. * License, or (at your option) any later version. +.. * +.. * This program 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 General Public License for more details. +.. * +.. * You should have received a copy of the GNU General Public +.. * License along with this program. If not, see +.. * <http://www.gnu.org/licenses/gpl-3.0.html>. +.. * #L% +.. - + +Frequently Asked Questions (FAQ) +================================ + +.. contents:: + +What does the numbers 3.1.3.1 or 4.0.0.0 means ? +------------------------------------------------ + +The numbers follow this pattern : + * the first number gives ISIS major version. If you got 3.1.3.1, you are in + version 3. If you got 4.0.0.0 you are in version 4. + * the second gives the database version in this major version. If you got + 3.1.3.1, you are in version 1 of the database. If you got 4.0.0.0 you are in + version 0. + * the third number gives you the scripts version to use + (isis-fish-4/isis-database) + * the last number represents the minor version. In 3.1.3.1, the minor version + is 1. + +When you already got ISIS-Fish, you can use any other version with the same +major, base and scripts numbers. It means that only the minor number changes. + +If you want to use an ISIS-Fish version with an upper base number, ISIS-Fish +will automagically convert your database into this version. You will not be able +to use an ISIS-Fish version with a lower base number. + +It is possible to use ISIS-Fish in two different major versions because they do +not share the same configuration files. So they are two completely different +installations. + +You can launch version 3 and version 4 at the same time. + +What are my limits when I write scripts ? +----------------------------------------- + +You have to never modify an object returned by a script method because a caching +system is used. If you do so, you modify the cache object, and on the next call, +you will get the modified object and not the one you want. For example, if you +return a ``List``, you have to, in the method that gets the list, do a copy of +that ``List`` before modifying it. If you just read the ``List`` content, you +have nothing to do. + +Scripts : objects and syntax +---------------------------- + +Know ISIS objects and methods +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + * List of objects, methods and links between objects (UML model) : + ../../v3/devel/images/IsisFishModel.png . + This figure gives you the name of objects and the name of the attached methods + * ISIS-Fish API : http://www.isis-fish.org/apidocs/index.html + * Scripts access : in the software, using the scripts edition interface. Most + of the equations are in ``scripts/SiMatrix.java``. All the other scripts are + available online : http://www.isis-fish.org/xref/ . The source are also + viewable from the svn repo : + http://svn.forge.codelutin.com/svn/isis-fish/trunk/ + +Update scripts +~~~~~~~~~~~~~~ + +This can be done via synchronisation with the server : File/Server +synchronization. This action compares the scripts on the PC with those on the +server and indicates the differences. You have then to check the scripts you +want to update and validate. + +Warning : If an error is indicated in a script, the synchronisation will modify +the said script. If modifications happen betwen the local version and the server +versions, the lines in error will be marked with '<<<<'. You will have the local +version and the server version. You have to choose the version to keep and +delete or comment the other one so that the script can work. + +All the scripts are available here : +http://svn.forge.codelutin.com/svn/isis-fish-data/trunk/ + +Local scripts +~~~~~~~~~~~~~ + +If you have local scripts, they are not synchronized. + +Inherited scripts +~~~~~~~~~~~~~~~~~ + +If a local script have been written from a script on the server, it is necessary +to keep track of the script of origin. So in cas the script of origin is +modified on the server, the user can find the local inherited scripts and modify +them back. + +Add a contextual help on rules and analysis plans +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In the rules or plan script (script editor), + * at the imports levels, add : import fr.ifremer.isisfish.util.Doc + * on top of the parameter to document (for example public Zone param_zone = + null;), add @Doc("the parameter Zone correspond to ???") + +Insert comments in a script +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +System.out.println (); + Modified: trunk/src/site/site_en.xml =================================================================== --- trunk/src/site/site_en.xml 2012-12-20 15:15:22 UTC (rev 121) +++ trunk/src/site/site_en.xml 2013-01-21 15:43:25 UTC (rev 122) @@ -65,6 +65,9 @@ <item name="Roadmap" href="http://forge.codelutin.com/projects/isis-fish/roadmap" /> <item name="Download" href="download.html" /> + <item name="Documentation" href="v4/index.html"> + <item name="FAQ" href="v4/user/FAQ.html"/> + </item> <item name="Publications" href="publications.html" /> <item name="Research projects" href="research.html" /> <item name="License" href="license.html" />