* Add some Xcos specific content to xcos_toolbox_skeleton help pages.
[scilab.git] / scilab / contrib / xcos_toolbox_skeleton / help / en_US / available_blocks.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: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" version="5.0-subset Scilab" xml:id="xcos_toolbox_skeleton_available_blocks">
3     <refnamediv>
4         <refname>Available blocks</refname>
5         <refpurpose>Example page to document some fonctionnalities</refpurpose>
6     </refnamediv>
7     <refsection>
8         <title>Schema</title>
9         <link type="scilab" linkend="xcos_toolbox_skeleton.xcos/demos/Blocks.zcos">Open the schema</link>
10         <para>
11             <inlinemediaobject>
12                 <imageobject>
13                     <imagedata align="center" fileref="../../demos/Blocks.zcos" valign="middle"/>
14                 </imageobject>
15             </inlinemediaobject>
16         </para>
17     </refsection>
18     <refsection>
19         <title>Description</title>
20         <para>
21             This page describe how to use the Xcos specific helptools provided with Scilab. Using these tools you can automatically generate a diagram view and add a link to open it inside Xcos.
22         </para>
23         <para>
24             To add a link to an Xcos schema inside an help page, you should use the standard <literal>link</literal> element with a <literal>type="scilab"</literal> attribute and a toolbox specific <literal>linkend</literal> url.
25         </para>
26         <para>
27             Example for the <literal>xcos_toolbox_skeleton</literal> toolbox:
28             
29         </para>
30         <programlisting role="xml"><![CDATA[
31 ...
32 <link type="scilab" linkend="xcos_toolbox_skeleton.xcos/demos/Blocks.zcos">Open the schema</link>
33 ...
34 ]]></programlisting>
35         <para>
36             To render an Xcos schema inside an help page, you should use the standard <literal>imagedata</literal> element with a <literal>fileref</literal> attribute to an Xcos schema.
37         </para>
38         <para>
39             Example for the <literal>xcos_toolbox_skeleton</literal> toolbox and the <literal>demos/Blocks.zcos</literal>:
40         </para>
41         <programlisting role="xml"><![CDATA[
42 ...
43 <inlinemediaobject>
44     <imageobject>
45         <imagedata align="center" fileref="../../demos/Blocks.zcos" valign="middle"/>
46     </imageobject>
47 </inlinemediaobject>
48 ...
49 ]]></programlisting>
50     </refsection>
51 </refentry>