[doc] preferences() page improved 48/20948/7
Samuel GOUGEON [Mon, 15 Apr 2019 22:56:26 +0000 (00:56 +0200)]
 PDF version: attached in Patch Set#1. Please remove before merging.

Change-Id: Idc788578603720d3de4373b24c5cb5c44b22cce3

scilab/modules/preferences/help/en_US/preferences.xml
scilab/modules/preferences/help/fr_FR/preferences.xml [new file with mode: 0644]
scilab/modules/preferences/help/images/preferences_gui_en_US.png [new file with mode: 0644]
scilab/modules/preferences/help/ja_JP/preferences.xml
scilab/modules/preferences/help/ru_RU/preferences.xml [new file with mode: 0644]

index 839324d..b3cfce5 100644 (file)
@@ -2,8 +2,8 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2009 - DIGITEO - Sylvestre KOUMAR
- *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
  *
  * This file is hereby licensed under the terms of the GNU GPL v2.0,
  * pursuant to article 5.3.4 of the CeCILL v.2.1.
  * along with this program.
  *
  -->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="preferences" xml:lang="en">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
+          xmlns:scilab="http://www.scilab.org" xml:id="preferences" xml:lang="en">
     <refnamediv>
         <refname>preferences</refname>
         <refpurpose>Open the Scilab Preferences window</refpurpose>
     <refsection>
         <title>Description</title>
         <para>
-            Open Scilab Preferences window.
+            Opens the Scilab Preferences window.
+        </para>
+        <para>
+            <inlinemediaobject>
+                <imageobject>
+                    <imagedata fileref="../images/preferences_gui_en_US.png"  valign="middle"/>
+                </imageobject>
+            </inlinemediaobject>
         </para>
     </refsection>
     <refsection>
         <title>Examples</title>
         <programlisting role="example"><![CDATA[
 preferences()
+
+// Targeting a chosen section:
+jdeff org.scilab.modules.preferences.XConfigManager openPreferences prefs; // once for all
+prefs general/shortcuts
+prefs scinotes/display
+ ]]></programlisting>
+      <para>
+        <emphasis role="bold">Edit your main user's preferences file</emphasis>
+        (you should not change its content by hand):
+      </para>
+        <programlisting role="example"><![CDATA[
+scinotes SCIHOME/XConfiguration.xml readonly
  ]]></programlisting>
+    <para/>
+    <para>
+        <emphasis role="bold">How to get some configuration values:</emphasis>
+        Example : Retrieve from the main configuration file the status of the ask-for-confirmations:
+    </para>
+        <programlisting role="example"><![CDATA[
+xmlGetValues("//general/confirmation-dialogs/body/tools/tool",["id" "state"])
+     ]]></programlisting>
+    <screen><![CDATA[
+--> xmlGetValues("//general/confirmation-dialogs/body/tools/tool",["id" "state"])
+ ans  =
+!console-exit         unchecked  !
+!delete-history-item  unchecked  !
+!console-clear        unchecked  !
+]]></screen>
     </refsection>
     <refsection role="see also">
         <title>See also</title>
         <simplelist type="inline">
             <member>
-                <link linkend="scinotes">scinotes</link>
+                <link linkend="xmlGetValues">xmlGetValues</link>
+            </member>
+            <member>
+                <link linkend="ieee">ieee</link>
+            </member>
+            <member>
+                <link linkend="format">format</link>
+            </member>
+            <member>
+                <link linkend="lines">lines</link>
+            </member>
+            <member>
+                <link linkend="mode">mode</link>
+            </member>
+            <member>
+                <link linkend="funcprot">funcprot</link>
+            </member>
+            <member>
+                <link linkend="setdefaultlanguage">setdefaultlanguage</link>
+            </member>
+            <member>
+                <link linkend="setlookandfeel">setlookandfeel</link>
+            </member>
+            <member>
+                <link linkend="printsetupbox">printsetupbox</link>
+            </member>
+            <member>
+                <link linkend="recursionlimit">recursionlimit</link>
+            </member>
+            <member>
+                <link linkend="odeoptions">odeoptions</link>
+            </member>
+            <member>
+                <link linkend="csvDefault">csvDefault</link>
+            </member>
+            <member>
+                <link linkend="xlfont">xlfont</link>
+            </member>
+            <member>
+                <link linkend="startup">startup</link>
+            </member>
+            <member>
+                <link linkend="atomsGetConfig">atomsGetConfig</link>
             </member>
         </simplelist>
     </refsection>
