* xmltochm tagged as obsolete. Will be removed in Scilab 5.5.1. 59/14259/2
Vincent COUVERT [Mon, 31 Mar 2014 15:11:35 +0000 (17:11 +0200)]
Change-Id: I1a164b9ceccd14898e2d52f52e34d943477e9d60

scilab/CHANGES_5.5.X
scilab/modules/helptools/help/en_US/xmltochm.xml
scilab/modules/helptools/macros/xmltochm.sci
scilab/modules/helptools/tests/unit_tests/xmltochm.dia.ref [deleted file]
scilab/modules/helptools/tests/unit_tests/xmltochm.tst [deleted file]
scilab/modules/helptools/tests/unit_tests/xmltochm.win.dia.ref [deleted file]

index 458cd16..d4b0608 100644 (file)
@@ -218,6 +218,8 @@ Obsolete & Removed Functions
 * numdiff and derivative tagged as obsolete. Will be removed in Scilab 6.0.0.
   Please use numderivative instead.
 
+* xmltochm tagged as obsolete. Will be removed in Scilab 5.5.1.
+
 
 Compilation
 ============
index ae582cf..1ce20ad 100644 (file)
@@ -13,7 +13,9 @@
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="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="xmltochm" xml:lang="en">
     <refnamediv>
         <refname>xmltochm</refname>
-        <refpurpose>converts xml Scilab help files to Microsoft Compressed HTML format (Windows)</refpurpose>
+        <refpurpose>
+            converts xml Scilab help files to Microsoft Compressed HTML format (Windows). <emphasis role="bold">This function is obsolete.</emphasis>
+        </refpurpose>
     </refnamediv>
     <refsynopsisdiv>
         <title>Calling Sequence</title>
@@ -127,4 +129,15 @@ end
             </member>
         </simplelist>
     </refsection>
+    <refsection>
+        <title>History</title>
+        <revhistory>
+            <revision>
+                <revnumber>5.5.0</revnumber>
+                <revdescription>
+                    Function tagged obsolete. Will be removed in 5.5.1.
+                </revdescription>
+            </revision>
+        </revhistory>
+    </refsection>
 </refentry>
index eb2252e..bedc6e6 100644 (file)
@@ -10,6 +10,8 @@
 
 function generated_files = xmltochm(dirs,titles,directory_language,default_language)
 
+    warnobsolete(scilabRemovedVersion="5.5.1");
+
     all_scilab_help    = %F;
 
     if getos() <> "Windows" then
