* Add some Xcos specific content to xcos_toolbox_skeleton help pages. 28/11228/3
Clément DAVID [Fri, 5 Apr 2013 12:59:10 +0000 (14:59 +0200)]
Change-Id: Ia03659bdc3d9d14343baaf5856e697cfa78c30df

scilab/CHANGES_5.5.X
scilab/contrib/Makefile.am
scilab/contrib/Makefile.in
scilab/contrib/xcos_toolbox_skeleton/demos/Blocks.zcos [new file with mode: 0644]
scilab/contrib/xcos_toolbox_skeleton/help/en_US/available_blocks.xml [new file with mode: 0644]

index 2ddd28b..50ad75a 100644 (file)
@@ -38,6 +38,7 @@ Obsolete
   Only the following strings will be allowed : option : "r" "c" "g" "lr" "lc"
                                               direction : "d" "i"
 
+
 Xcos
 ====
 
@@ -48,6 +49,13 @@ Xcos
 * Bug #12384 fixed - Using a modelica part linked with explicit link to 
                      another modelica part lead to an algebraic loop error.
 
+
+Toolbox skeleton
+=================
+
+* Add some Xcos specific content to xcos_toolbox_skeleton help pages.
+
+
 Bug fixes
 ==========
 
index 3bd296b..ec0bf15 100644 (file)
@@ -65,6 +65,7 @@ toolbox_skeleton/toolbox_skeleton.iss \
 xcos_toolbox_skeleton/builder.sce \
 xcos_toolbox_skeleton/changelog.txt \
 xcos_toolbox_skeleton/cleaner.sce \
+xcos_toolbox_skeleton/demos/Blocks.zcos \
 xcos_toolbox_skeleton/demos/xcos_toolbox_skeleton.dem.gateway.sce \
 xcos_toolbox_skeleton/demos/allSum.dem.sce \
 xcos_toolbox_skeleton/DESCRIPTION \
@@ -74,6 +75,7 @@ xcos_toolbox_skeleton/etc/xcos_toolbox_skeleton.start \
 xcos_toolbox_skeleton/examples/AllSum.zcos \
 xcos_toolbox_skeleton/help/builder_help.sce \
 xcos_toolbox_skeleton/help/cleaner_help.sce \
+xcos_toolbox_skeleton/help/en_US/available_blocks.xml \
 xcos_toolbox_skeleton/help/en_US/build_help.sce \
 xcos_toolbox_skeleton/help/en_US/TBX_SUM_c.xml \
 xcos_toolbox_skeleton/help/en_US/tbx_sum.xml \
index 231ae45..5665cca 100644 (file)
@@ -408,6 +408,7 @@ toolbox_skeleton/toolbox_skeleton.iss \
 xcos_toolbox_skeleton/builder.sce \
 xcos_toolbox_skeleton/changelog.txt \
 xcos_toolbox_skeleton/cleaner.sce \
+xcos_toolbox_skeleton/demos/Blocks.zcos \
 xcos_toolbox_skeleton/demos/xcos_toolbox_skeleton.dem.gateway.sce \
 xcos_toolbox_skeleton/demos/allSum.dem.sce \
 xcos_toolbox_skeleton/DESCRIPTION \
@@ -417,6 +418,7 @@ xcos_toolbox_skeleton/etc/xcos_toolbox_skeleton.start \
 xcos_toolbox_skeleton/examples/AllSum.zcos \
 xcos_toolbox_skeleton/help/builder_help.sce \
 xcos_toolbox_skeleton/help/cleaner_help.sce \
+xcos_toolbox_skeleton/help/en_US/available_blocks.xml \
 xcos_toolbox_skeleton/help/en_US/build_help.sce \
 xcos_toolbox_skeleton/help/en_US/TBX_SUM_c.xml \
 xcos_toolbox_skeleton/help/en_US/tbx_sum.xml \
diff --git a/scilab/contrib/xcos_toolbox_skeleton/demos/Blocks.zcos b/scilab/contrib/xcos_toolbox_skeleton/demos/Blocks.zcos
new file mode 100644 (file)
index 0000000..3afff4e
Binary files /dev/null and b/scilab/contrib/xcos_toolbox_skeleton/demos/Blocks.zcos differ
diff --git a/scilab/contrib/xcos_toolbox_skeleton/help/en_US/available_blocks.xml b/scilab/contrib/xcos_toolbox_skeleton/help/en_US/available_blocks.xml
new file mode 100644 (file)
index 0000000..2f02ea1
--- /dev/null
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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">
+    <refnamediv>
+        <refname>Available blocks</refname>
+        <refpurpose>Example page to document some fonctionnalities</refpurpose>
+    </refnamediv>
+    <refsection>
+        <title>Schema</title>
+        <link type="scilab" linkend="xcos_toolbox_skeleton.xcos/demos/Blocks.zcos">Open the schema</link>
+        <para>
+            <inlinemediaobject>
+                <imageobject>
+                    <imagedata align="center" fileref="../../demos/Blocks.zcos" valign="middle"/>
+                </imageobject>
+            </inlinemediaobject>
+        </para>
+    </refsection>
+    <refsection>
+        <title>Description</title>
+        <para>
+            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.
+        </para>
+        <para>
+            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.
+        </para>
+        <para>
+            Example for the <literal>xcos_toolbox_skeleton</literal> toolbox:
+            
+        </para>
+        <programlisting role="xml"><![CDATA[
+...
+<link type="scilab" linkend="xcos_toolbox_skeleton.xcos/demos/Blocks.zcos">Open the schema</link>
+...
+]]></programlisting>
+        <para>
+            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.
+        </para>
+        <para>
+            Example for the <literal>xcos_toolbox_skeleton</literal> toolbox and the <literal>demos/Blocks.zcos</literal>:
+        </para>
+        <programlisting role="xml"><![CDATA[
+...
+<inlinemediaobject>
+    <imageobject>
+        <imagedata align="center" fileref="../../demos/Blocks.zcos" valign="middle"/>
+    </imageobject>
+</inlinemediaobject>
+...
+]]></programlisting>
+    </refsection>
+</refentry>