+    <refsection role="history">
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revdescription>
+                    Function introduced
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
diff --git a/scilab/modules/preferences/help/fr_FR/preferences.xml b/scilab/modules/preferences/help/fr_FR/preferences.xml
new file mode 100644 (file)
index 0000000..273e3aa
--- /dev/null
@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2009 - DIGITEO - Sylvestre KOUMAR
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
+ *
+ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
+          xmlns:scilab="http://www.scilab.org" xml:id="preferences" xml:lang="fr">
+    <refnamediv>
+        <refname>preferences</refname>
+        <refpurpose>Ouvre la fenêtre de configuration de Scilab</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Syntaxe</title>
+        <synopsis>
+            preferences()
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Description</title>
+        <para>
+            <literal>preferences()</literal> ouvre l'interface interactive de configuration
+            de Scilab et des modules externes chargés.
+        </para>
+        <para>
+            <inlinemediaobject>
+                <imageobject>
+                    <imagedata fileref="../images/preferences_gui_en_US.png"  valign="middle"/>
+                </imageobject>
+            </inlinemediaobject>
+        </para>
+    </refsection>
+    <refsection>
+        <title>Exemples</title>
+        <programlisting role="example"><![CDATA[
+preferences()
+
+// Ouvrir une section particulière :
+jdeff org.scilab.modules.preferences.XConfigManager openPreferences prefs; // once for all
+prefs general/shortcuts
+prefs scinotes/display
+ ]]></programlisting>
+      <para>
+        <emphasis role="bold">Editer votre principal fichier de configuration utilisateur</emphasis>
+        (en modifier le contenu à la main est fortement déconseillé) :
+      </para>
+        <programlisting role="example"><![CDATA[
+scinotes SCIHOME/XConfiguration.xml readonly
+ ]]></programlisting>
+    <para/>
+    <para>
+        <emphasis role="bold">Obtenir la valeur de paramètres de configuration</emphasis> :
+        Exemple : récupérer dans le fichier de configuration principal l'état des demandes de
+        confirmation réglables :
+    </para>
+        <programlisting role="example"><![CDATA[
+xmlGetValues("//general/confirmation-dialogs/body/tools/tool",["id" "state"])
+     ]]></programlisting>
+    <screen><![CDATA[
+--> xmlGetValues("//general/confirmation-dialogs/body/tools/tool",["id" "state"])
+ ans  =
+!console-exit         unchecked  !
+!delete-history-item  unchecked  !
+!console-clear        unchecked  !
+]]></screen>
+    </refsection>
+    <refsection role="see also">
+        <title>Voir aussi</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="xmlGetValues">xmlGetValues</link>
+            </member>
+            <member>
+                <link linkend="ieee">ieee</link>
+            </member>
+            <member>
+                <link linkend="format">format</link>
+            </member>
+            <member>
+                <link linkend="lines">lines</link>
+            </member>
+            <member>
+                <link linkend="mode">mode</link>
+            </member>
+            <member>
+                <link linkend="funcprot">funcprot</link>
+            </member>
+            <member>
+                <link linkend="setdefaultlanguage">setdefaultlanguage</link>
+            </member>
+            <member>
+                <link linkend="setlookandfeel">setlookandfeel</link>
+            </member>
+            <member>
+                <link linkend="printsetupbox">printsetupbox</link>
+            </member>
+            <member>
+                <link linkend="recursionlimit">recursionlimit</link>
+            </member>
+            <member>
+                <link linkend="odeoptions">odeoptions</link>
+            </member>
+            <member>
+                <link linkend="csvDefault">csvDefault</link>
+            </member>
+            <member>
+                <link linkend="xlfont">xlfont</link>
+            </member>
+            <member>
+                <link linkend="startup">startup</link>
+            </member>
+            <member>
+                <link linkend="atomsGetConfig">atomsGetConfig</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection role="history">
+        <title>Historique</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revdescription>
+                    Fonction ajoutée
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
+</refentry>
diff --git a/scilab/modules/preferences/help/images/preferences_gui_en_US.png b/scilab/modules/preferences/help/images/preferences_gui_en_US.png
new file mode 100644 (file)
index 0000000..4cd3515
Binary files /dev/null and b/scilab/modules/preferences/help/images/preferences_gui_en_US.png differ
index 236918f..bebfab4 100644 (file)
@@ -2,8 +2,8 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) 2009 - DIGITEO - Sylvestre KOUMAR
- *
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
  *
  * This file is hereby licensed under the terms of the GNU GPL v2.0,
  * pursuant to article 5.3.4 of the CeCILL v.2.1.
  * along with this program.
  *
  -->
