Better doc for toolboxes, removed the unused DESCRIPTION-FUNCTIONS 43/17843/1
Francois Granade [Wed, 2 Mar 2016 14:51:05 +0000 (15:51 +0100)]
See also https://wiki.scilab.org/ATOMS#ATOMS_for_developers ,
and the recent commits to git@git.forge.scilab.org:atomscc.git ("rewrite" branch)

Once merged, need to be zipped and uploaded to http://atoms.scilab.org/toolboxes/toolbox_skeleton/
(or maybe we should **remove** the release 6 from atoms.scilab.org ? never good to have things in two places...)

Change-Id: I664b77da71cf6fce8081b261c035e4d3e35ef1e8

scilab/contrib/Makefile.am
scilab/contrib/Makefile.in
scilab/contrib/toolbox_skeleton.iss
scilab/contrib/toolbox_skeleton/DESCRIPTION-FUNCTIONS [deleted file]
scilab/contrib/toolbox_skeleton/readme.txt
scilab/contrib/xcos_toolbox_skeleton/DESCRIPTION-FUNCTIONS [deleted file]
scilab/contrib/xcos_toolbox_skeleton/readme.txt [new file with mode: 0644]

index e64abd2..472cac4 100644 (file)
@@ -15,7 +15,6 @@ toolbox_skeleton/demos/fortran_sum.dem.sce \
 toolbox_skeleton/demos/scilab_sum.dem.sce \
 toolbox_skeleton/demos/toolbox_skeleton.dem.gateway.sce \
 toolbox_skeleton/DESCRIPTION \
-toolbox_skeleton/DESCRIPTION-FUNCTIONS \
 toolbox_skeleton/etc/toolbox_skeleton_preferences.xml \
 toolbox_skeleton/etc/toolbox_skeleton_preferences.xsl \
 toolbox_skeleton/etc/toolbox_skeleton.quit \
@@ -86,7 +85,6 @@ xcos_toolbox_skeleton/demos/allSum.dem.sce \
 xcos_toolbox_skeleton/demos/Blocks.zcos \
 xcos_toolbox_skeleton/demos/xcos_toolbox_skeleton.dem.gateway.sce \
 xcos_toolbox_skeleton/DESCRIPTION \
-xcos_toolbox_skeleton/DESCRIPTION-FUNCTIONS \
 xcos_toolbox_skeleton/etc/xcos_toolbox_skeleton.quit \
 xcos_toolbox_skeleton/etc/xcos_toolbox_skeleton.start \
 xcos_toolbox_skeleton/examples/AllSum.zcos \
index 7167c72..ea25b68 100644 (file)
@@ -442,7 +442,6 @@ toolbox_skeleton/demos/fortran_sum.dem.sce \
 toolbox_skeleton/demos/scilab_sum.dem.sce \
 toolbox_skeleton/demos/toolbox_skeleton.dem.gateway.sce \
 toolbox_skeleton/DESCRIPTION \
-toolbox_skeleton/DESCRIPTION-FUNCTIONS \
 toolbox_skeleton/etc/toolbox_skeleton_preferences.xml \
 toolbox_skeleton/etc/toolbox_skeleton_preferences.xsl \
 toolbox_skeleton/etc/toolbox_skeleton.quit \
@@ -513,7 +512,6 @@ xcos_toolbox_skeleton/demos/allSum.dem.sce \
 xcos_toolbox_skeleton/demos/Blocks.zcos \
 xcos_toolbox_skeleton/demos/xcos_toolbox_skeleton.dem.gateway.sce \
 xcos_toolbox_skeleton/DESCRIPTION \
-xcos_toolbox_skeleton/DESCRIPTION-FUNCTIONS \
 xcos_toolbox_skeleton/etc/xcos_toolbox_skeleton.quit \
 xcos_toolbox_skeleton/etc/xcos_toolbox_skeleton.start \
 xcos_toolbox_skeleton/examples/AllSum.zcos \
