* Bug #13677 fixed - Indentation of examples in assert_checkerror help page was wrong. 97/15597/2
Vincent COUVERT [Wed, 26 Nov 2014 15:44:39 +0000 (16:44 +0100)]
Change-Id: If90d6a38f0983308e1b66587a03c346ccf22dbfb

scilab/CHANGES_5.5.X
scilab/modules/development_tools/help/en_US/assert/assert_checkerror.xml
scilab/modules/development_tools/help/ja_JP/assert/assert_checkerror.xml

index d36d6d4..d306e59 100644 (file)
@@ -25,6 +25,9 @@ Scilab Bug Fixes
 
 * Bug #13673 fixed - Anti-aliasing of xpoly marks did not render correctly.
 
+* Bug #13677 fixed - Indentation of examples in assert_checkerror help page was wrong.
+
+
                      Changes between version 5.5.0 and 5.5.1
                      =======================================
 
index c9aadea..b94c2d5 100644 (file)
             the number of input arguments in wrong or the type of <literal>x</literal>
             is wrong.
         </para>
-        <programlisting role="example">function y = f(x)
-            [lhs, rhs] = argn()
-            if ( rhs &lt;&gt; 1 ) then
-            lstr = gettext("%s: Wrong number of input argument: %d expected.\n")
-            errmsg = msprintf ( lstr , "f" , 1 )
-            error(errmsg)
-            end
-            if ( typeof(x) &lt;&gt; "constant" ) then
-            lstr = gettext("%s: Wrong type for argument #%d: Matrix expected.\n")
-            errmsg = msprintf ( lstr , "f" , 1 )
-            error(errmsg,123456789)
-            end
-            y = x
-            endfunction    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+function y = f(x)
+    [lhs, rhs] = argn()
+    if ( rhs <> 1 ) then
+        lstr = gettext("%s: Wrong number of input argument: %d expected.\n")
+        errmsg = msprintf ( lstr , "f" , 1 )
+        error(errmsg)
+    end
+    if ( typeof(x) <> "constant" ) then
+        lstr = gettext("%s: Wrong type for argument #%d: Matrix expected.\n")
+        errmsg = msprintf ( lstr , "f" , 1 )
+        error(errmsg,123456789)
+    end
+    y = x
+endfunction
+        ]]></programlisting>
         <para>Our task is to check the error messages produced by this function.
             The two following tests pass: the error message is the expected one. We
             let <literal>assert_checkerror</literal> manage the localization, by
             <literal>assert_checkerror</literal> to format the message and to convert
             the "%s" and "%d" formats into their actual values.
         </para>
-        <programlisting role="example">lcl1 = "%s: Wrong number of input argument: %d expected.\n";
-            assert_checkerror ( "y = f()"      , lcl1 , [] , "f" , 1);
-            
-            lcl2 = "%s: Wrong type for argument #%d: Matrix expected.\n";
-            assert_checkerror ( "y = f(""a"")" , lcl2 , [] , "f" , 1);    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+lcl1 = "%s: Wrong number of input argument: %d expected.\n";
+assert_checkerror ( "y = f()" , lcl1 , [] , "f" , 1);
+
+lcl2 = "%s: Wrong type for argument #%d: Matrix expected.\n";
+assert_checkerror ( "y = f(""a"")" , lcl2 , [] , "f" , 1);
+        ]]></programlisting>
         <para>On the other hand, if we make the assumption that the current locale
             language is english, we could as well use the following statement. But
             this is not a recommended practice, since the test will fail if the
             current locale is French, for example.
         </para>
-        <programlisting role="example">assert_checkerror ( "y = f()" , "f: Wrong number of input argument: 1 expected." );   </programlisting>
+        <programlisting role="example"><![CDATA[
+assert_checkerror ( "y = f()" , "f: Wrong number of input argument: 1 expected." );
+        ]]></programlisting>
         <para>In the following test, we also check the error number.</para>
-        <programlisting role="example">lcl1="%s: Wrong number of input argument: %d expected.\n";
-            assert_checkerror ( "y=f()" ,      lcl1 , 10000     , "f" , 1);
-            
-            lcl2 = "%s: Wrong type for argument #%d: Matrix expected.\n";
-            assert_checkerror ( "y=f(""a"")" , lcl2 , 123456789 , "f" , 1);    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+lcl1="%s: Wrong number of input argument: %d expected.\n";
+assert_checkerror ( "y=f()" , lcl1 , 10000     , "f" , 1);
+
+lcl2 = "%s: Wrong type for argument #%d: Matrix expected.\n";
+assert_checkerror ( "y=f(""a"")" , lcl2 , 123456789 , "f" , 1);
+        ]]></programlisting>
         <para>The two following tests fail.</para>