-<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="preferences" xml:lang="ja">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
+          xmlns:scilab="http://www.scilab.org" xml:id="preferences" xml:lang="ja">
     <refnamediv>
         <refname>preferences</refname>
         <refpurpose>Scilab設定ウィンドウを開く</refpurpose>
         <para>
             Scilab設定ウィンドウを開きます.
         </para>
+        <para>
+            <inlinemediaobject>
+                <imageobject>
+                    <imagedata fileref="../images/preferences_gui_en_US.png" valign="middle"/>
+                </imageobject>
+            </inlinemediaobject>
+        </para>
     </refsection>
     <refsection>
         <title>例</title>
         <programlisting role="example"><![CDATA[
 preferences()
+
+// Targeting a chosen section:
+jdeff org.scilab.modules.preferences.XConfigManager openPreferences prefs; // once for all
+prefs general/shortcuts
+prefs scinotes/display
+ ]]></programlisting>
+      <para>
+        <emphasis role="bold">Edit your main user's preferences file</emphasis>
+        (you should not change its content by hand):
+      </para>
+        <programlisting role="example"><![CDATA[
+scinotes SCIHOME/XConfiguration.xml readonly
  ]]></programlisting>
+    <para/>
+    <para>
+        <emphasis role="bold">How to get some configuration values:</emphasis>
+        Example : Retrieve from the main configuration file the status of the ask-for-confirmations:
+    </para>
+        <programlisting role="example"><![CDATA[
+xmlGetValues("//general/confirmation-dialogs/body/tools/tool",["id" "state"])
+     ]]></programlisting>
+    <screen><![CDATA[
+--> xmlGetValues("//general/confirmation-dialogs/body/tools/tool",["id" "state"])
+ ans  =
+!console-exit         unchecked  !
+!delete-history-item  unchecked  !
+!console-clear        unchecked  !
+]]></screen>
     </refsection>
     <refsection role="see also">
         <title>参照</title>
         <simplelist type="inline">
             <member>
-                <link linkend="scinotes">scinotes</link>
+                <link linkend="xmlGetValues">xmlGetValues</link>
+            </member>
+            <member>
+                <link linkend="ieee">ieee</link>
+            </member>
+            <member>
+                <link linkend="format">format</link>
+            </member>
+            <member>
+                <link linkend="lines">lines</link>
+            </member>
+            <member>
+                <link linkend="mode">mode</link>
+            </member>
+            <member>
+                <link linkend="funcprot">funcprot</link>
+            </member>
+            <member>
+                <link linkend="setdefaultlanguage">setdefaultlanguage</link>
+            </member>
+            <member>
+                <link linkend="setlookandfeel">setlookandfeel</link>
+            </member>
+            <member>
+                <link linkend="printsetupbox">printsetupbox</link>
+            </member>
+            <member>
+                <link linkend="recursionlimit">recursionlimit</link>
+            </member>
+            <member>
+                <link linkend="odeoptions">odeoptions</link>
+            </member>
+            <member>
+                <link linkend="csvDefault">csvDefault</link>
+            </member>
+            <member>
+                <link linkend="xlfont">xlfont</link>
+            </member>
+            <member>
+                <link linkend="startup">startup</link>
+            </member>
+            <member>
+                <link linkend="atomsGetConfig">atomsGetConfig</link>
             </member>
         </simplelist>
     </refsection>