index 6e148fe..e1372eb 100644 (file)
@@ -15,7 +15,6 @@ Source: contrib\{#TOOLBOX_SKELETON}\changelog.txt; DestDir: {app}\contrib\{#TOOL
 Source: contrib\{#TOOLBOX_SKELETON}\license.txt; DestDir: {app}\contrib\{#TOOLBOX_SKELETON}; Components: {#COMPN_TOOLBOX_SKELETON}
 Source: contrib\{#TOOLBOX_SKELETON}\readme.txt; DestDir: {app}\contrib\{#TOOLBOX_SKELETON}; Components: {#COMPN_TOOLBOX_SKELETON}
 Source: contrib\{#TOOLBOX_SKELETON}\DESCRIPTION; DestDir: {app}\contrib\{#TOOLBOX_SKELETON}; Components: {#COMPN_TOOLBOX_SKELETON}
-Source: contrib\{#TOOLBOX_SKELETON}\DESCRIPTION-FUNCTIONS; DestDir: {app}\contrib\{#TOOLBOX_SKELETON}; Components: {#COMPN_TOOLBOX_SKELETON}
 ;
 Source: contrib\{#TOOLBOX_SKELETON}\demos\*.*; DestDir: {app}\contrib\{#TOOLBOX_SKELETON}\demos; Components: {#COMPN_TOOLBOX_SKELETON}
 Source: contrib\{#TOOLBOX_SKELETON}\etc\toolbox_skeleton.quit; DestDir: {app}\contrib\{#TOOLBOX_SKELETON}\etc; Components: {#COMPN_TOOLBOX_SKELETON}
@@ -67,7 +66,6 @@ Source: contrib\{#TOOLBOX_SKELETON}\src\java\org\scilab\contrib\toolboxskeleton\
 ;--------------------------------------------------------------------------------------------------------------
 #define XCOS_TOOLBOX_SKELETON "xcos_toolbox_skeleton"
 Source: contrib\{#XCOS_TOOLBOX_SKELETON}\DESCRIPTION; DestDir: {app}\contrib\{#XCOS_TOOLBOX_SKELETON}; Flags: recursesubdirs; Components: {#COMPN_TOOLBOX_SKELETON} and {#COMPN_XCOS}
-Source: contrib\{#XCOS_TOOLBOX_SKELETON}\DESCRIPTION-FUNCTIONS; DestDir: {app}\contrib\{#XCOS_TOOLBOX_SKELETON}; Flags: recursesubdirs; Components: {#COMPN_TOOLBOX_SKELETON} and {#COMPN_XCOS}
 Source: contrib\{#XCOS_TOOLBOX_SKELETON}\license.txt; DestDir: {app}\contrib\{#XCOS_TOOLBOX_SKELETON}; Flags: recursesubdirs; Components: {#COMPN_TOOLBOX_SKELETON} and {#COMPN_XCOS}
 Source: contrib\{#XCOS_TOOLBOX_SKELETON}\builder.sce; DestDir: {app}\contrib\{#XCOS_TOOLBOX_SKELETON}; Flags: recursesubdirs; Components: {#COMPN_TOOLBOX_SKELETON} and {#COMPN_XCOS}
 Source: contrib\{#XCOS_TOOLBOX_SKELETON}\changelog.txt; DestDir: {app}\contrib\{#XCOS_TOOLBOX_SKELETON}; Flags: recursesubdirs; Components: {#COMPN_TOOLBOX_SKELETON} and {#COMPN_XCOS}
diff --git a/scilab/contrib/toolbox_skeleton/DESCRIPTION-FUNCTIONS b/scilab/contrib/toolbox_skeleton/DESCRIPTION-FUNCTIONS
deleted file mode 100644 (file)
index f66ea45..0000000
+++ /dev/null
@@ -1,5 +0,0 @@
-scilab_sum - scilab_sum from scilab
-fortran_sum - sum from fortran
-c_sum - sum from C
-c_sub - subtraction from C
-org.scilab.contrib.toolboxskeleton.Sum - Sum from Java
index ed1db5f..40d6cb8 100644 (file)
@@ -1,7 +1,7 @@
-readme.txt of the toolbox_skeleton
+This files is the readme.txt for your toolbox. 
 
-Please update this file to provide information about your toolbox:
-* what it is doing
-* the author
-* a few words about the license
+Please update this file to provide information about your toolbox: what it is doing, the author, a few words about the license...
 
+Do NOT keep this file as it is.
+
+See https://wiki.scilab.org/ATOMS#What_are_the_technical_expectations_.3F for more information on how to use the skeleton.
\ No newline at end of file
diff --git a/scilab/contrib/xcos_toolbox_skeleton/DESCRIPTION-FUNCTIONS b/scilab/contrib/xcos_toolbox_skeleton/DESCRIPTION-FUNCTIONS
deleted file mode 100644 (file)
index df855fb..0000000
+++ /dev/null
@@ -1,4 +0,0 @@
-TBX_SUM_c - block which perform a basic sum of the inputs
-tbx_sum - Scilab native function which perform the same operation as TBX_SUM.
-TBX_NOOP - Scilab or C no-op with any number of inputs and outputs
-
diff --git a/scilab/contrib/xcos_toolbox_skeleton/readme.txt b/scilab/contrib/xcos_toolbox_skeleton/readme.txt
new file mode 100644 (file)
index 0000000..40d6cb8
--- /dev/null
@@ -0,0 +1,7 @@
+This files is the readme.txt for your toolbox. 
+
+Please update this file to provide information about your toolbox: what it is doing, the author, a few words about the license...
+
+Do NOT keep this file as it is.
+
+See https://wiki.scilab.org/ATOMS#What_are_the_technical_expectations_.3F for more information on how to use the skeleton.
\ No newline at end of file