-        <programlisting role="example">assert_checkerror ( "y = f()" , "oups" );
-            
-            msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
-            assert_checkerror ( "y = f()" , msg1 , 12 );    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+assert_checkerror ( "y = f()" , "oups" );
+
+msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
+assert_checkerror ( "y = f()" , msg1 , 12 );
+        ]]></programlisting>
         <para>When errmsg is given as output argument, no error is generated, as
             in the following example. Notice the content of the
             <literal>flag</literal> and <literal>errmsg</literal> variables.
         </para>
-        <programlisting role="example">// A test which pass: flag is %t, errmsg is empty
-            msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
-            [flag, errmsg] = assert_checkerror ( "y = f()" , msg1 )
-            
-            // A test which fail: flag is %f, errmsg is not empty
-            [flag, errmsg] = assert_checkerror ( "y = f()" , "oups" )    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+// A test which pass: flag is %t, errmsg is empty
+msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
+[flag, errmsg] = assert_checkerror ( "y = f()" , msg1 )
+
+// A test which fail: flag is %f, errmsg is not empty
+[flag, errmsg] = assert_checkerror ( "y = f()" , "oups" )
+        ]]></programlisting>
         <para>The messages in the two following tests are localized, so that they
             can work whatever the current language is. Instead of using the extra
             parameter <literal>a1</literal>, we directly localize the message, which
             is less short, but is a perfectly valid code.
         </para>
-        <programlisting role="example">msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
-            assert_checkerror ( "y = f()"      , msg1 );
-            
-            msg2 = msprintf(gettext("%s: Wrong type for argument #%d: Matrix expected.\n"), "f", 1);
-            assert_checkerror ( "y = f(""a"")" , msg2 );
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
+assert_checkerror ( "y = f()" , msg1 );
+
+msg2 = msprintf(gettext("%s: Wrong type for argument #%d: Matrix expected.\n"), "f", 1);
+assert_checkerror ( "y = f(""a"")" , msg2 );
+        ]]></programlisting>
         <para>It may happen that we want to just test the error number, but not
             the error message. The following script just checks that the generated
             error number is 123456789 when the first argument is not a matrix of
             doubles: we do not check the error message.
         </para>
-        <programlisting role="example">assert_checkerror("f(""foo"")", [], 123456789);</programlisting>
+        <programlisting role="example"><![CDATA[
+assert_checkerror("f(""foo"")", [], 123456789);
+        ]]></programlisting>
     </refsection>
     <refsection>
         <title>History</title>
index c7066d6..57d3517 100644 (file)
             入力引数の数が間違っているか<literal>x</literal>の型が間違っている
             場合にエラーを発生します.
         </para>
-        <programlisting role="example">function y = f(x)
-            [lhs, rhs] = argn()
-            if ( rhs &lt;&gt; 1 ) then
-            lstr = gettext("%s: Wrong number of input argument: %d expected.\n")
-            errmsg = msprintf ( lstr , "f" , 1 )
-            error(errmsg)
-            end
-            if ( typeof(x) &lt;&gt; "constant" ) then
-            lstr = gettext("%s: Wrong type for argument #%d: Matrix expected.\n")
-            errmsg = msprintf ( lstr , "f" , 1 )
-            error(errmsg,123456789)
-            end
-            y = x
-            endfunction    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+function y = f(x)
+    [lhs, rhs] = argn()
+    if ( rhs <> 1 ) then
+        lstr = gettext("%s: Wrong number of input argument: %d expected.\n")
+        errmsg = msprintf ( lstr , "f" , 1 )
+        error(errmsg)
+    end
+    if ( typeof(x) <> "constant" ) then
+        lstr = gettext("%s: Wrong type for argument #%d: Matrix expected.\n")
+        errmsg = msprintf ( lstr , "f" , 1 )
+        error(errmsg,123456789)
+    end
+    y = x
+endfunction
+        ]]></programlisting>
         <para>
             我々のタスクは,この関数により生成されたエラーメッセージを確認することです.
             以下の2つのテストをパスします:
             メッセージを整形し,
             "%s" および "%d" フォーマットを実際の値に変換する際に使用されます.
         </para>
