[doc] broken linkend fixed
[scilab.git] / scilab / modules / xcos / help / en_US / scilab_utilities_functions / standard_define.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="standard_define">
3     <refnamediv>
4         <refname>standard_define</refname>
5         <refpurpose>Define a block from its interface as in Xcos editor.</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>[block] = standard_define(sz, model, exprs)
10         </synopsis>
11     </refsynopsisdiv>
12     <refsection>
13         <title>Arguments</title>
14         <variablelist>
15             <varlistentry>
16                 <term>block</term>
17                 <listitem>
18                     <para>xcos block.</para>
19                 </listitem>
20             </varlistentry>
21             <varlistentry>
22                 <term>sz</term>
23                 <listitem>
24                     <para>
25                         <varname>[height, width]</varname> size of the block.
26                     </para>
27                 </listitem>
28             </varlistentry>
29             <varlistentry>
30                 <term>model</term>
31                 <listitem>
32                     <para>
33                       The <link linkend="scicos_model">part of the block</link> that define its
34                       simulation interface.
35                     </para>
36                 </listitem>
37             </varlistentry>
38             <varlistentry>
39                 <term>exprs</term>
40                 <listitem>
41                     <para>
42                         The <link linkend="scicos_block_graphics_exprs">graphics.exprs</link> default parameters expressions.
43                     </para>
44                 </listitem>
45             </varlistentry>
46         </variablelist>
47     </refsection>
48     <refsection>
49         <title>Description</title>
50         <para>
51             This Scilab function is an helper used to allocate an Xcos block from an interfacing functions using a computed <link linkend="scicos_block_graphics">graphics</link> from a <link linkend="scicos_block_model">model</link> interface. It ensures that the ports match, that the size is similar to standard blocks and set the <link linkend="scicos_block_gui">gui</link> field.
52         </para>
53     </refsection>
54     <refsection role="see also">
55         <title>See also</title>
56         <simplelist type="inline">
57             <member>
58                 <link linkend="scicos_block">scicos_block</link>
59             </member>
60             <member>
61                 <link linkend="standard_outputs">standard_inputs</link>
62             </member>
63             <member>
64                 <link linkend="standard_outputs">standard_outputs</link>
65             </member>
66             <member>
67                 <link linkend="standard_origin">standard_origin</link>
68             </member>
69         </simplelist>
70     </refsection>
71 </refentry>