+    <refsection role="history">
+        <title>履歴</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revdescription>
+                    Function introduced
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
diff --git a/scilab/modules/preferences/help/ru_RU/preferences.xml b/scilab/modules/preferences/help/ru_RU/preferences.xml
new file mode 100644 (file)
index 0000000..76710f7
--- /dev/null
@@ -0,0 +1,137 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2009 - DIGITEO - Sylvestre KOUMAR
+ * Copyright (C) 2012 - 2016 - Scilab Enterprises
+ * Copyright (C) 2019 - Samuel GOUGEON
+ *
+ * This file is hereby licensed under the terms of the GNU GPL v2.0,
+ * pursuant to article 5.3.4 of the CeCILL v.2.1.
+ * This file was originally licensed under the terms of the CeCILL v2.1,
+ * and continues to be available under such terms.
+ * For more information, see the COPYING file which you should have received
+ * along with this program.
+ *
+ -->
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
+          xmlns:scilab="http://www.scilab.org" xml:id="preferences" xml:lang="ru">
+    <refnamediv>
+        <refname>preferences</refname>
+        <refpurpose>Открывает окно настроек Scilab'а</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv>
+        <title>Синтаксис</title>
+        <synopsis>
+            preferences()
+        </synopsis>
+    </refsynopsisdiv>
+    <refsection>
+        <title>Описание</title>
+        <para>
+            Открывает окно настроек Scilab'а.
+        </para>
+        <para>
+            <inlinemediaobject>
+                <imageobject>
+                    <imagedata fileref="../images/preferences_gui_en_US.png"  valign="middle"/>
+                </imageobject>
+            </inlinemediaobject>
+        </para>
+    </refsection>
+    <refsection>
+        <title>Примеры</title>
+        <programlisting role="example"><![CDATA[
+preferences()
+
+// Назначение выбранного раздела:
+jdeff org.scilab.modules.preferences.XConfigManager openPreferences prefs; // единожды для всех
+prefs general/shortcuts
+prefs scinotes/display
+ ]]></programlisting>
+      <para>
+        <emphasis role="bold">Правит файл ваших главных пользовательских настроек</emphasis>
+        (не следует править его содержание руками):
+      </para>
+        <programlisting role="example"><![CDATA[
+scinotes SCIHOME/XConfiguration.xml readonly
+ ]]></programlisting>
+    <para/>
+    <para>
+        <emphasis role="bold">Как получить некоторые значения настроек:</emphasis>
+        Например : Получить из файла главных настрек статус запроса-подтверждений (ask-for-confirmations):
+    </para>
+        <programlisting role="example"><![CDATA[
+xmlGetValues("//general/confirmation-dialogs/body/tools/tool",["id" "state"])
+     ]]></programlisting>
+    <screen><![CDATA[
+--> xmlGetValues("//general/confirmation-dialogs/body/tools/tool",["id" "state"])
+ ans  =
+!console-exit         unchecked  !
+!delete-history-item  unchecked  !
+!console-clear        unchecked  !
+]]></screen>
+    </refsection>
+    <refsection role="see also">
+        <title>Смотрите также</title>
+        <simplelist type="inline">
+            <member>
+                <link linkend="xmlGetValues">xmlGetValues</link>
+            </member>
+            <member>
+                <link linkend="ieee">ieee</link>
+            </member>
+            <member>
+                <link linkend="format">format</link>
+            </member>
+            <member>
+                <link linkend="lines">lines</link>
+            </member>
+            <member>
+                <link linkend="mode">mode</link>
+            </member>
+            <member>
+                <link linkend="funcprot">funcprot</link>
+            </member>
+            <member>
+                <link linkend="setdefaultlanguage">setdefaultlanguage</link>
+            </member>
+            <member>
+                <link linkend="setlookandfeel">setlookandfeel</link>
+            </member>
+            <member>
+                <link linkend="printsetupbox">printsetupbox</link>
+            </member>
+            <member>
+                <link linkend="recursionlimit">recursionlimit</link>
+            </member>
+            <member>
+                <link linkend="odeoptions">odeoptions</link>
+            </member>
+            <member>
+                <link linkend="csvDefault">csvDefault</link>
+            </member>
+            <member>
+                <link linkend="xlfont">xlfont</link>
+            </member>
+            <member>
+                <link linkend="startup">startup</link>
+            </member>
+            <member>
+                <link linkend="atomsGetConfig">atomsGetConfig</link>
+            </member>
+        </simplelist>
+    </refsection>
+    <refsection role="history">
+        <title>История</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.4.0</revnumber>
+                <revdescription>
+                    Функция введена.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
+</refentry>