diff --git a/scilab/modules/helptools/tests/unit_tests/xmltochm.dia.ref b/scilab/modules/helptools/tests/unit_tests/xmltochm.dia.ref
deleted file mode 100644 (file)
index 8f26c55..0000000
+++ /dev/null
@@ -1,78 +0,0 @@
-// =============================================================================
-// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) 2009 - DIGITEO - Allan CORNET
-//
-//  This file is distributed under the same license as the Scilab package.
-// =============================================================================
-// <-- NO CHECK ERROR OUTPUT -->
-// <-- NEED JVM -->
-// xmltochm
-if getos() == 'Windows' then 
-// TEST 1 (french help and english help are complete)
-// =============================================================================
-tmpPath = TMPDIR + "/examples";
-copyfile("SCI/modules/helptools/examples", tmpPath);
-my_module_path = pathconvert(tmpPath + "/example_1",%f,%f);
-// Build the french help
-setlanguage("fr_FR");
-my_french_help_dir    =  my_module_path+"/help/fr_FR";
-my_french_help_title  =  "TEST 1 [fr_FR]";
-xmltochm(my_french_help_dir,my_french_help_title,"fr_FR");
-chm_info =  fileinfo(my_module_path+"/chm/scilab_fr_FR_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_french_help_dir);
-// Build the english help
-setlanguage("en_US");
-my_english_help_dir    =  my_module_path+"/help/en_US";
-my_english_help_title  =  "TEST 1 [en_US]";
-xmltochm(my_english_help_dir,my_english_help_title,'en_US');
-chm_info =  fileinfo(my_module_path+"/chm/scilab_en_US_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_english_help_dir);
-// TEST 2 (example_2_function_2 and example_2_function_4 are missing in the
-//         french help)
-// =============================================================================
-my_module_path = pathconvert(tmpPath + "/example_2",%f,%f);
-// Build the french help
-setlanguage("fr_FR");
-my_french_help_dir    =  my_module_path+"/help/fr_FR";
-my_french_help_title  =  "TEST 2 [fr_FR]";
-xmltochm(my_french_help_dir,my_french_help_title,'fr_FR');
-chm_info =  fileinfo(my_module_path+"/chm/scilab_fr_FR_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_french_help_dir);
-// Build the english help
-setlanguage("en_US");
-my_english_help_dir    =  my_module_path+"/help/en_US";
-my_english_help_title  =  "TEST 2 [en_US]";
-xmltochm(my_english_help_dir,my_english_help_title,'en_US');
-chm_info =  fileinfo(my_module_path+"/chm/scilab_en_US_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_english_help_dir);
-// TEST 3 (example_3_function_3 and example_3_function_4 are missing in the
-//         english help)
-// =============================================================================
-my_module_path = pathconvert(tmpPath + "/example_3",%f,%f);
-// Build the french help
-setlanguage("fr_FR");
-my_french_help_dir    =  my_module_path+"/help/fr_FR";
-my_french_help_title  =  "TEST 3 [fr_FR]";
-xmltochm(my_french_help_dir,my_french_help_title,"fr_FR");
-chm_info =  fileinfo(my_module_path+"/chm/scilab_fr_FR_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_french_help_dir);
-// Build the english help
-setlanguage("en_US");
-my_english_help_dir    =  my_module_path+"/help/en_US";
-my_english_help_title  =  "TEST 3 [en_US]";
-xmltochm(my_english_help_dir,my_english_help_title,"en_US","fr_FR");
-chm_info =  fileinfo(my_module_path+"/chm/scilab_en_US_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_english_help_dir);
-end // if getos() == 'Windows'
diff --git a/scilab/modules/helptools/tests/unit_tests/xmltochm.tst b/scilab/modules/helptools/tests/unit_tests/xmltochm.tst
deleted file mode 100644 (file)
index 269c01e..0000000
+++ /dev/null
@@ -1,115 +0,0 @@
-// =============================================================================
-// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) 2009 - DIGITEO - Allan CORNET
-//
-//  This file is distributed under the same license as the Scilab package.
-// =============================================================================
-// <-- NO CHECK ERROR OUTPUT -->
-// <-- NEED JVM -->
-
-// xmltochm
-
-if getos() == 'Windows' then 
-
-// TEST 1 (french help and english help are complete)
-// =============================================================================
-
-tmpPath = TMPDIR + "/examples";
-copyfile("SCI/modules/helptools/examples", tmpPath);
-my_module_path = pathconvert(tmpPath + "/example_1",%f,%f);
-
-// Build the french help
-
-setlanguage("fr_FR");
-my_french_help_dir    =  my_module_path+"/help/fr_FR";
-my_french_help_title  =  "TEST 1 [fr_FR]";
-xmltochm(my_french_help_dir,my_french_help_title,"fr_FR");
-
-chm_info =  fileinfo(my_module_path+"/chm/scilab_fr_FR_help.chm");
-if chm_info == [] then pause, end       // file existence
-if chm_info(1) < 5000 then pause, end   // file size
-
-clean_help(my_french_help_dir);
-
-// Build the english help
-
-setlanguage("en_US");
-my_english_help_dir    =  my_module_path+"/help/en_US";
-my_english_help_title  =  "TEST 1 [en_US]";
-xmltochm(my_english_help_dir,my_english_help_title,'en_US');
-
-chm_info =  fileinfo(my_module_path+"/chm/scilab_en_US_help.chm");
-if chm_info == [] then pause, end       // file existence
-if chm_info(1) < 5000 then pause, end   // file size
-
-clean_help(my_english_help_dir);
-
-
-
-// TEST 2 (example_2_function_2 and example_2_function_4 are missing in the
-//         french help)
-// =============================================================================
-
-my_module_path = pathconvert(tmpPath + "/example_2",%f,%f);
-
-// Build the french help
-
-setlanguage("fr_FR");
-my_french_help_dir    =  my_module_path+"/help/fr_FR";
-my_french_help_title  =  "TEST 2 [fr_FR]";
-xmltochm(my_french_help_dir,my_french_help_title,'fr_FR');
-
-chm_info =  fileinfo(my_module_path+"/chm/scilab_fr_FR_help.chm");
-if chm_info == [] then pause, end       // file existence
-if chm_info(1) < 5000 then pause, end   // file size
-
-clean_help(my_french_help_dir);
-
-// Build the english help
-
-setlanguage("en_US");
-my_english_help_dir    =  my_module_path+"/help/en_US";
-my_english_help_title  =  "TEST 2 [en_US]";
-xmltochm(my_english_help_dir,my_english_help_title,'en_US');
-
-chm_info =  fileinfo(my_module_path+"/chm/scilab_en_US_help.chm");
-if chm_info == [] then pause, end       // file existence
-if chm_info(1) < 5000 then pause, end   // file size
-
-clean_help(my_english_help_dir);
-
-
-
-// TEST 3 (example_3_function_3 and example_3_function_4 are missing in the
-//         english help)
-// =============================================================================
-
-my_module_path = pathconvert(tmpPath + "/example_3",%f,%f);
-
-// Build the french help
-
-setlanguage("fr_FR");
-my_french_help_dir    =  my_module_path+"/help/fr_FR";
-my_french_help_title  =  "TEST 3 [fr_FR]";
-xmltochm(my_french_help_dir,my_french_help_title,"fr_FR");
-
-chm_info =  fileinfo(my_module_path+"/chm/scilab_fr_FR_help.chm");
-if chm_info == [] then pause, end       // file existence
-if chm_info(1) < 5000 then pause, end   // file size
-
-clean_help(my_french_help_dir);
-
-// Build the english help
-
-setlanguage("en_US");
-my_english_help_dir    =  my_module_path+"/help/en_US";
-my_english_help_title  =  "TEST 3 [en_US]";
-xmltochm(my_english_help_dir,my_english_help_title,"en_US","fr_FR");
-
-chm_info =  fileinfo(my_module_path+"/chm/scilab_en_US_help.chm");
-if chm_info == [] then pause, end       // file existence
-if chm_info(1) < 5000 then pause, end   // file size
-
-clean_help(my_english_help_dir);
-
-end // if getos() == 'Windows'
\ No newline at end of file
diff --git a/scilab/modules/helptools/tests/unit_tests/xmltochm.win.dia.ref b/scilab/modules/helptools/tests/unit_tests/xmltochm.win.dia.ref
deleted file mode 100644 (file)
index 0cdd843..0000000
+++ /dev/null
@@ -1,120 +0,0 @@
-// =============================================================================
-// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) 2009 - DIGITEO - Allan CORNET
-//
-//  This file is distributed under the same license as the Scilab package.
-// =============================================================================
-// <-- NO CHECK ERROR OUTPUT -->
-// <-- NEED JVM -->
-// xmltochm
-if getos() == 'Windows' then 
-// TEST 1 (french help and english help are complete)
-// =============================================================================
-tmpPath = TMPDIR + "/examples";
-copyfile("SCI/modules/helptools/examples", tmpPath);
-my_module_path = pathconvert(tmpPath + "/example_1",%f,%f);
-// Build the french help
-setlanguage("fr_FR");
-my_french_help_dir    =  my_module_path+"/help/fr_FR";
-my_french_help_title  =  "TEST 1 [fr_FR]";
-xmltochm(my_french_help_dir,my_french_help_title,"fr_FR");
-
-Génération du document maître :
-       TMPDIR\examples\example_1\help\fr_FR
-
-Génération du fichier d'aide [chm] in TMPDIR\examples\example_1\help\fr_FR.
-chm_info =  fileinfo(my_module_path+"/chm/scilab_fr_FR_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_french_help_dir);
--- Suppression des fichiers d'aide --
-...
-// Build the english help
-setlanguage("en_US");
-my_english_help_dir    =  my_module_path+"/help/en_US";
-my_english_help_title  =  "TEST 1 [en_US]";
-xmltochm(my_english_help_dir,my_english_help_title,'en_US');
-
-Building the master document:
-       TMPDIR\examples\example_1\help\en_US
-
-Building the manual file [chm] in TMPDIR\examples\example_1\help\en_US.
-chm_info =  fileinfo(my_module_path+"/chm/scilab_en_US_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_english_help_dir);
--- Deleting help files --
-...
-// TEST 2 (example_2_function_2 and example_2_function_4 are missing in the
-//         french help)
-// =============================================================================
-my_module_path = pathconvert(tmpPath + "/example_2",%f,%f);
-// Build the french help
-setlanguage("fr_FR");
-my_french_help_dir    =  my_module_path+"/help/fr_FR";
-my_french_help_title  =  "TEST 2 [fr_FR]";
-xmltochm(my_french_help_dir,my_french_help_title,'fr_FR');
-
-Génération du document maître :
-       TMPDIR\examples\example_2\help\fr_FR
-
-Génération du fichier d'aide [chm] in TMPDIR\examples\example_2\help\fr_FR.
-chm_info =  fileinfo(my_module_path+"/chm/scilab_fr_FR_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_french_help_dir);
--- Suppression des fichiers d'aide --
-...
-// Build the english help
-setlanguage("en_US");
-my_english_help_dir    =  my_module_path+"/help/en_US";
-my_english_help_title  =  "TEST 2 [en_US]";
-xmltochm(my_english_help_dir,my_english_help_title,'en_US');
-
-Building the master document:
-       TMPDIR\examples\example_2\help\en_US
-
-Building the manual file [chm] in TMPDIR\examples\example_2\help\en_US.
-chm_info =  fileinfo(my_module_path+"/chm/scilab_en_US_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_english_help_dir);
--- Deleting help files --
-...
-// TEST 3 (example_3_function_3 and example_3_function_4 are missing in the
-//         english help)
-// =============================================================================
-my_module_path = pathconvert(tmpPath + "/example_3",%f,%f);
-// Build the french help
-setlanguage("fr_FR");
-my_french_help_dir    =  my_module_path+"/help/fr_FR";
-my_french_help_title  =  "TEST 3 [fr_FR]";
-xmltochm(my_french_help_dir,my_french_help_title,"fr_FR");
-
-Génération du document maître :
-       TMPDIR\examples\example_3\help\fr_FR
-
-Génération du fichier d'aide [chm] in TMPDIR\examples\example_3\help\fr_FR.
-chm_info =  fileinfo(my_module_path+"/chm/scilab_fr_FR_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_french_help_dir);
--- Suppression des fichiers d'aide --
-...
-// Build the english help
-setlanguage("en_US");
-my_english_help_dir    =  my_module_path+"/help/en_US";
-my_english_help_title  =  "TEST 3 [en_US]";
-xmltochm(my_english_help_dir,my_english_help_title,"en_US","fr_FR");
-
-Building the master document:
-       TMPDIR\examples\example_3\help\en_US
-
-Building the manual file [chm] in TMPDIR\examples\example_3\help\en_US.
-chm_info =  fileinfo(my_module_path+"/chm/scilab_en_US_help.chm");
-if chm_info == [] then bugmes();quit;end       // file existence
-if chm_info(1) < 5000 then bugmes();quit;end   // file size
-clean_help(my_english_help_dir);
--- Deleting help files --
-...
-end // if getos() == 'Windows'