-        <programlisting role="example">lcl1 = "%s: Wrong number of input argument: %d expected.\n";
-            assert_checkerror ( "y = f()"      , lcl1 , [] , "f" , 1);
-            lcl2 = "%s: Wrong type for argument #%d: Matrix expected.\n";
-            assert_checkerror ( "y = f(""a"")" , lcl2 , [] , "f" , 1);    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+lcl1 = "%s: Wrong number of input argument: %d expected.\n";
+assert_checkerror ( "y = f()" , lcl1 , [] , "f" , 1);
+
+lcl2 = "%s: Wrong type for argument #%d: Matrix expected.\n";
+assert_checkerror ( "y = f(""a"")" , lcl2 , [] , "f" , 1);
+        ]]></programlisting>
         <para>
             ここで,カレントのロケール言語が英語であると仮定すると,
             以下のコードを正しく使用できます.
             しかし,例えばカレントのロケールがフランス語である場合に失敗するため,
             これは推奨される手法ではありません.
         </para>
-        <programlisting role="example">assert_checkerror ( "y = f()" , "f: Wrong number of input argument: 1 expected." );   </programlisting>
+        <programlisting role="example"><![CDATA[
+assert_checkerror ( "y = f()" , "f: Wrong number of input argument: 1 expected." );
+        ]]></programlisting>
         <para>以下のテストでは, エラー番号も確認します.</para>
-        <programlisting role="example">lcl1="%s: Wrong number of input argument: %d expected.\n";
-            assert_checkerror ( "y=f()" ,      lcl1 , 10000     , "f" , 1);
-            lcl2 = "%s: Wrong type for argument #%d: Matrix expected.\n";
-            assert_checkerror ( "y=f(""a"")" , lcl2 , 123456789 , "f" , 1);    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+lcl1="%s: Wrong number of input argument: %d expected.\n";
+assert_checkerror ( "y=f()" , lcl1 , 10000 , "f" , 1);
+
+lcl2 = "%s: Wrong type for argument #%d: Matrix expected.\n";
+assert_checkerror ( "y=f(""a"")" , lcl2 , 123456789 , "f" , 1);
+        ]]></programlisting>
         <para>以下の2つのテストは失敗します.</para>
-        <programlisting role="example">assert_checkerror ( "y = f()" , "oups" );
-            msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
-            assert_checkerror ( "y = f()" , msg1 , 12 );    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+assert_checkerror ( "y = f()" , "oups" );
+msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
+assert_checkerror ( "y = f()" , msg1 , 12 );
+        ]]></programlisting>
         <para>
             errmsgが出力引数に指定された場合,以下の例のように,エラーが生成されます.
             変数<literal>flag</literal> および <literal>errmsg</literal>の内容に
             注意してください.
         </para>
-        <programlisting role="example">// パスするテスト: flag は %t, errmsg は空
-            msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
-            [flag, errmsg] = assert_checkerror ( "y = f()" , msg1 )
-            // 失敗するテスト: flag は %f, errmsg は空でない
-            [flag, errmsg] = assert_checkerror ( "y = f()" , "oups" )    
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+// パスするテスト: flag は %t, errmsg は空
+msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
+[flag, errmsg] = assert_checkerror ( "y = f()" , msg1 )
+// 失敗するテスト: flag は %f, errmsg は空でない
+[flag, errmsg] = assert_checkerror ( "y = f()" , "oups" )
+        ]]></programlisting>
         <para>
             以下の2つのテストのメッセージはローカライズされており,
             カレントの言語が何であっても動作します.
             長くはなりますが,完全に有効なコードである
             ローカライズされたメッセージを直接使用します.
         </para>
-        <programlisting role="example">msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
-            assert_checkerror ( "y = f()"      , msg1 );
-            msg2 = msprintf(gettext("%s: Wrong type for argument #%d: Matrix expected.\n"), "f", 1);
-            assert_checkerror ( "y = f(""a"")" , msg2 );
-        </programlisting>
+        <programlisting role="example"><![CDATA[
+msg1 = msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"), "f", 1);
+assert_checkerror ( "y = f()" , msg1 );
+msg2 = msprintf(gettext("%s: Wrong type for argument #%d: Matrix expected.\n"), "f", 1);
+assert_checkerror ( "y = f(""a"")" , msg2 );
+        ]]></programlisting>
         <para>
             エラー番号を確認したいがエラーメッセージは確認したくない場合がありえます.
             以下のスクリプトは,
             生成されるエラー番号が 123456789 であることのみを
             確認します: エラーメッセージは確認しません.
         </para>
-        <programlisting role="example">assert_checkerror("f(""foo"")", [], 123456789);</programlisting>
+        <programlisting role="example"><![CDATA[
+assert_checkerror("f(""foo"")", [], 123456789);
+        ]]></programlisting>
     </refsection>
     <refsection>
         <title>履歴</title>