First part of doc_kit
Pierre Marechal [Fri, 14 Mar 2008 16:39:47 +0000 (16:39 +0000)]
48 files changed:
scilab/modules/helptools/bin/man2sci [new file with mode: 0755]
scilab/modules/helptools/bin/man2sci.bat [new file with mode: 0755]
scilab/modules/helptools/bin/manrev2sci [new file with mode: 0755]
scilab/modules/helptools/bin/manrev2sci.bat [new file with mode: 0755]
scilab/modules/helptools/bin/sci2chm.bat [new file with mode: 0755]
scilab/modules/helptools/bin/sci2html [new file with mode: 0755]
scilab/modules/helptools/bin/sci2html.bat [new file with mode: 0755]
scilab/modules/helptools/bin/sci2jh [new file with mode: 0755]
scilab/modules/helptools/bin/sci2jh.bat [new file with mode: 0755]
scilab/modules/helptools/bin/sci2pdf [new file with mode: 0755]
scilab/modules/helptools/bin/sci2pdf.bat [new file with mode: 0755]
scilab/modules/helptools/bin/scivalid [new file with mode: 0755]
scilab/modules/helptools/bin/scivalid.bat [new file with mode: 0755]
scilab/modules/helptools/bin/sciviewhelp [new file with mode: 0755]
scilab/modules/helptools/bin/sciviewhelp.bat [new file with mode: 0755]
scilab/modules/helptools/css/html.css [new file with mode: 0644]
scilab/modules/helptools/css/htmlhelp.css [new file with mode: 0644]
scilab/modules/helptools/css/javahelp.css [new file with mode: 0644]
scilab/modules/helptools/doc/addonprefs.png [new file with mode: 0644]
scilab/modules/helptools/doc/doc.pdf [new file with mode: 0644]
scilab/modules/helptools/doc/doc.xml [new file with mode: 0644]
scilab/modules/helptools/doc/html/ch01.html [new file with mode: 0644]
scilab/modules/helptools/doc/html/ch02.html [new file with mode: 0644]
scilab/modules/helptools/doc/html/ch03.html [new file with mode: 0644]
scilab/modules/helptools/doc/html/ch04.html [new file with mode: 0644]
scilab/modules/helptools/doc/html/ch05.html [new file with mode: 0644]
scilab/modules/helptools/doc/html/ch06.html [new file with mode: 0644]
scilab/modules/helptools/doc/html/ch07.html [new file with mode: 0644]
scilab/modules/helptools/doc/html/html.css [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/1.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/10.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/11.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/12.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/13.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/14.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/15.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/2.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/3.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/4.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/5.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/6.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/7.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/8.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/callouts/9.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/images/draft.png [new file with mode: 0644]
scilab/modules/helptools/doc/html/index.html [new file with mode: 0644]
scilab/modules/helptools/doc/html/resources/addonprefs.png [new file with mode: 0644]
scilab/modules/helptools/schema/scilab.rnc [new file with mode: 0644]

diff --git a/scilab/modules/helptools/bin/man2sci b/scilab/modules/helptools/bin/man2sci
new file mode 100755 (executable)
index 0000000..3db8bd0
--- /dev/null
@@ -0,0 +1,41 @@
+#!/bin/sh
+
+# Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+# Copyright (C) 2008 - INRIA
+#
+# This file must be used under the terms of the CeCILL.
+# This source file is licensed as described in the file COPYING, which
+# you should have received as part of this distribution.  The terms
+# are also available at
+# http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+
+if [ $# -ne 2 ]; then
+    echo "Usage: man2sci in_man_xml_file out_scilab_xml_file"
+    echo "Converts a document conforming to man.dtd to"
+    echo "a document conforming to scilab.rnc."
+    exit 1
+fi
+
+binDir=`dirname $0`
+libDir=$binDir/../lib
+convertDir=$binDir/../xsl/convert
+
+type xsltproc 1> /dev/null 2>&1
+if [ $? -eq 0 ]; then
+
+    xsltproc -o "$1.manrev" "$convertDir/man2manrev.xsl" "$1"
+
+    xsltproc -o "$2" "$convertDir/manrev2sci.xsl" "$1.manrev"
+
+else
+
+    java -jar "$libDir/saxon.jar" -o "$1.manrev" "$1" \
+        "$convertDir/man2manrev.xsl"
+
+    java -jar "$libDir/saxon.jar" -o "$2" "$1.manrev" \
+        "$convertDir/manrev2sci.xsl"
+
+fi
+
+rm -f "$1.manrev"
+
diff --git a/scilab/modules/helptools/bin/man2sci.bat b/scilab/modules/helptools/bin/man2sci.bat
new file mode 100755 (executable)
index 0000000..1d5386c
--- /dev/null
@@ -0,0 +1,34 @@
+rem Scilab ( http://www.scilab.org/ ) - This file is part of Scilab\r
+rem Copyright (C) 2008 - INRIA\r
+rem \r
+rem This file must be used under the terms of the CeCILL.\r
+rem This source file is licensed as described in the file COPYING, which\r
+rem you should have received as part of this distribution.  The terms\r
+rem are also available at\r
+rem http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt\r
+\r
+@echo off\r
+setlocal\r
+\r
+if "%2"=="" goto usage\r
+\r
+set binDir=%~dp0\r
+set libDir=%binDir%\..\lib\r
+set convDir=%binDir%\..\xsl\convert\r
+set tmpFile=%1.manrev\r
+\r
+java -jar "%libDir%\saxon.jar" -o "%tmpFile%" "%1" "%convDir%\man2manrev.xsl"\r
+\r
+java -jar "%libDir%\saxon.jar" -o "%2" "%tmpFile%" "%convDir%\manrev2sci.xsl"\r
+\r
+if exist "%tmpFile%" del /q "%tmpFile%"\r
+\r
+goto end\r
+endlocal\r
+\r
+:usage\r
+echo Usage: man2sci in_man_xml_file out_scilab_xml_file\r
+echo Converts a document conforming to man.dtd to\r
+echo a document conforming to scilab.rnc.\r
+\r
+:end\r
diff --git a/scilab/modules/helptools/bin/manrev2sci b/scilab/modules/helptools/bin/manrev2sci
new file mode 100755 (executable)
index 0000000..5f46602
--- /dev/null
@@ -0,0 +1,33 @@
+#!/bin/sh
+
+# Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+# Copyright (C) 2008 - INRIA
+#
+# This file must be used under the terms of the CeCILL.
+# This source file is licensed as described in the file COPYING, which
+# you should have received as part of this distribution.  The terms
+# are also available at
+# http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+
+if [ $# -ne 2 ]; then
+    echo "Usage: manrev2sci in_manrev_xml_file out_scilab_xml_file"
+    echo "Converts a document conforming to manrev.dtd to"
+    echo "a document conforming to scilab.rnc."
+    exit 1
+fi
+
+binDir=`dirname $0`
+libDir=$binDir/../lib
+convertDir=$binDir/../xsl/convert
+
+type xsltproc 1> /dev/null 2>&1
+if [ $? -eq 0 ]; then
+
+    xsltproc -o "$2" "$convertDir/manrev2sci.xsl" "$1"
+
+else
+
+    java -jar "$libDir/saxon.jar" -o "$2" "$1" \
+        "$convertDir/manrev2sci.xsl"
+
+fi
diff --git a/scilab/modules/helptools/bin/manrev2sci.bat b/scilab/modules/helptools/bin/manrev2sci.bat
new file mode 100755 (executable)
index 0000000..7ab2d3a
--- /dev/null
@@ -0,0 +1,29 @@
+rem Scilab ( http://www.scilab.org/ ) - This file is part of Scilab\r
+rem Copyright (C) 2008 - INRIA\r
+rem \r
+rem This file must be used under the terms of the CeCILL.\r
+rem This source file is licensed as described in the file COPYING, which\r
+rem you should have received as part of this distribution.  The terms\r
+rem are also available at\r
+rem http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt\r
+\r
+@echo off\r
+setlocal\r
+\r
+if "%2"=="" goto usage\r
+\r
+set binDir=%~dp0\r
+set libDir=%binDir%\..\lib\r
+set convDir=%binDir%\..\xsl\convert\r
+\r
+java -jar "%libDir%\saxon.jar" -o "%2" "%1" "%convDir%\manrev2sci.xsl"\r
+\r
+goto end\r
+endlocal\r
+\r
+:usage\r
+echo Usage: manrev2sci in_manrev_xml_file out_scilab_xml_file\r
+echo Converts a document conforming to manrev.dtd to\r
+echo a document conforming to scilab.rnc.\r
+\r
+:end\r
diff --git a/scilab/modules/helptools/bin/sci2chm.bat b/scilab/modules/helptools/bin/sci2chm.bat
new file mode 100755 (executable)
index 0000000..b407a29
--- /dev/null
@@ -0,0 +1,61 @@
+rem Scilab ( http://www.scilab.org/ ) - This file is part of Scilab\r
+rem Copyright (C) 2008 - INRIA\r
+rem \r
+rem This file must be used under the terms of the CeCILL.\r
+rem This source file is licensed as described in the file COPYING, which\r
+rem you should have received as part of this distribution.  The terms\r
+rem are also available at\r
+rem http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt\r
+\r
+@echo off\r
+setlocal\r
+\r
+if "%2"=="" goto usage\r
+\r
+rem MODIFY THIS IF NEEDED TO\r
+set hhc=C:\Program Files\HTML Help Workshop\hhc.exe\r
+\r
+set binDir=%~dp0\r
+set libDir=%binDir%\..\lib\r
+set docbookXslDir=%binDir%\..\docbook_xsl\r
+set cssDir=%binDir%\..\css\r
+\r
+set tmpDir=%TEMP%\sci2chm_tmp\r
+if exist "%tmpDir%" rmdir /s /q "%tmpDir%"\r
+mkdir "%tmpDir%"\r
+\r
+set flatXMLFile=%tmpDir%\%~n1.xml\r
+\r
+copy "%cssDir%\htmlhelp.css" "%tmpDir%"\r
+\r
+set cp=%libDir%\sci_doc_kit.jar;%libDir%\jeuclid-core.jar;%libDir%\commons-logging.jar;%libDir%\batik.jar;%libDir%\js.jar\r
+\r
+java -cp "%cp%" org.scilab.doc_kit.CopyConvert "%1" "%flatXMLFile%"\r
+\r
+java -Xmx512m -cp "%libDir%\saxon.jar;%libDir%\docbook-xsl-saxon.jar" com.icl.saxon.StyleSheet "%flatXMLFile%" "%docbookXslDir%\htmlhelp\htmlhelp.xsl"  base.dir="%tmpDir%\\" manifest.in.base.dir=1 html.stylesheet=htmlhelp.css use.extensions=1 graphicsize.extension=0 "generate.toc= "\r
+\r
+if exist "%flatXMLFile%" del /q "%flatXMLFile%"\r
+\r
+"%hhc%" "%tmpDir%\htmlhelp.hhp"\r
+move /y "%tmpDir%\htmlhelp.chm" "%2"\r
+\r
+if exist "%tmpDir%" rmdir /s /q "%tmpDir%"\r
+\r
+goto end\r
+endlocal\r
+\r
+:usage\r
+echo Usage: sci2chm in_xml_file out_chm_file\r
+echo Converts an XML document conforming to scilab.rnc\r
+echo to a Windows HTML Help ('.chm') file.\r
+echo By default, this script assumes that hhc.exe is found\r
+echo in "C:\Program Files\HTML Help Workshop\hhc.exe".\r
+echo If this is not the case, please modify the 'hhc'\r
+echo variable found at the beginning of this '.bat' file.\r
+\r
+:end\r
+\r
+\r
+\r
+\r
+\r
diff --git a/scilab/modules/helptools/bin/sci2html b/scilab/modules/helptools/bin/sci2html
new file mode 100755 (executable)
index 0000000..1294fc7
--- /dev/null
@@ -0,0 +1,62 @@
+#!/bin/sh
+
+# Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+# Copyright (C) 2008 - INRIA
+#
+# This file must be used under the terms of the CeCILL.
+# This source file is licensed as described in the file COPYING, which
+# you should have received as part of this distribution.  The terms
+# are also available at
+# http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+
+if [ $# -ne 2 ]; then
+    echo "Usage: sci2html in_xml_file out_html_directory"
+    echo "Converts an XML document conforming to scilab.rnc"
+    echo "to multi-page HTML."
+    exit 1
+fi
+
+binDir=`dirname $0`
+libDir=$binDir/../lib
+docbookXslDir=$binDir/../docbook_xsl
+cssDir=$binDir/../css
+
+baseName=`basename $1`
+flatXMLFile="$2/$baseName"
+
+cp=$libDir/sci_doc_kit.jar:\
+$libDir/jeuclid-core.jar:$libDir/commons-logging.jar:\
+$libDir/batik.jar:$libDir/js.jar
+
+java -cp "$cp" org.scilab.doc_kit.CopyConvert "$1" "$flatXMLFile"
+
+type xsltproc 1> /dev/null 2>&1
+if [ $? -eq 0 ]; then
+
+    xsltproc --stringparam base.dir "$2/" \
+        --stringparam use.id.as.filename 1 \
+        --stringparam html.stylesheet "html.css" \
+        --stringparam toc.section.depth 3 \
+        --stringparam section.autolabel 1 \
+            "$docbookXslDir/html/chunk.xsl" "$flatXMLFile"
+
+else
+
+    java -Xmx512m -cp "$libDir/saxon.jar:$libDir/docbook-xsl-saxon.jar" \
+        com.icl.saxon.StyleSheet \
+        "$flatXMLFile" \
+        "$docbookXslDir/html/chunk.xsl" \
+        base.dir="$2/" \
+        use.id.as.filename=1 \
+        html.stylesheet=html.css \
+        use.extensions=1 \
+        graphicsize.extension=0 \
+        toc.section.depth=3 \
+        section.autolabel=1
+
+fi
+
+rm -f "$flatXMLFile"
+cp "$cssDir/html.css" "$2"
+
+
diff --git a/scilab/modules/helptools/bin/sci2html.bat b/scilab/modules/helptools/bin/sci2html.bat
new file mode 100755 (executable)
index 0000000..d6c8a0c
--- /dev/null
@@ -0,0 +1,40 @@
+rem Scilab ( http://www.scilab.org/ ) - This file is part of Scilab\r
+rem Copyright (C) 2008 - INRIA\r
+rem \r
+rem This file must be used under the terms of the CeCILL.\r
+rem This source file is licensed as described in the file COPYING, which\r
+rem you should have received as part of this distribution.  The terms\r
+rem are also available at\r
+rem http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt\r
+\r
+@echo off\r
+setlocal\r
+\r
+if "%2"=="" goto usage\r
+\r
+set binDir=%~dp0\r
+set libDir=%binDir%\..\lib\r
+set docbookXslDir=%binDir%\..\docbook_xsl\r
+set cssDir=%binDir%\..\css\r
+\r
+set flatXMLFile=%2\%~n1.xml\r
+\r
+set cp=%libDir%\sci_doc_kit.jar;%libDir%\jeuclid-core.jar;%libDir%\commons-logging.jar;%libDir%\batik.jar;%libDir%\js.jar\r
+\r
+java -cp "%cp%" org.scilab.doc_kit.CopyConvert "%1" "%flatXMLFile%"\r
+\r
+java -Xmx512m -cp "%libDir%\saxon.jar;%libDir%\docbook-xsl-saxon.jar" com.icl.saxon.StyleSheet "%flatXMLFile%" "%docbookXslDir%\html\chunk.xsl" base.dir="%2\\" use.id.as.filename=1 html.stylesheet=html.css use.extensions=1 graphicsize.extension=0 toc.section.depth=3 section.autolabel=1\r
+\r
+if exist "%flatXMLFile%" del /q "%flatXMLFile%"\r
+\r
+copy "%cssDir%\html.css" "%2"\r
+\r
+goto end\r
+endlocal\r
+\r
+:usage\r
+echo Usage: sci2html in_xml_file out_html_directory\r
+echo Converts an XML document conforming to scilab.rnc\r
+echo to multi-page HTML.\r
+\r
+:end\r
diff --git a/scilab/modules/helptools/bin/sci2jh b/scilab/modules/helptools/bin/sci2jh
new file mode 100755 (executable)
index 0000000..4ed1c2b
--- /dev/null
@@ -0,0 +1,85 @@
+#!/bin/sh
+
+# Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+# Copyright (C) 2008 - INRIA
+#
+# This file must be used under the terms of the CeCILL.
+# This source file is licensed as described in the file COPYING, which
+# you should have received as part of this distribution.  The terms
+# are also available at
+# http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+
+if [ $# -ne 2 ]; then
+    echo "Usage: sci2jh in_xml_file out_javahelp_jar_file"
+    echo "Converts an XML document conforming to scilab.rnc"
+    echo "to a JavaHelp[tm] .jar file."
+    echo "out_javahelp_jar_file must end with '_help.jar'."
+    exit 1
+fi
+
+echo $2 | grep '^.*_help\.jar$' 1> /dev/null 2>&1
+if [ $? -ne 0 ]; then
+    echo "$2 must end with '_help.jar'."
+    exit 2
+fi
+
+type jar 1> /dev/null 2>&1
+if [ $? -ne 0 ]; then
+    echo "Don't find the 'jar' command-line utility."
+    exit 3
+fi
+
+binDir=`dirname $0`
+### Need an absolute directory
+binDir=`(cd $binDir 2> /dev/null && pwd;)`
+libDir=$binDir/../lib
+docbookXslDir=$binDir/../docbook_xsl
+cssDir=$binDir/../css
+
+helpset=`basename $2 .jar`
+helpsetDir="/tmp/$helpset"
+
+baseName=`basename $1`
+flatXMLFile="$helpsetDir/$baseName"
+
+rm -rf "$helpsetDir"
+mkdir "$helpsetDir"
+cp "$cssDir/javahelp.css" "$helpsetDir"
+
+cp=$libDir/sci_doc_kit.jar:\
+$libDir/jeuclid-core.jar:$libDir/commons-logging.jar:\
+$libDir/batik.jar:$libDir/js.jar
+
+java -cp "$cp" org.scilab.doc_kit.CopyConvert "$1" "$flatXMLFile"
+
+type xsltproc 1> /dev/null 2>&1
+if [ $? -eq 0 ]; then
+
+    xsltproc --stringparam base.dir "$helpsetDir/" \
+        --stringparam html.stylesheet "javahelp.css" \
+        --stringparam generate.toc " " \
+            "$docbookXslDir/javahelp/javahelp.xsl" "$flatXMLFile"
+
+else
+
+    java -Xmx512m -cp "$libDir/saxon.jar:$libDir/docbook-xsl-saxon.jar" \
+        com.icl.saxon.StyleSheet \
+        "$flatXMLFile" \
+        "$docbookXslDir/javahelp/javahelp.xsl" \
+        base.dir="$helpsetDir/" \
+        html.stylesheet=javahelp.css \
+        use.extensions=1 \
+        graphicsize.extension=0 \
+        "generate.toc= "
+
+fi
+
+rm -f "$flatXMLFile"
+
+### Do it this way or full text search will not work.
+(cd "$helpsetDir" ; \
+java -cp "$libDir/jhall.jar" com.sun.java.help.search.Indexer .)
+
+jar cf "$2" -C /tmp "$helpset"
+
+rm -rf "$helpsetDir"
diff --git a/scilab/modules/helptools/bin/sci2jh.bat b/scilab/modules/helptools/bin/sci2jh.bat
new file mode 100755 (executable)
index 0000000..d5899ae
--- /dev/null
@@ -0,0 +1,61 @@
+rem Scilab ( http://www.scilab.org/ ) - This file is part of Scilab\r
+rem Copyright (C) 2008 - INRIA\r
+rem \r
+rem This file must be used under the terms of the CeCILL.\r
+rem This source file is licensed as described in the file COPYING, which\r
+rem you should have received as part of this distribution.  The terms\r
+rem are also available at\r
+rem http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt\r
+\r
+@echo off\r
+setlocal\r
+\r
+if "%2"=="" goto usage\r
+\r
+set binDir=%~dp0\r
+set libDir=%binDir%\..\lib\r
+set docbookXslDir=%binDir%\..\docbook_xsl\r
+set cssDir=%binDir%\..\css\r
+\r
+set helpset=%~n2\r
+set helpsetDir=%TEMP%\%helpset%\r
+\r
+set flatXMLFile=%helpsetDir%\%~n1.xml\r
+\r
+if exist "%helpsetDir%" rmdir /s /q "%helpsetDir%"\r
+mkdir "%helpsetDir%"\r
+\r
+copy "%cssDir%\javahelp.css" "%helpsetDir%"\r
+\r
+set cp=%libDir%\sci_doc_kit.jar;%libDir%\jeuclid-core.jar;%libDir%\commons-logging.jar;%libDir%\batik.jar;%libDir%\js.jar\r
+\r
+java -cp "%cp%" org.scilab.doc_kit.CopyConvert "%1" "%flatXMLFile%"\r
+\r
+java -Xmx512m -cp "%libDir%\saxon.jar;%libDir%\docbook-xsl-saxon.jar" com.icl.saxon.StyleSheet "%flatXMLFile%" "%docbookXslDir%\javahelp\javahelp.xsl"  base.dir="%helpsetDir%\\" html.stylesheet=javahelp.css use.extensions=1 graphicsize.extension=0 "generate.toc= "\r
+\r
+if exist "%flatXMLFile%" del /q "%flatXMLFile%"\r
+\r
+rem Do it this way or full text search will not work.\r
+set pwd=%CD%\r
+chdir /d "%helpsetDir%" \r
+java -cp "%libDir%\jhall.jar" com.sun.java.help.search.Indexer .\r
+chdir /d "%pwd%"\r
+\r
+jar cf "%2" -C "%TEMP%" "%helpset%"\r
+\r
+if exist "%helpsetDir%" rmdir /s /q "%helpsetDir%"\r
+\r
+goto end\r
+endlocal\r
+\r
+:usage\r
+echo Usage: sci2jh in_xml_file out_javahelp_jar_file\r
+echo Converts an XML document conforming to scilab.rnc\r
+echo to a JavaHelp[tm] .jar file.\r
+echo out_javahelp_jar_file must end with '_help.jar'.\r
+\r
+:end\r
+\r
+\r
+\r
+\r
diff --git a/scilab/modules/helptools/bin/sci2pdf b/scilab/modules/helptools/bin/sci2pdf
new file mode 100755 (executable)
index 0000000..358796f
--- /dev/null
@@ -0,0 +1,98 @@
+#!/bin/sh
+
+# Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+# Copyright (C) 2008 - INRIA
+#
+# This file must be used under the terms of the CeCILL.
+# This source file is licensed as described in the file COPYING, which
+# you should have received as part of this distribution.  The terms
+# are also available at
+# http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+
+if [ $# -ne 2 ]; then
+    echo "Usage: sci2pdf in_xml_file out_pdf_or_ps_file"
+    echo "Converts an XML document conforming to scilab.rnc to PDF"
+    echo "or to PostScript."
+    echo "A PostScript file is generated if out_pdf_or_ps_file ends"
+    echo "with '.ps'."
+    exit 1
+fi
+
+echo $2 | grep '^.*\.ps$' 1> /dev/null 2>&1
+if [ $? -eq 0 ]; then
+    format=-ps
+else
+    format=-pdf
+fi
+
+binDir=`dirname $0`
+libDir=$binDir/../lib
+### This XSL style sheet fixes bugs in ../docbook_xsl/fo/htmltbl.xsl
+docbookXslDir=$binDir/../xsl
+
+foDir=/tmp/sci2pdf_tmp
+rm -rf "$foDir"
+mkdir "$foDir"
+
+baseName=`basename $1`
+flatXMLFile="$foDir/$baseName"
+
+foFile="$foDir/__doc.fo"
+
+cp=$libDir/sci_doc_kit.jar:\
+$libDir/jeuclid-core.jar:$libDir/commons-logging.jar:\
+$libDir/batik.jar:$libDir/js.jar
+
+java -cp "$cp" org.scilab.doc_kit.CopyConvert $format "$1" "$flatXMLFile"
+
+type xsltproc 1> /dev/null 2>&1
+if [ $? -eq 0 ]; then
+
+    xsltproc -o "$foFile" \
+        --stringparam paper.type A4 \
+        --stringparam generate.toc "book toc,title,figure,table,example,equation part toc,title reference toc,title" \
+        --stringparam toc.section.depth 3 \
+        --stringparam section.autolabel 1 \
+        --stringparam variablelist.as.blocks 1 \
+        --stringparam shade.verbatim 1 \
+            "$docbookXslDir/fo/docbook.xsl" "$flatXMLFile"
+
+else
+
+    java -Xmx512m -cp "$libDir/saxon.jar:$libDir/docbook-xsl-saxon.jar" \
+        com.icl.saxon.StyleSheet \
+        -o "$foFile" \
+        "$flatXMLFile" \
+        "$docbookXslDir/fo/docbook.xsl" \
+        use.extensions=1 \
+        graphicsize.extension=0 \
+        paper.type=A4 \
+        "generate.toc=book toc,title,figure,table,example,equation part toc,title reference toc,title" \
+        toc.section.depth=3 \
+        section.autolabel=1 \
+        variablelist.as.blocks=1 \
+        shade.verbatim=1
+
+fi
+
+type xep 1> /dev/null 2>&1
+if [ $? -eq 0 ]; then
+
+    xep -valid -fo "$foFile" $format "$2"
+
+else
+
+    cp2=$libDir/fop.jar:$libDir/fop-hyph.jar:$libDir/avalon-framework.jar:\
+$libDir/commons-io.jar:$libDir/commons-logging.jar:\
+$libDir/xmlgraphics-commons.jar:\
+$libDir/jimi.jar:\
+$libDir/batik.jar:$libDir/js.jar
+
+    java -Xmx512m -cp "$cp2" org.apache.fop.cli.Main \
+        -dpi 120 -r -fo "$foFile" $format "$2"
+
+fi
+
+rm -rf "$foDir"
+
+
diff --git a/scilab/modules/helptools/bin/sci2pdf.bat b/scilab/modules/helptools/bin/sci2pdf.bat
new file mode 100755 (executable)
index 0000000..faa2421
--- /dev/null
@@ -0,0 +1,58 @@
+rem Scilab ( http://www.scilab.org/ ) - This file is part of Scilab\r
+rem Copyright (C) 2008 - INRIA\r
+rem \r
+rem This file must be used under the terms of the CeCILL.\r
+rem This source file is licensed as described in the file COPYING, which\r
+rem you should have received as part of this distribution.  The terms\r
+rem are also available at\r
+rem http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt\r
+\r
+@echo off\r
+setlocal\r
+\r
+if "%2"=="" goto usage\r
+\r
+set binDir=%~dp0\r
+set libDir=%binDir%\..\lib\r
+rem This XSL style sheet fixes bugs in ..\docbook_xsl\fo\htmltbl.xsl\r
+set docbookXslDir=%binDir%\..\xsl\r
+\r
+set format=-ps\r
+if "%~x2"==".ps" goto proceed\r
+set format=-pdf\r
+:proceed\r
+\r
+set foDir=%TEMP%\sci2pdf_tmp\r
+if exist "%foDir%" rmdir /s /q "%foDir%"\r
+mkdir "%foDir%"\r
+\r
+set flatXMLFile=%foDir%\%~n1.xml\r
+\r
+set foFile=%foDir%\__doc.fo\r
+\r
+set cp=%libDir%\sci_doc_kit.jar;%libDir%\jeuclid-core.jar;%libDir%\commons-logging.jar;%libDir%\batik.jar;%libDir%\js.jar\r
+\r
+java -cp "%cp%" org.scilab.doc_kit.CopyConvert "%format%" "%1" "%flatXMLFile%"\r
+\r
+java -Xmx512m -cp "%libDir%\saxon.jar;%libDir%\docbook-xsl-saxon.jar" com.icl.saxon.StyleSheet -o "%foFile%" "%flatXMLFile%" "%docbookXslDir%\fo\docbook.xsl" use.extensions=1 graphicsize.extension=0 paper.type=A4 "generate.toc=book toc,title,figure,table,example,equation part toc,title reference toc,title" toc.section.depth=3 section.autolabel=1 variablelist.as.blocks=1 shade.verbatim=1\r
+\r
+set cp2=%libDir%\fop.jar;%libDir%\fop-hyph.jar;%libDir%\avalon-framework.jar;%libDir%\commons-io.jar;%libDir%\commons-logging.jar;%libDir%\xmlgraphics-commons.jar;%libDir%\jimi.jar;%libDir%\batik.jar;%libDir%\js.jar\r
+\r
+java -Xmx512m -cp "%cp2%" org.apache.fop.cli.Main -dpi 120 -r -fo "%foFile%" "%format%" "%2"\r
+\r
+if exist "%foDir%" rmdir /s /q "%foDir%"\r
+\r
+goto end\r
+endlocal\r
+\r
+:usage\r
+echo Usage: sci2pdf in_xml_file out_pdf_or_ps_file\r
+echo Converts an XML document conforming to scilab.rnc to PDF\r
+echo or to PostScript.\r
+echo A PostScript file is generated if out_pdf_or_ps_file ends\r
+echo with '.ps'.\r
+\r
+:end\r
+\r
+\r
+\r
diff --git a/scilab/modules/helptools/bin/scivalid b/scilab/modules/helptools/bin/scivalid
new file mode 100755 (executable)
index 0000000..b64f45f
--- /dev/null
@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+# Copyright (C) 2008 - INRIA
+#
+# This file must be used under the terms of the CeCILL.
+# This source file is licensed as described in the file COPYING, which
+# you should have received as part of this distribution.  The terms
+# are also available at
+# http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+
+if [ $# -eq 0 ]; then
+    echo "Usage: scivalid xml_file ... xml_file"
+    echo "Validates specified XML files against the scilab.rnc schema."
+    exit 1
+fi
+
+binDir=`dirname $0`
+libDir=$binDir/../lib
+schemaDir=$binDir/../schema
+
+java -jar "$libDir/jing.jar" -c "$schemaDir/scilab.rnc" "$@"
diff --git a/scilab/modules/helptools/bin/scivalid.bat b/scilab/modules/helptools/bin/scivalid.bat
new file mode 100755 (executable)
index 0000000..3fa8b25
--- /dev/null
@@ -0,0 +1,29 @@
+rem Scilab ( http://www.scilab.org/ ) - This file is part of Scilab\r
+rem Copyright (C) 2008 - INRIA\r
+rem \r
+rem This file must be used under the terms of the CeCILL.\r
+rem This source file is licensed as described in the file COPYING, which\r
+rem you should have received as part of this distribution.  The terms\r
+rem are also available at\r
+rem http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt\r
+\r
+@echo off\r
+setlocal\r
+\r
+if "%1"=="" goto usage\r
+\r
+set binDir=%~dp0\r
+set libDir=%binDir%\..\lib\r
+set schemaDir=%binDir%\..\schema\r
+\r
+java -jar "%libDir%\jing.jar" -c "%schemaDir%\scilab.rnc" %*\r
+\r
+goto end\r
+endlocal\r
+\r
+:usage\r
+echo Usage: scivalid xml_file ... xml_file\r
+echo Validates specified XML files against the scilab.rnc schema.\r
+\r
+:end\r
+\r
diff --git a/scilab/modules/helptools/bin/sciviewhelp b/scilab/modules/helptools/bin/sciviewhelp
new file mode 100755 (executable)
index 0000000..498dc15
--- /dev/null
@@ -0,0 +1,27 @@
+#!/bin/sh
+
+# Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+# Copyright (C) 2008 - INRIA
+#
+# This file must be used under the terms of the CeCILL.
+# This source file is licensed as described in the file COPYING, which
+# you should have received as part of this distribution.  The terms
+# are also available at
+# http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+
+if [ $# -eq 0 ]; then
+    echo "Usage: sciviewhelp javahelp_jar_file ... javahelp_jar_file"
+    echo "Allows to browse the contents of one or more"
+    echo "JavaHelp[tm] .jar files created using sci2jh."
+    echo "The name of a JavaHelp .jar file must end with '_help.jar'."
+    exit 1
+fi
+
+binDir=`dirname $0`
+libDir=$binDir/../lib
+
+java -cp "$libDir/sci_doc_kit.jar:$libDir/jhall.jar" \
+        org.scilab.doc_kit.HelpViewer "$@"
+
+
+
diff --git a/scilab/modules/helptools/bin/sciviewhelp.bat b/scilab/modules/helptools/bin/sciviewhelp.bat
new file mode 100755 (executable)
index 0000000..b544bbc
--- /dev/null
@@ -0,0 +1,29 @@
+rem Scilab ( http://www.scilab.org/ ) - This file is part of Scilab\r
+rem Copyright (C) 2008 - INRIA\r
+rem \r
+rem This file must be used under the terms of the CeCILL.\r
+rem This source file is licensed as described in the file COPYING, which\r
+rem you should have received as part of this distribution.  The terms\r
+rem are also available at\r
+rem http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt\r
+\r
+@echo off\r
+setlocal\r
+\r
+if "%1"=="" goto usage\r
+\r
+set binDir=%~dp0\r
+set libDir=%binDir%\..\lib\r
+\r
+java -cp "%libDir%\sci_doc_kit.jar;%libDir%\jhall.jar" org.scilab.doc_kit.HelpViewer %*\r
+\r
+goto end\r
+endlocal\r
+\r
+:usage\r
+echo Usage: sciviewhelp javahelp_jar_file ... javahelp_jar_file\r
+echo Allows to browse the contents of one or more\r
+echo JavaHelp[tm] .jar files created using sci2jh.\r
+echo The name of a JavaHelp .jar file must end with '_help.jar'.\r
+\r
+:end\r
diff --git a/scilab/modules/helptools/css/html.css b/scilab/modules/helptools/css/html.css
new file mode 100644 (file)
index 0000000..638fc74
--- /dev/null
@@ -0,0 +1,39 @@
+/*
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2008 - INRIA
+ *
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ */
+
+body {
+    background-color: #FFFFFF;
+}
+
+h1, h2, h3, h4, h5 { 
+    color: #800000; 
+    font-family: sans-serif;
+}
+
+span.term { 
+    font-weight: bold;
+}
+
+div.sidebar {
+    background-color: #F0F0F0;
+    border: 1px solid gray;
+    padding: 5px;
+    margin: 20px;
+}
+
+pre.programlisting { 
+    background-color: #F0F0F0;
+    border: 1px solid gray;
+    padding: 2px;
+    font-size: 10pt;
+    white-space: pre;
+}
diff --git a/scilab/modules/helptools/css/htmlhelp.css b/scilab/modules/helptools/css/htmlhelp.css
new file mode 100644 (file)
index 0000000..3a56402
--- /dev/null
@@ -0,0 +1,39 @@
+/*
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2008 - INRIA
+ *
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ */
+
+body {
+    background-color: #FFFFFF;
+}
+
+h1, h2, h3, h4, h5 { 
+    color: #800000;
+    font-family: sans-serif;
+}
+
+span.term { 
+    font-weight: bold;
+}
+
+div.sidebar {
+    background-color: #F0F0F0;
+    border: 1px solid gray;
+    padding: 5px;
+    margin: 20px;
+}
+
+pre.programlisting {
+    background-color: #F0F0F0;
+    border: 1px solid gray;
+    padding: 2px;
+    font-size: 10pt;
+    white-space: pre;
+}
diff --git a/scilab/modules/helptools/css/javahelp.css b/scilab/modules/helptools/css/javahelp.css
new file mode 100644 (file)
index 0000000..4f54533
--- /dev/null
@@ -0,0 +1,153 @@
+/*
+ * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ * Copyright (C) 2008 - INRIA
+ *
+ * This file must be used under the terms of the CeCILL.
+ * This source file is licensed as described in the file COPYING, which
+ * you should have received as part of this distribution.  The terms
+ * are also available at
+ * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ */
+
+body  {
+    font-family: sans-serif;
+    font-size: small;
+    color: black;
+    background-color: white;
+    margin-left: 5;
+    margin-right: 5;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+    color: #483D8B; 
+    font-weight: bold;
+    margin-top: 10;
+    margin-bottom: 5;
+}
+
+h1,
+h2 {
+    font-size: large;
+}
+
+h3,
+h4 {
+    font-size: medium;
+}
+
+table {
+    border-width: 1; 
+    border-style: solid;
+    border-color: silver;
+    background-color: silver;
+    padding-left: 0;
+    padding-right: 0;
+    padding-top: 0;
+    padding-bottom: 0;
+    margin-top: 5;
+    margin-bottom: 5;
+}
+
+th,
+td {
+    border-width: 1; 
+    border-style: solid;
+    border-color: silver;
+    padding-left: 2;
+    padding-right: 2;
+    padding-top: 2;
+    padding-bottom: 2;
+}
+
+th {
+    background-color: #F0F0F0; 
+}
+
+td {
+    background-color: white;
+}
+
+dl {
+    margin-top: 10;
+    margin-bottom: 5;
+}
+
+dt {
+    font-weight: bold;
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+dd {
+    margin-top: 2;
+    margin-left: 24;
+}
+
+ul,
+ol {
+    margin-top: 5;
+    margin-bottom: 0;
+}
+
+ul {
+    margin-left: 16;
+}
+
+ol {
+     margin-left: 24;
+}
+
+li {
+    margin-top: 0;
+    margin-bottom: 5;
+}
+
+li p {
+    margin-top: 5;
+    margin-bottom: 0;
+}
+
+p {
+    margin-top: 5;
+    margin-bottom: 5;
+}
+
+div.sidebar { 
+    background-color: #F0F0FF; 
+    border-width: 1; 
+    border-style: solid;
+    border-color: gray;
+    padding-top: 5; 
+    padding-bottom: 5; 
+    padding-left: 5; 
+    padding-right: 5; 
+    margin-top: 20;
+    margin-bottom: 20;
+    margin-left: 20;
+    margin-right: 20;
+}
+
+pre.programlisting { 
+    background-color: #F0F0F0; 
+    border-width: 1; 
+    border-style: solid;
+    border-color: gray;
+    padding-top: 2; 
+    padding-bottom: 2; 
+    padding-left: 2; 
+    padding-right: 2; 
+}
+
+small {
+    font-size: x-small;
+}
+
+big {
+    font-size: medium;
+}
diff --git a/scilab/modules/helptools/doc/addonprefs.png b/scilab/modules/helptools/doc/addonprefs.png
new file mode 100644 (file)
index 0000000..9c84dd3
Binary files /dev/null and b/scilab/modules/helptools/doc/addonprefs.png differ
diff --git a/scilab/modules/helptools/doc/doc.pdf b/scilab/modules/helptools/doc/doc.pdf
new file mode 100644 (file)
index 0000000..d19655c
Binary files /dev/null and b/scilab/modules/helptools/doc/doc.pdf differ
diff --git a/scilab/modules/helptools/doc/doc.xml b/scilab/modules/helptools/doc/doc.xml
new file mode 100644 (file)
index 0000000..a2c5584
--- /dev/null
@@ -0,0 +1,762 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<book version="5.0-subset Scilab" xml:lang="en"
+      xmlns="http://docbook.org/ns/docbook"
+      xmlns:xlink="http://www.w3.org/1999/xlink"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      xmlns:svg="http://www.w3.org/2000/svg"
+      xmlns:mml="http://www.w3.org/1998/Math/MathML"
+      xmlns:html="http://www.w3.org/1999/xhtml"
+      xmlns:db="http://docbook.org/ns/docbook">
+  <title>doc_kit, a toolkit for Scilab documentation writers</title>
+
+  <chapter xml:id="intro">
+    <title>Introduction</title>
+
+    <para>This toolkit contains all the <link linkend="tools">command-line
+    tools</link> needed to write some documentation for <link
+    xlink:href="http://www.scilab.org/">Scilab</link>.</para>
+
+    <para>As of version 5, Scilab uses a <link linkend="db5subset">strict
+    subset of DocBook 5</link> for all its documentation. This toolkit also
+    contains tools (<link
+    linkend="manrev2sci"><literal>manrev2sci</literal></link> and <link
+    linkend="man2sci"><literal>man2sci</literal></link>) which may be used to
+    convert from Scilab's old formats (<literal>manrev.dtd</literal> and
+    <literal>man.dtd</literal>) to the new one.</para>
+  </chapter>
+
+  <chapter xml:id="install">
+    <title>Installation</title>
+
+    <para>This toolkit already includes <emphasis>all</emphasis> the needed
+    software components (<link
+    xlink:href="http://saxon.sourceforge.net/">Saxon</link>, <link
+    xlink:href="http://xmlgraphics.apache.org/fop/">FOP</link>, <link
+    xlink:href="http://xmlgraphics.apache.org/batik/">Batik</link>, <link
+    xlink:href="http://jeuclid.sourceforge.net/">JEuclid</link>, <link
+    xlink:href="http://java.sun.com/products/javahelp/">JavaHelp</link>, <link
+    xlink:href="http://www.thaiopensource.com/relaxng/jing.html">Jing</link>,
+    etc), therefore you just need to install a
+    Java<superscript>TM</superscript> Development Kit (JDK) 1.5+ in order to
+    be able to run the command-line tools.</para>
+
+    <para>Note that installing a Java runtime (JRE) is insufficient because
+    some command-line tools expect to have the <literal>jar</literal> utility
+    (part of the JDK, not part of the JRE) in the
+    <literal>PATH</literal>.</para>
+
+    <orderedlist>
+      <listitem>
+        <para>Unzip the distribution somewhere. This creates a
+        <literal>doc_kit/</literal> directory.</para>
+
+        <programlisting>C:\&gt; unzip doc_kit.zip
+C:\&gt; dir
+...
+13/02/2008  14:19    &lt;DIR&gt;          doc_kit
+...</programlisting>
+      </listitem>
+
+      <listitem>
+        <para>All the command-line tools are found in the
+        <literal>bin/</literal> subdirectory.</para>
+
+        <programlisting>C:\doc_kit&gt; cd bin
+C:\doc_kit\bin&gt; dir /w
+...
+[.]               [..]              man2sci           sci2jh
+sciviewhelp       sci2html          manrev2sci        scivalid
+scivalid.bat      manrev2sci.bat    man2sci.bat       sci2html.bat
+sciviewhelp.bat   sci2pdf.bat       sci2pdf           sci2jh.bat
+sci2chm.bat
+...</programlisting>
+
+        <para>All the above command-line tools are intended to be used
+        directly from the <literal>doc_kit/bin/</literal> subdirectory.</para>
+      </listitem>
+
+      <listitem>
+        <para>Test your installation by converting this document
+        (<literal>doc_kit/doc/doc.xml</literal>) to a JavaHelp
+        <literal>.jar</literal> file.</para>
+
+        <orderedlist numeration="loweralpha">
+          <listitem>
+            <para>First make sure that the Java tools are actually in your
+            <literal>PATH</literal>.</para>
+
+            <programlisting>C:\doc_kit\bin&gt; java -version
+java version "1.6.0_04"
+Java(TM) SE Runtime Environment (build 1.6.0_04-b12)
+Java HotSpot(TM) Client VM (build 10.0-b19, mixed mode, sharing)
+
+C:\doc_kit\bin&gt; jar
+Usage: jar {ctxui}[vfm0Me] ...</programlisting>
+          </listitem>
+
+          <listitem>
+            <para>Convert this document
+            (<literal>doc_kit/doc/doc.xml</literal>) to JavaHelp using the
+            <link linkend="sci2jh"><literal>sci2jh</literal></link>
+            command-line tool.</para>
+
+            <programlisting>C:\doc_kit\bin&gt; sci2jh ..\doc\doc.xml C:\tmp\test_help.jar</programlisting>
+
+            <para>Note that the generated JavaHelp file must end with
+            "<literal>_help.jar</literal>" and not just with
+            "<literal>.jar</literal>".</para>
+          </listitem>
+
+          <listitem>
+            <para>Preview the contents of the generated
+            <literal>.jar</literal> file using the <link
+            linkend="sciviewhelp"><literal>sciviewhelp</literal></link>
+            tool.</para>
+
+            <programlisting>C:\doc_kit\bin&gt; sciviewhelp C:\tmp\test_help.jar</programlisting>
+          </listitem>
+        </orderedlist>
+      </listitem>
+    </orderedlist>
+  </chapter>
+
+  <chapter xml:id="distrib">
+    <title>Contents of the distribution</title>
+
+    <variablelist>
+      <varlistentry>
+        <term>bin/</term>
+
+        <listitem>
+          <para>Contains the command-line tools: shell scripts for use on
+          Unix/Linux/Mac OS X and <literal>.bat</literal> files for use on
+          Windows (2000, XP, Vista).</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>css/</term>
+
+        <listitem>
+          <para>Contains the CSS style sheets which are used to customize the
+          look of the HTML pages generated by <link
+          linkend="sci2html"><literal>sci2html</literal></link>, <link
+          linkend="sci2chm"><literal>sci2chm</literal></link> and <link
+          linkend="sci2jh"><literal>sci2jh</literal></link>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>doc/</term>
+
+        <listitem>
+          <para>Contains this document in various formats.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>docbook_xsl/</term>
+
+        <listitem>
+          <para>Contains a copy of the <link
+          xlink:href="http://docbook.sourceforge.net/">DocBook XSL style
+          sheets</link>. These style sheets are used to convert DocBook 5
+          documents (and hence, Scilab documentation) to HTML, PostScript,
+          PDF, JavaHelp, etc.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>legal/</term>
+
+        <listitem>
+          <para>Contains a README and a LICENSE file for each software
+          component bundled with this toolkit.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>lib/</term>
+
+        <listitem>
+          <para>Contains all the software components (that is, Java class
+          libraries packaged as <literal>.jar</literal> files) bundled with
+          this toolkit.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>schema/</term>
+
+        <listitem>
+          <para>Contains <literal>scilab.rnc</literal>, the RELAX NG schema
+          defining the DocBook 5 subset used for the documentation of
+          Scilab.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>src/</term>
+
+        <listitem>
+          <para>Contains the source code of two utility classes needed by the
+          command-line tools of this toolkit. More information in "<link
+          linkend="build">Recompiling the sources</link>".</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>xsl/</term>
+
+        <listitem>
+          <variablelist>
+            <varlistentry>
+              <term>convert/manrev2sci.xsl</term>
+
+              <listitem>
+                <para>The XSLT style sheet used to convert a document
+                conforming to <literal>manrev.dtd</literal> to a document
+                conforming to the DocBook 5 subset.</para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>convert/man2manrevxsl</term>
+
+              <listitem>
+                <para>The XSLT style sheet used to convert a document
+                conforming to <literal>man.dtd</literal> to a document
+                conforming to <literal>manrev.dtd</literal>.</para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term>fo/docbook.xsl</term>
+
+              <listitem>
+                <para>Fixes bugs in the stock
+                <literal>docbook/fo/htmltbl.xsl</literal>.</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </chapter>
+
+  <chapter xml:id="db5subset">
+    <title>The Scilab subset of DocBook 5</title>
+
+    <para>The documentation of Scilab must be written using the strict subset
+    of DocBook 5 defined in <literal>doc_kit/schema/scilab.rnc</literal>.
+    DocBook 5 elements are fully documented in "<link
+    xlink:href="http://docbook.org/tdg5/en/html/docbook.html">DocBook 5.0: The
+    Definitive Guide</link>", therefore there is not much to add here.</para>
+
+    <note>
+      <title>Important</title>
+
+      <para>The root element of a document which conforms to the Scilab
+      DocBook 5 subset must have <literal>version</literal> attribute set to
+      "<literal>5.0-subset Scilab</literal>". Example:</para>
+
+      <programlisting>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
+&lt;refentry version="5.0-subset Scilab" 
+          xmlns="http://docbook.org/ns/docbook"
+          ...</programlisting>
+    </note>
+
+    <para>The subset comprises the following elements:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para><literal>book</literal> and its divisions:</para>
+
+        <itemizedlist>
+          <listitem>
+            <para><literal>part</literal>, <literal>partintro</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>reference</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>chapter</literal>,
+            <literal>section</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>appendix</literal></para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
+
+      <listitem>
+        <para>Meta-info elements: <literal>info</literal>,
+        <literal>title</literal>, <literal>author</literal>,
+        <literal>personname</literal>, <literal>affiliation</literal>,
+        <literal>jobtitle</literal>, <literal>orgname</literal>,
+        <literal>pubdate</literal>, <literal>keywordset</literal>,
+        <literal>keyword</literal>.</para>
+      </listitem>
+
+      <listitem>
+        <para><literal>refentry</literal> (the DocBook equivalent of a man
+        page) and its divisions: <literal>refnamediv</literal>,
+        <literal>refname</literal>, <literal>refpurpose</literal>,
+        <literal>refsynopsisdiv</literal>, <literal>synopsis</literal>,
+        <literal>refsection</literal>.</para>
+      </listitem>
+
+      <listitem>
+        <para>Displayed elements:</para>
+
+        <itemizedlist>
+          <listitem>
+            <para><literal>figure</literal>, <literal>mediaobject</literal>,
+            <literal>imageobject</literal>, <literal>imagedata</literal>
+            (having either a <literal>fileref</literal> attribute or embedding
+            <link xlink:href="http://www.w3.org/Math/">MathML</link> or <link
+            xlink:href="http://www.w3.org/Graphics/SVG/">SVG</link>)</para>
+          </listitem>
+
+          <listitem>
+            <para><literal>example</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>note</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>equation</literal>,
+            <literal>informalequation</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>table</literal> (HTML tables only, that is, not
+            CALS tables), <literal>caption</literal>,
+            <literal>informaltable</literal>, <literal>col</literal>,
+            <literal>colgroup</literal>, <literal>tbody</literal>,
+            <literal>thead</literal>, <literal>tfoot</literal>,
+            <literal>tr</literal>, <literal>td</literal>,
+            <literal>th</literal></para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
+
+      <listitem>
+        <para>Other block-level elements:</para>
+
+        <itemizedlist>
+          <listitem>
+            <para><literal>itemizedlist</literal>,
+            <literal>orderedlist</literal>, <literal>listitem</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>variablelist</literal>,
+            <literal>varlistentry</literal>, <literal>term</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>simplelist</literal>,
+            <literal>member</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>para</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>programlisting</literal></para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
+
+      <listitem>
+        <para>Inline-level elements:</para>
+
+        <itemizedlist>
+          <listitem>
+            <para><literal>emphasis</literal>,
+            <literal>literal</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>phrase</literal>,
+            <literal>replaceable</literal>,</para>
+          </listitem>
+
+          <listitem>
+            <para><literal>subscript</literal>,
+            <literal>superscript</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>link</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>indexterm</literal>,
+            <literal>primary</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>inlinemediaobject</literal></para>
+          </listitem>
+
+          <listitem>
+            <para><literal>inlineequation</literal></para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
+    </itemizedlist>
+  </chapter>
+
+  <chapter xml:id="tools">
+    <title>The command-line tools</title>
+
+    <para>All command-line tools are self-documented. Simply execute the
+    command without any argument to display a short help text. Example:</para>
+
+    <programlisting>C:\doc_kit\bin&gt; sciviewhelp
+Usage: sciviewhelp javahelp_jar_file ... javahelp_jar_file
+Allows to browse the contents of one or more
+JavaHelp[tm] .jar files created using sci2jh.
+The name of a JavaHelp .jar file must end with '_help.jar'.</programlisting>
+
+    <variablelist>
+      <varlistentry xml:id="man2sci">
+        <term>man2sci</term>
+
+        <term>man2sci.bat</term>
+
+        <listitem>
+          <para>Converts a document conforming to <literal>man.dtd</literal>
+          to a document conforming to <literal>scilab.rnc</literal>.</para>
+
+          <para>Usage: <literal>man2sci
+          <replaceable>in_man_xml_file</replaceable>
+          <replaceable>out_scilab_xml_file</replaceable></literal></para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry xml:id="manrev2sci">
+        <term>manrev2sci</term>
+
+        <term>manrev2sci.bat</term>
+
+        <listitem>
+          <para>Converts a document conforming to
+          <literal>manrev.dtd</literal> to a document conforming to
+          <literal>scilab.rnc</literal>.</para>
+
+          <para>Usage: <literal>manrev2sci
+          <replaceable>in_manrev_xml_file</replaceable>
+          <replaceable>out_scilab_xml_file</replaceable></literal></para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry xml:id="sci2html">
+        <term>sci2html</term>
+
+        <term>sci2html.bat</term>
+
+        <listitem>
+          <para>Converts an XML document conforming to
+          <literal>scilab.rnc</literal> to multi-page HTML.</para>
+
+          <para>Usage: <literal>sci2html
+          <replaceable>in_xml_file</replaceable>
+          <replaceable>out_html_directory</replaceable></literal></para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry xml:id="sci2chm">
+        <term>sci2chm.bat</term>
+
+        <listitem>
+          <para>Converts an XML document conforming to
+          <literal>scilab.rnc</literal> to a Windows HTML Help
+          (".<literal>chm</literal>") file. Not available on platforms other
+          than Windows.</para>
+
+          <para>By default, this script assumes that
+          <literal>hhc.exe</literal> is found in "<literal>C:\Program
+          Files\HTML Help Workshop\hhc.exe</literal>". If this is not the
+          case, please modify the "<literal>hhc</literal>" variable found at
+          the beginning of the "<literal>.bat</literal>" file.</para>
+
+          <para>Usage: <literal>sci2chm <replaceable>in_xml_file</replaceable>
+          <replaceable>out_chm_file</replaceable></literal></para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry xml:id="sci2jh">
+        <term>sci2jh</term>
+
+        <term>sci2jh.bat</term>
+
+        <listitem>
+          <para>Converts an XML document conforming to
+          <literal>scilab.rnc</literal> to a JavaHelp <literal>.jar</literal>
+          file. <literal>out_javahelp_jar_file</literal> must end with
+          "<literal>_help.jar</literal>".</para>
+
+          <para>Usage: <literal>sci2jh <replaceable>in_xml_file</replaceable>
+          <replaceable>out_javahelp_jar_file</replaceable></literal></para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry xml:id="sci2pdf">
+        <term>sci2pdf</term>
+
+        <term>sci2pdf.bat</term>
+
+        <listitem>
+          <para>Converts an XML document conforming to
+          <literal>scilab.rnc</literal> to PDF or to PostScript. A PostScript
+          file is generated if <replaceable>out_pdf_or_ps_file</replaceable>
+          ends with "<literal>.ps</literal>".</para>
+
+          <para>Usage: <literal>sci2pdf <replaceable>in_xml_file</replaceable>
+          <replaceable>out_pdf_or_ps_file</replaceable></literal></para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry xml:id="scivalid">
+        <term>scivalid</term>
+
+        <term>scivalid.bat</term>
+
+        <listitem>
+          <para>Validates specified XML files against the
+          <literal>scilab.rnc</literal> schema.</para>
+
+          <para>Usage: <literal>scivalid <replaceable>xml_file</replaceable>
+          ... <replaceable>xml_file</replaceable></literal></para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry xml:id="sciviewhelp">
+        <term>sciviewhelp</term>
+
+        <term>sciviewhelp.bat</term>
+
+        <listitem>
+          <para>Allows to browse the contents of one or more JavaHelp .jar
+          files created using <literal>sci2jh</literal>. The name of a
+          JavaHelp <literal>.jar</literal> file must end with
+          "<literal>_help.jar</literal>".</para>
+
+          <para>Usage: <literal>sciviewhelp
+          <replaceable>javahelp_jar_file</replaceable> ...
+          <replaceable>javahelp_jar_file</replaceable></literal></para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </chapter>
+
+  <chapter xml:id="build">
+    <title>Recompiling the sources</title>
+
+    <para>Directory <literal>doc_kit/src/org/scilab/doc_kit/</literal>
+    contains the source code of two utility classes needed by some of the
+    above command-line tools:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term>HelpViewer.java</term>
+
+        <listitem>
+          <para>The source code of <link
+          linkend="sciviewhelp"><literal>sciviewhelp</literal></link>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>CopyConvert.java</term>
+
+        <listitem>
+          <para>A preprocessor used as the first pass in <link
+          linkend="sci2html"><literal>sci2html</literal></link>, <link
+          linkend="sci2chm"><literal>sci2chm</literal></link>, <link
+          linkend="sci2jh"><literal>sci2jh</literal></link> and <link
+          linkend="sci2pdf"><literal>sci2pdf</literal></link>.</para>
+
+          <para>This preprocessor:</para>
+
+          <itemizedlist>
+            <listitem>
+              <para>Creates a ``flat' (entity references are expanded; <link
+              xlink:href="http://www.w3.org/TR/xinclude/">XIncludes</link> are
+              not supported) copy of the XML document to be
+              transformed.</para>
+            </listitem>
+
+            <listitem>
+              <para>If the source document contains an embedded MathML element
+              (<literal>imagedata/mml:math</literal>), this element is
+              extracted to a temporary file, then the temporary file is
+              converted to a PNG image by the means of <link
+              xlink:href="http://jeuclid.sourceforge.net/">JEuclid</link>.
+              After doing this, the original
+              <literal>imagedata/mml:math</literal> found in the source is
+              replaced in the flat XML document by an
+              <literal>imagedata</literal> element pointing to the generated
+              PNG file (<literal>imagedata/@fileref</literal>).</para>
+            </listitem>
+
+            <listitem>
+              <para>Same for embedded SVG elements which are converted to PNG
+              images by the means of <link
+              xlink:href="http://xmlgraphics.apache.org/batik/">Batik</link>.</para>
+            </listitem>
+
+            <listitem>
+              <para>If the source document contains an
+              <literal>imagedata</literal> element pointing to a MathML file
+              (filename extension is "<literal>.mml</literal>"), this file is
+              converted to PNG by the means of <link
+              xlink:href="http://jeuclid.sourceforge.net/">JEuclid</link>.
+              After doing that, the <literal>imagedata</literal> element
+              contained in the flat XML document is made to point to the
+              <literal>.png</literal> file rather than to the
+              <literal>.mml</literal> file.</para>
+            </listitem>
+
+            <listitem>
+              <para>Same for <literal>imagedata</literal> elements pointing to
+              SVG files (filename extension is "<literal>.svg</literal>" or
+              "<literal>.svgz</literal>"), but in this case, it is <link
+              xlink:href="http://xmlgraphics.apache.org/batik/">Batik</link>
+              which is used to perform the conversion.</para>
+            </listitem>
+
+            <listitem>
+              <para>Same for <literal>imagedata</literal> elements pointing to
+              "<literal>.tex</literal>" files (assumed to contain math
+              equations), but in this case, it is <link
+              xlink:href="http://www.tug.org/">T<subscript>E</subscript>X</link>+<link
+              xlink:href="http://pages.cs.wisc.edu/~ghost/">Ghostscript</link>
+              which are used to perform the conversion.</para>
+
+              <para>The <literal>CopyConvert</literal> preprocessor searches
+              the following programs in the <literal>PATH</literal>:
+              <literal>latex</literal>, <literal>dvips</literal>,
+              <literal>gs</literal> on Unix/<literal>gswin32c</literal> on
+              Windows, <literal>ps2pdf</literal>.</para>
+            </listitem>
+          </itemizedlist>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>The above sources may be recompiled by running <link
+    xlink:href="http://ant.apache.org/">ant</link> in the
+    <literal>doc_kit/src/</literal> directory:</para>
+
+    <programlisting>C:\doc_kit/src&gt; dir /w
+...
+build.xml   [org]       [class]
+...
+C:\doc_kit/src&gt; ant
+Buildfile: build.xml
+
+init:
+
+compile:
+...</programlisting>
+
+    <para>Doing this rebuilds <literal>sci_doc_kit.jar</literal> in
+    <literal>doc_kit/lib/</literal>.</para>
+  </chapter>
+
+  <chapter xml:id="other_tools">
+    <title>Companion tools</title>
+
+    <itemizedlist>
+      <listitem>
+        <para><link xlink:href="http://www.inkscape.org/">Inkscape</link>, an
+        excellent drawing tool natively supporting SVG.</para>
+      </listitem>
+
+      <listitem>
+        <para><link xlink:href="http://miktex.org/">MiKTeX</link>, an
+        excellent T<subscript>E</subscript>X distribution for Windows.</para>
+      </listitem>
+
+      <listitem>
+        <para><link xlink:href="http://www.xmlmind.com/xmleditor/">XMLmind XML
+        Editor</link>, a visual XML editor with built-in support for DocBook
+        5. There are many fine XML editors but this one</para>
+
+        <itemizedlist>
+          <listitem>
+            <para>has a free <link
+            xlink:href="http://www.xmlmind.com/xmleditor/persoedition.html">Personal
+            Edition</link> allowing to use it to create documentation for Open
+            Source projects such as Scilab,</para>
+          </listitem>
+
+          <listitem>
+            <para>has a configuration specially designed to support the Scilab
+            DocBook 5 subset.</para>
+          </listitem>
+        </itemizedlist>
+
+        <para>This Scilab configuration is available as an add-on. This add-on
+        may be downloaded and installed directly within XMLmind XML Editor
+        using menu item <emphasis role="bold">Options</emphasis>|<emphasis
+        role="bold">Install Add-ons</emphasis>. But before being able to do
+        that, you must specify where to find such add-on. Fortunately this is
+        done once for all:</para>
+
+        <orderedlist>
+          <listitem>
+            <para>Use menu item <emphasis
+            role="bold">Options</emphasis>|<emphasis
+            role="bold">Preferences</emphasis>.</para>
+          </listitem>
+
+          <listitem>
+            <para>Click on the "<emphasis role="bold">Install
+            Add-ons</emphasis>" item in the left pane.</para>
+
+            <mediaobject>
+              <imageobject>
+                <imagedata fileref="addonprefs.png" />
+              </imageobject>
+            </mediaobject>
+          </listitem>
+
+          <listitem>
+            <para>Click the <emphasis role="bold">Add</emphasis> button found
+            at the right of the "<emphasis role="bold">Download add-ons from
+            these servers</emphasis>" list.</para>
+          </listitem>
+
+          <listitem>
+            <para>Specify the following URL
+            "<literal>http://www.scilab.org/download/scilab_config.xxe_addon</literal>"
+            when prompted, then click <emphasis
+            role="bold">OK</emphasis>.</para>
+          </listitem>
+
+          <listitem>
+            <para>Click <emphasis role="bold">OK</emphasis> to close the
+            <emphasis role="bold">Preferences</emphasis> dialog box.</para>
+          </listitem>
+        </orderedlist>
+
+        <para>From now, you can use menu item <emphasis
+        role="bold">Options</emphasis>|<emphasis role="bold">Install
+        Add-ons</emphasis> and select the add-on called "<emphasis
+        role="bold">A configuration for the Scilab subset of DocBook
+        5</emphasis>" from the list of all available add-ons.</para>
+      </listitem>
+    </itemizedlist>
+  </chapter>
+</book>
\ No newline at end of file
diff --git a/scilab/modules/helptools/doc/html/ch01.html b/scilab/modules/helptools/doc/html/ch01.html
new file mode 100644 (file)
index 0000000..c8dd3cf
--- /dev/null
@@ -0,0 +1,3 @@
+<html><head>
+      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+   <title>Chapter&nbsp;1.&nbsp;Introduction</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.73.1"><link rel="start" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="up" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="prev" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="next" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;1.&nbsp;Introduction</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="index.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch02.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="intro"></a>Chapter&nbsp;1.&nbsp;Introduction</h2></div></div></div><p>This toolkit contains all the <a class="link" href="ch05.html" title="Chapter&nbsp;5.&nbsp;The command-line tools">command-line tools</a> needed to write some documentation for <a class="link" href="http://www.scilab.org/">Scilab</a>.</p><p>As of version 5, Scilab uses a <a class="link" href="ch04.html" title="Chapter&nbsp;4.&nbsp;The Scilab subset of DocBook 5">strict subset of DocBook 5</a> for all its documentation. This toolkit also contains tools (<a class="link" href="ch05.html#manrev2sci"><code class="literal">manrev2sci</code></a> and <a class="link" href="ch05.html#man2sci"><code class="literal">man2sci</code></a>) which may be used to convert from Scilab's old formats (<code class="literal">manrev.dtd</code> and <code class="literal">man.dtd</code>) to the new one.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="index.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch02.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">doc_kit, a toolkit for Scilab documentation writers&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;2.&nbsp;Installation</td></tr></table></div></body></html>
\ No newline at end of file
diff --git a/scilab/modules/helptools/doc/html/ch02.html b/scilab/modules/helptools/doc/html/ch02.html
new file mode 100644 (file)
index 0000000..2863d8b
--- /dev/null
@@ -0,0 +1,21 @@
+<html><head>
+      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+   <title>Chapter&nbsp;2.&nbsp;Installation</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.73.1"><link rel="start" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="up" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="prev" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Introduction"><link rel="next" href="ch03.html" title="Chapter&nbsp;3.&nbsp;Contents of the distribution"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;2.&nbsp;Installation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch01.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch03.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="install"></a>Chapter&nbsp;2.&nbsp;Installation</h2></div></div></div><p>This toolkit already includes <span class="emphasis"><em>all</em></span> the needed software components (<a class="link" href="http://saxon.sourceforge.net/">Saxon</a>, <a class="link" href="http://xmlgraphics.apache.org/fop/">FOP</a>, <a class="link" href="http://xmlgraphics.apache.org/batik/">Batik</a>, <a class="link" href="http://jeuclid.sourceforge.net/">JEuclid</a>, <a class="link" href="http://java.sun.com/products/javahelp/">JavaHelp</a>, <a class="link" href="http://www.thaiopensource.com/relaxng/jing.html">Jing</a>, etc), therefore you just need to install a Java<sup>TM</sup> Development Kit (JDK) 1.5+ in order to be able to run the command-line tools.</p><p>Note that installing a Java runtime (JRE) is insufficient because some command-line tools expect to have the <code class="literal">jar</code> utility (part of the JDK, not part of the JRE) in the <code class="literal">PATH</code>.</p><div class="orderedlist"><ol type="1"><li><p>Unzip the distribution somewhere. This creates a <code class="literal">doc_kit/</code> directory.</p><pre class="programlisting">C:\&gt; unzip doc_kit.zip
+C:\&gt; dir
+...
+13/02/2008  14:19    &lt;DIR&gt;          doc_kit
+...</pre></li><li><p>All the command-line tools are found in the <code class="literal">bin/</code> subdirectory.</p><pre class="programlisting">C:\doc_kit&gt; cd bin
+C:\doc_kit\bin&gt; dir /w
+...
+[.]               [..]              man2sci           sci2jh
+sciviewhelp       sci2html          manrev2sci        scivalid
+scivalid.bat      manrev2sci.bat    man2sci.bat       sci2html.bat
+sciviewhelp.bat   sci2pdf.bat       sci2pdf           sci2jh.bat
+sci2chm.bat
+...</pre><p>All the above command-line tools are intended to be used directly from the <code class="literal">doc_kit/bin/</code> subdirectory.</p></li><li><p>Test your installation by converting this document (<code class="literal">doc_kit/doc/doc.xml</code>) to a JavaHelp <code class="literal">.jar</code> file.</p><div class="orderedlist"><ol type="a"><li><p>First make sure that the Java tools are actually in your <code class="literal">PATH</code>.</p><pre class="programlisting">C:\doc_kit\bin&gt; java -version
+java version "1.6.0_04"
+Java(TM) SE Runtime Environment (build 1.6.0_04-b12)
+Java HotSpot(TM) Client VM (build 10.0-b19, mixed mode, sharing)
+
+C:\doc_kit\bin&gt; jar
+Usage: jar {ctxui}[vfm0Me] ...</pre></li><li><p>Convert this document (<code class="literal">doc_kit/doc/doc.xml</code>) to JavaHelp using the <a class="link" href="ch05.html#sci2jh"><code class="literal">sci2jh</code></a> command-line tool.</p><pre class="programlisting">C:\doc_kit\bin&gt; sci2jh ..\doc\doc.xml C:\tmp\test_help.jar</pre><p>Note that the generated JavaHelp file must end with "<code class="literal">_help.jar</code>" and not just with "<code class="literal">.jar</code>".</p></li><li><p>Preview the contents of the generated <code class="literal">.jar</code> file using the <a class="link" href="ch05.html#sciviewhelp"><code class="literal">sciviewhelp</code></a> tool.</p><pre class="programlisting">C:\doc_kit\bin&gt; sciviewhelp C:\tmp\test_help.jar</pre></li></ol></div></li></ol></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch01.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;1.&nbsp;Introduction&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;3.&nbsp;Contents of the distribution</td></tr></table></div></body></html>
\ No newline at end of file
diff --git a/scilab/modules/helptools/doc/html/ch03.html b/scilab/modules/helptools/doc/html/ch03.html
new file mode 100644 (file)
index 0000000..a4cefec
--- /dev/null
@@ -0,0 +1,3 @@
+<html><head>
+      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+   <title>Chapter&nbsp;3.&nbsp;Contents of the distribution</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.73.1"><link rel="start" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="up" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="prev" href="ch02.html" title="Chapter&nbsp;2.&nbsp;Installation"><link rel="next" href="ch04.html" title="Chapter&nbsp;4.&nbsp;The Scilab subset of DocBook 5"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;3.&nbsp;Contents of the distribution</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch02.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch04.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="distrib"></a>Chapter&nbsp;3.&nbsp;Contents of the distribution</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">bin/</span></dt><dd><p>Contains the command-line tools: shell scripts for use on Unix/Linux/Mac&nbsp;OS&nbsp;X and <code class="literal">.bat</code> files for use on Windows (2000, XP, Vista).</p></dd><dt><span class="term">css/</span></dt><dd><p>Contains the CSS style sheets which are used to customize the look of the HTML pages generated by <a class="link" href="ch05.html#sci2html"><code class="literal">sci2html</code></a>, <a class="link" href="ch05.html#sci2chm"><code class="literal">sci2chm</code></a> and <a class="link" href="ch05.html#sci2jh"><code class="literal">sci2jh</code></a>.</p></dd><dt><span class="term">doc/</span></dt><dd><p>Contains this document in various formats.</p></dd><dt><span class="term">docbook_xsl/</span></dt><dd><p>Contains a copy of the <a class="link" href="http://docbook.sourceforge.net/">DocBook XSL style sheets</a>. These style sheets are used to convert DocBook 5 documents (and hence, Scilab documentation) to HTML, PostScript, PDF, JavaHelp, etc.</p></dd><dt><span class="term">legal/</span></dt><dd><p>Contains a README and a LICENSE file for each software component bundled with this toolkit.</p></dd><dt><span class="term">lib/</span></dt><dd><p>Contains all the software components (that is, Java class libraries packaged as <code class="literal">.jar</code> files) bundled with this toolkit.</p></dd><dt><span class="term">schema/</span></dt><dd><p>Contains <code class="literal">scilab.rnc</code>, the RELAX NG schema defining the DocBook 5 subset used for the documentation of Scilab.</p></dd><dt><span class="term">src/</span></dt><dd><p>Contains the source code of two utility classes needed by the command-line tools of this toolkit. More information in "<a class="link" href="ch06.html" title="Chapter&nbsp;6.&nbsp;Recompiling the sources">Recompiling the sources</a>".</p></dd><dt><span class="term">xsl/</span></dt><dd><div class="variablelist"><dl><dt><span class="term">convert/manrev2sci.xsl</span></dt><dd><p>The XSLT style sheet used to convert a document conforming to <code class="literal">manrev.dtd</code> to a document conforming to the DocBook 5 subset.</p></dd><dt><span class="term">convert/man2manrevxsl</span></dt><dd><p>The XSLT style sheet used to convert a document conforming to <code class="literal">man.dtd</code> to a document conforming to <code class="literal">manrev.dtd</code>.</p></dd><dt><span class="term">fo/docbook.xsl</span></dt><dd><p>Fixes bugs in the stock <code class="literal">docbook/fo/htmltbl.xsl</code>.</p></dd></dl></div></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch02.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch04.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;2.&nbsp;Installation&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;4.&nbsp;The Scilab subset of DocBook 5</td></tr></table></div></body></html>
\ No newline at end of file
diff --git a/scilab/modules/helptools/doc/html/ch04.html b/scilab/modules/helptools/doc/html/ch04.html
new file mode 100644 (file)
index 0000000..68b534c
--- /dev/null
@@ -0,0 +1,6 @@
+<html><head>
+      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+   <title>Chapter&nbsp;4.&nbsp;The Scilab subset of DocBook 5</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.73.1"><link rel="start" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="up" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="prev" href="ch03.html" title="Chapter&nbsp;3.&nbsp;Contents of the distribution"><link rel="next" href="ch05.html" title="Chapter&nbsp;5.&nbsp;The command-line tools"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;4.&nbsp;The Scilab subset of DocBook 5</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch03.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch05.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="db5subset"></a>Chapter&nbsp;4.&nbsp;The Scilab subset of DocBook 5</h2></div></div></div><p>The documentation of Scilab must be written using the strict subset of DocBook 5 defined in <code class="literal">doc_kit/schema/scilab.rnc</code>. DocBook 5 elements are fully documented in "<a class="link" href="http://docbook.org/tdg5/en/html/docbook.html">DocBook 5.0: The Definitive Guide</a>", therefore there is not much to add here.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Important</h3><p>The root element of a document which conforms to the Scilab DocBook 5 subset must have <code class="literal">version</code> attribute set to "<code class="literal">5.0-subset&nbsp;Scilab</code>". Example:</p><pre class="programlisting">&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
+&lt;refentry version="5.0-subset Scilab" 
+          xmlns="http://docbook.org/ns/docbook"
+          ...</pre></div><p>The subset comprises the following elements:</p><div class="itemizedlist"><ul type="disc"><li><p><code class="literal">book</code> and its divisions:</p><div class="itemizedlist"><ul type="circle"><li><p><code class="literal">part</code>, <code class="literal">partintro</code></p></li><li><p><code class="literal">reference</code></p></li><li><p><code class="literal">chapter</code>, <code class="literal">section</code></p></li><li><p><code class="literal">appendix</code></p></li></ul></div></li><li><p>Meta-info elements: <code class="literal">info</code>, <code class="literal">title</code>, <code class="literal">author</code>, <code class="literal">personname</code>, <code class="literal">affiliation</code>, <code class="literal">jobtitle</code>, <code class="literal">orgname</code>, <code class="literal">pubdate</code>, <code class="literal">keywordset</code>, <code class="literal">keyword</code>.</p></li><li><p><code class="literal">refentry</code> (the DocBook equivalent of a man page) and its divisions: <code class="literal">refnamediv</code>, <code class="literal">refname</code>, <code class="literal">refpurpose</code>, <code class="literal">refsynopsisdiv</code>, <code class="literal">synopsis</code>, <code class="literal">refsection</code>.</p></li><li><p>Displayed elements:</p><div class="itemizedlist"><ul type="circle"><li><p><code class="literal">figure</code>, <code class="literal">mediaobject</code>, <code class="literal">imageobject</code>, <code class="literal">imagedata</code> (having either a <code class="literal">fileref</code> attribute or embedding <a class="link" href="http://www.w3.org/Math/">MathML</a> or <a class="link" href="http://www.w3.org/Graphics/SVG/">SVG</a>)</p></li><li><p><code class="literal">example</code></p></li><li><p><code class="literal">note</code></p></li><li><p><code class="literal">equation</code>, <code class="literal">informalequation</code></p></li><li><p><code class="literal">table</code> (HTML tables only, that is, not CALS tables), <code class="literal">caption</code>, <code class="literal">informaltable</code>, <code class="literal">col</code>, <code class="literal">colgroup</code>, <code class="literal">tbody</code>, <code class="literal">thead</code>, <code class="literal">tfoot</code>, <code class="literal">tr</code>, <code class="literal">td</code>, <code class="literal">th</code></p></li></ul></div></li><li><p>Other block-level elements:</p><div class="itemizedlist"><ul type="circle"><li><p><code class="literal">itemizedlist</code>, <code class="literal">orderedlist</code>, <code class="literal">listitem</code></p></li><li><p><code class="literal">variablelist</code>, <code class="literal">varlistentry</code>, <code class="literal">term</code></p></li><li><p><code class="literal">simplelist</code>, <code class="literal">member</code></p></li><li><p><code class="literal">para</code></p></li><li><p><code class="literal">programlisting</code></p></li></ul></div></li><li><p>Inline-level elements:</p><div class="itemizedlist"><ul type="circle"><li><p><code class="literal">emphasis</code>, <code class="literal">literal</code></p></li><li><p><code class="literal">phrase</code>, <code class="literal">replaceable</code>,</p></li><li><p><code class="literal">subscript</code>, <code class="literal">superscript</code></p></li><li><p><code class="literal">link</code></p></li><li><p><code class="literal">indexterm</code>, <code class="literal">primary</code></p></li><li><p><code class="literal">inlinemediaobject</code></p></li><li><p><code class="literal">inlineequation</code></p></li></ul></div></li></ul></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch03.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch05.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;3.&nbsp;Contents of the distribution&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;5.&nbsp;The command-line tools</td></tr></table></div></body></html>
\ No newline at end of file
diff --git a/scilab/modules/helptools/doc/html/ch05.html b/scilab/modules/helptools/doc/html/ch05.html
new file mode 100644 (file)
index 0000000..57fd94e
--- /dev/null
@@ -0,0 +1,7 @@
+<html><head>
+      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+   <title>Chapter&nbsp;5.&nbsp;The command-line tools</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.73.1"><link rel="start" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="up" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="prev" href="ch04.html" title="Chapter&nbsp;4.&nbsp;The Scilab subset of DocBook 5"><link rel="next" href="ch06.html" title="Chapter&nbsp;6.&nbsp;Recompiling the sources"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;5.&nbsp;The command-line tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch04.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch06.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="tools"></a>Chapter&nbsp;5.&nbsp;The command-line tools</h2></div></div></div><p>All command-line tools are self-documented. Simply execute the command without any argument to display a short help text. Example:</p><pre class="programlisting">C:\doc_kit\bin&gt; sciviewhelp
+Usage: sciviewhelp javahelp_jar_file ... javahelp_jar_file
+Allows to browse the contents of one or more
+JavaHelp[tm] .jar files created using sci2jh.
+The name of a JavaHelp .jar file must end with '_help.jar'.</pre><div class="variablelist"><dl><dt><a name="man2sci"></a><span class="term">man2sci, </span><span class="term">man2sci.bat</span></dt><dd><p>Converts a document conforming to <code class="literal">man.dtd</code> to a document conforming to <code class="literal">scilab.rnc</code>.</p><p>Usage: <code class="literal">man2sci <em class="replaceable"><code>in_man_xml_file</code></em> <em class="replaceable"><code>out_scilab_xml_file</code></em></code></p></dd><dt><a name="manrev2sci"></a><span class="term">manrev2sci, </span><span class="term">manrev2sci.bat</span></dt><dd><p>Converts a document conforming to <code class="literal">manrev.dtd</code> to a document conforming to <code class="literal">scilab.rnc</code>.</p><p>Usage: <code class="literal">manrev2sci <em class="replaceable"><code>in_manrev_xml_file</code></em> <em class="replaceable"><code>out_scilab_xml_file</code></em></code></p></dd><dt><a name="sci2html"></a><span class="term">sci2html, </span><span class="term">sci2html.bat</span></dt><dd><p>Converts an XML document conforming to <code class="literal">scilab.rnc</code> to multi-page HTML.</p><p>Usage: <code class="literal">sci2html <em class="replaceable"><code>in_xml_file</code></em> <em class="replaceable"><code>out_html_directory</code></em></code></p></dd><dt><a name="sci2chm"></a><span class="term">sci2chm.bat</span></dt><dd><p>Converts an XML document conforming to <code class="literal">scilab.rnc</code> to a Windows HTML Help (".<code class="literal">chm</code>") file. Not available on platforms other than Windows.</p><p>By default, this script assumes that <code class="literal">hhc.exe</code> is found in "<code class="literal">C:\Program Files\HTML Help Workshop\hhc.exe</code>". If this is not the case, please modify the "<code class="literal">hhc</code>" variable found at the beginning of the "<code class="literal">.bat</code>" file.</p><p>Usage: <code class="literal">sci2chm <em class="replaceable"><code>in_xml_file</code></em> <em class="replaceable"><code>out_chm_file</code></em></code></p></dd><dt><a name="sci2jh"></a><span class="term">sci2jh, </span><span class="term">sci2jh.bat</span></dt><dd><p>Converts an XML document conforming to <code class="literal">scilab.rnc</code> to a JavaHelp <code class="literal">.jar</code> file. <code class="literal">out_javahelp_jar_file</code> must end with "<code class="literal">_help.jar</code>".</p><p>Usage: <code class="literal">sci2jh <em class="replaceable"><code>in_xml_file</code></em> <em class="replaceable"><code>out_javahelp_jar_file</code></em></code></p></dd><dt><a name="sci2pdf"></a><span class="term">sci2pdf, </span><span class="term">sci2pdf.bat</span></dt><dd><p>Converts an XML document conforming to <code class="literal">scilab.rnc</code> to PDF or to PostScript. A PostScript file is generated if <em class="replaceable"><code>out_pdf_or_ps_file</code></em> ends with "<code class="literal">.ps</code>".</p><p>Usage: <code class="literal">sci2pdf <em class="replaceable"><code>in_xml_file</code></em> <em class="replaceable"><code>out_pdf_or_ps_file</code></em></code></p></dd><dt><a name="scivalid"></a><span class="term">scivalid, </span><span class="term">scivalid.bat</span></dt><dd><p>Validates specified XML files against the <code class="literal">scilab.rnc</code> schema.</p><p>Usage: <code class="literal">scivalid <em class="replaceable"><code>xml_file</code></em> ... <em class="replaceable"><code>xml_file</code></em></code></p></dd><dt><a name="sciviewhelp"></a><span class="term">sciviewhelp, </span><span class="term">sciviewhelp.bat</span></dt><dd><p>Allows to browse the contents of one or more JavaHelp .jar files created using <code class="literal">sci2jh</code>. The name of a JavaHelp <code class="literal">.jar</code> file must end with "<code class="literal">_help.jar</code>".</p><p>Usage: <code class="literal">sciviewhelp <em class="replaceable"><code>javahelp_jar_file</code></em> ... <em class="replaceable"><code>javahelp_jar_file</code></em></code></p></dd></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch04.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;4.&nbsp;The Scilab subset of DocBook 5&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;6.&nbsp;Recompiling the sources</td></tr></table></div></body></html>
\ No newline at end of file
diff --git a/scilab/modules/helptools/doc/html/ch06.html b/scilab/modules/helptools/doc/html/ch06.html
new file mode 100644 (file)
index 0000000..bd7f192
--- /dev/null
@@ -0,0 +1,13 @@
+<html><head>
+      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+   <title>Chapter&nbsp;6.&nbsp;Recompiling the sources</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.73.1"><link rel="start" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="up" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="prev" href="ch05.html" title="Chapter&nbsp;5.&nbsp;The command-line tools"><link rel="next" href="ch07.html" title="Chapter&nbsp;7.&nbsp;Companion tools"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;6.&nbsp;Recompiling the sources</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch05.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch07.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="build"></a>Chapter&nbsp;6.&nbsp;Recompiling the sources</h2></div></div></div><p>Directory <code class="literal">doc_kit/src/org/scilab/doc_kit/</code> contains the source code of two utility classes needed by some of the above command-line tools:</p><div class="variablelist"><dl><dt><span class="term">HelpViewer.java</span></dt><dd><p>The source code of <a class="link" href="ch05.html#sciviewhelp"><code class="literal">sciviewhelp</code></a>.</p></dd><dt><span class="term">CopyConvert.java</span></dt><dd><p>A preprocessor used as the first pass in <a class="link" href="ch05.html#sci2html"><code class="literal">sci2html</code></a>, <a class="link" href="ch05.html#sci2chm"><code class="literal">sci2chm</code></a>, <a class="link" href="ch05.html#sci2jh"><code class="literal">sci2jh</code></a> and <a class="link" href="ch05.html#sci2pdf"><code class="literal">sci2pdf</code></a>.</p><p>This preprocessor:</p><div class="itemizedlist"><ul type="disc"><li><p>Creates a ``flat' (entity references are expanded; <a class="link" href="http://www.w3.org/TR/xinclude/">XIncludes</a> are not supported) copy of the XML document to be transformed.</p></li><li><p>If the source document contains an embedded MathML element (<code class="literal">imagedata/mml:math</code>), this element is extracted to a temporary file, then the temporary file is converted to a PNG image by the means of <a class="link" href="http://jeuclid.sourceforge.net/">JEuclid</a>. After doing this, the original <code class="literal">imagedata/mml:math</code> found in the source is replaced in the flat XML document by an <code class="literal">imagedata</code> element pointing to the generated PNG file (<code class="literal">imagedata/@fileref</code>).</p></li><li><p>Same for embedded SVG elements which are converted to PNG images by the means of <a class="link" href="http://xmlgraphics.apache.org/batik/">Batik</a>.</p></li><li><p>If the source document contains an <code class="literal">imagedata</code> element pointing to a MathML file (filename extension is "<code class="literal">.mml</code>"), this file is converted to PNG by the means of <a class="link" href="http://jeuclid.sourceforge.net/">JEuclid</a>. After doing that, the <code class="literal">imagedata</code> element contained in the flat XML document is made to point to the <code class="literal">.png</code> file rather than to the <code class="literal">.mml</code> file.</p></li><li><p>Same for <code class="literal">imagedata</code> elements pointing to SVG files (filename extension is "<code class="literal">.svg</code>" or "<code class="literal">.svgz</code>"), but in this case, it is <a class="link" href="http://xmlgraphics.apache.org/batik/">Batik</a> which is used to perform the conversion.</p></li><li><p>Same for <code class="literal">imagedata</code> elements pointing to "<code class="literal">.tex</code>" files (assumed to contain math equations), but in this case, it is <a class="link" href="http://www.tug.org/">T<sub>E</sub>X</a>+<a class="link" href="http://pages.cs.wisc.edu/~ghost/">Ghostscript</a> which are used to perform the conversion.</p><p>The <code class="literal">CopyConvert</code> preprocessor searches the following programs in the <code class="literal">PATH</code>: <code class="literal">latex</code>, <code class="literal">dvips</code>, <code class="literal">gs</code> on Unix/<code class="literal">gswin32c</code> on Windows, <code class="literal">ps2pdf</code>.</p></li></ul></div></dd></dl></div><p>The above sources may be recompiled by running <a class="link" href="http://ant.apache.org/">ant</a> in the <code class="literal">doc_kit/src/</code> directory:</p><pre class="programlisting">C:\doc_kit/src&gt; dir /w
+...
+build.xml   [org]       [class]
+...
+C:\doc_kit/src&gt; ant
+Buildfile: build.xml
+
+init:
+
+compile:
+...</pre><p>Doing this rebuilds <code class="literal">sci_doc_kit.jar</code> in <code class="literal">doc_kit/lib/</code>.</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch05.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch07.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;5.&nbsp;The command-line tools&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;7.&nbsp;Companion tools</td></tr></table></div></body></html>
\ No newline at end of file
diff --git a/scilab/modules/helptools/doc/html/ch07.html b/scilab/modules/helptools/doc/html/ch07.html
new file mode 100644 (file)
index 0000000..b446e40
--- /dev/null
@@ -0,0 +1,3 @@
+<html><head>
+      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+   <title>Chapter&nbsp;7.&nbsp;Companion tools</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.73.1"><link rel="start" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="up" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="prev" href="ch06.html" title="Chapter&nbsp;6.&nbsp;Recompiling the sources"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter&nbsp;7.&nbsp;Companion tools</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch06.html">Prev</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;</td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="other_tools"></a>Chapter&nbsp;7.&nbsp;Companion tools</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p><a class="link" href="http://www.inkscape.org/">Inkscape</a>, an excellent drawing tool natively supporting SVG.</p></li><li><p><a class="link" href="http://miktex.org/">MiKTeX</a>, an excellent T<sub>E</sub>X distribution for Windows.</p></li><li><p><a class="link" href="http://www.xmlmind.com/xmleditor/">XMLmind XML Editor</a>, a visual XML editor with built-in support for DocBook 5. There are many fine XML editors but this one</p><div class="itemizedlist"><ul type="circle"><li><p>has a free <a class="link" href="http://www.xmlmind.com/xmleditor/persoedition.html">Personal Edition</a> allowing to use it to create documentation for Open Source projects such as Scilab,</p></li><li><p>has a configuration specially designed to support the Scilab DocBook 5 subset.</p></li></ul></div><p>This Scilab configuration is available as an add-on. This add-on may be downloaded and installed directly within XMLmind XML Editor using menu item <span class="bold"><strong>Options</strong></span>|<span class="bold"><strong>Install Add-ons</strong></span>. But before being able to do that, you must specify where to find such add-on. Fortunately this is done once for all:</p><div class="orderedlist"><ol type="1"><li><p>Use menu item <span class="bold"><strong>Options</strong></span>|<span class="bold"><strong>Preferences</strong></span>.</p></li><li><p>Click on the "<span class="bold"><strong>Install Add-ons</strong></span>" item in the left pane.</p><div class="mediaobject"><img src="resources/addonprefs.png"></div></li><li><p>Click the <span class="bold"><strong>Add</strong></span> button found at the right of the "<span class="bold"><strong>Download add-ons from these servers</strong></span>" list.</p></li><li><p>Specify the following URL "<code class="literal">http://www.scilab.org/download/scilab_config.xxe_addon</code>" when prompted, then click <span class="bold"><strong>OK</strong></span>.</p></li><li><p>Click <span class="bold"><strong>OK</strong></span> to close the <span class="bold"><strong>Preferences</strong></span> dialog box.</p></li></ol></div><p>From now, you can use menu item <span class="bold"><strong>Options</strong></span>|<span class="bold"><strong>Install Add-ons</strong></span> and select the add-on called "<span class="bold"><strong>A configuration for the Scilab subset of DocBook 5</strong></span>" from the list of all available add-ons.</p></li></ul></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch06.html">Prev</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;</td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;6.&nbsp;Recompiling the sources&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;</td></tr></table></div></body></html>
\ No newline at end of file
diff --git a/scilab/modules/helptools/doc/html/html.css b/scilab/modules/helptools/doc/html/html.css
new file mode 100644 (file)
index 0000000..2158da3
--- /dev/null
@@ -0,0 +1,27 @@
+body { 
+    background-color: #FFFFFF; 
+}
+
+h1, h2, h3, h4, h5 { 
+    color: #800000; 
+    font-family: sans-serif; 
+}
+
+span.term { 
+    font-weight: bold; 
+}
+
+div.sidebar { 
+    background-color: #F0F0F0; 
+    border: 1px solid gray; 
+    padding: 5px; 
+    margin: 20px; 
+}
+
+pre.programlisting { 
+    background-color: #F0F0F0; 
+    border: 1px solid gray; 
+    padding: 2px; 
+    font-size: 10pt;
+    white-space: pre;
+}
diff --git a/scilab/modules/helptools/doc/html/images/callouts/1.png b/scilab/modules/helptools/doc/html/images/callouts/1.png
new file mode 100644 (file)
index 0000000..7d47343
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/1.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/10.png b/scilab/modules/helptools/doc/html/images/callouts/10.png
new file mode 100644 (file)
index 0000000..997bbc8
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/10.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/11.png b/scilab/modules/helptools/doc/html/images/callouts/11.png
new file mode 100644 (file)
index 0000000..ce47dac
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/11.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/12.png b/scilab/modules/helptools/doc/html/images/callouts/12.png
new file mode 100644 (file)
index 0000000..31daf4e
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/12.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/13.png b/scilab/modules/helptools/doc/html/images/callouts/13.png
new file mode 100644 (file)
index 0000000..14021a8
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/13.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/14.png b/scilab/modules/helptools/doc/html/images/callouts/14.png
new file mode 100644 (file)
index 0000000..64014b7
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/14.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/15.png b/scilab/modules/helptools/doc/html/images/callouts/15.png
new file mode 100644 (file)
index 0000000..0d65765
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/15.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/2.png b/scilab/modules/helptools/doc/html/images/callouts/2.png
new file mode 100644 (file)
index 0000000..5d09341
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/2.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/3.png b/scilab/modules/helptools/doc/html/images/callouts/3.png
new file mode 100644 (file)
index 0000000..ef7b700
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/3.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/4.png b/scilab/modules/helptools/doc/html/images/callouts/4.png
new file mode 100644 (file)
index 0000000..adb8364
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/4.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/5.png b/scilab/modules/helptools/doc/html/images/callouts/5.png
new file mode 100644 (file)
index 0000000..4d7eb46
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/5.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/6.png b/scilab/modules/helptools/doc/html/images/callouts/6.png
new file mode 100644 (file)
index 0000000..0ba694a
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/6.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/7.png b/scilab/modules/helptools/doc/html/images/callouts/7.png
new file mode 100644 (file)
index 0000000..472e96f
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/7.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/8.png b/scilab/modules/helptools/doc/html/images/callouts/8.png
new file mode 100644 (file)
index 0000000..5e60973
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/8.png differ
diff --git a/scilab/modules/helptools/doc/html/images/callouts/9.png b/scilab/modules/helptools/doc/html/images/callouts/9.png
new file mode 100644 (file)
index 0000000..a0676d2
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/callouts/9.png differ
diff --git a/scilab/modules/helptools/doc/html/images/draft.png b/scilab/modules/helptools/doc/html/images/draft.png
new file mode 100644 (file)
index 0000000..0084708
Binary files /dev/null and b/scilab/modules/helptools/doc/html/images/draft.png differ
diff --git a/scilab/modules/helptools/doc/html/index.html b/scilab/modules/helptools/doc/html/index.html
new file mode 100644 (file)
index 0000000..1bb450a
--- /dev/null
@@ -0,0 +1,3 @@
+<html><head>
+      <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+   <title>doc_kit, a toolkit for Scilab documentation writers</title><link rel="stylesheet" href="html.css" type="text/css"><meta name="generator" content="DocBook XSL-NS Stylesheets V1.73.1"><link rel="start" href="index.html" title="doc_kit, a toolkit for Scilab documentation writers"><link rel="next" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">doc_kit, a toolkit for Scilab documentation writers</th></tr><tr><td width="20%" align="left">&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr></div><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="d0e1"></a>doc_kit, a toolkit for Scilab documentation writers</h1></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="ch01.html">1. Introduction</a></span></dt><dt><span class="chapter"><a href="ch02.html">2. Installation</a></span></dt><dt><span class="chapter"><a href="ch03.html">3. Contents of the distribution</a></span></dt><dt><span class="chapter"><a href="ch04.html">4. The Scilab subset of DocBook 5</a></span></dt><dt><span class="chapter"><a href="ch05.html">5. The command-line tools</a></span></dt><dt><span class="chapter"><a href="ch06.html">6. Recompiling the sources</a></span></dt><dt><span class="chapter"><a href="ch07.html">7. Companion tools</a></span></dt></dl></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left">&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;1.&nbsp;Introduction</td></tr></table></div></body></html>
\ No newline at end of file
diff --git a/scilab/modules/helptools/doc/html/resources/addonprefs.png b/scilab/modules/helptools/doc/html/resources/addonprefs.png
new file mode 100644 (file)
index 0000000..9c84dd3
Binary files /dev/null and b/scilab/modules/helptools/doc/html/resources/addonprefs.png differ
diff --git a/scilab/modules/helptools/schema/scilab.rnc b/scilab/modules/helptools/schema/scilab.rnc
new file mode 100644 (file)
index 0000000..55eb35e
--- /dev/null
@@ -0,0 +1,590 @@
+# Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+# Copyright (C) 2008 - INRIA
+#
+# This file must be used under the terms of the CeCILL.
+# This source file is licensed as described in the file COPYING, which
+# you should have received as part of this distribution.  The terms
+# are also available at
+# http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+
+default namespace db = "http://docbook.org/ns/docbook"
+namespace a = "http://relaxng.org/ns/compatibility/annotations/1.0"
+namespace xlink = "http://www.w3.org/1999/xlink"
+namespace mml = "http://www.w3.org/1998/Math/MathML"
+namespace svg = "http://www.w3.org/2000/svg"
+namespace html = "http://www.w3.org/1999/xhtml"
+
+start = book |
+        part | reference |
+        chapter | appendix |
+        refentry
+
+### --------------------------------------------------------------------------
+### Book, part, reference
+### --------------------------------------------------------------------------
+
+book = element book {
+    common.attributes,
+    ((title, info.no.title?) | info.with.title),
+    (part | reference | chapter | appendix)+
+}
+
+part = element part {
+    common.attributes,
+    ((title, info.no.title?) | info.with.title),
+    partintro?,
+    (chapter | appendix)+
+}
+
+reference = element reference {
+    common.attributes,
+    ((title, info.no.title?) | info.with.title),
+    partintro?,
+    refentry+
+}
+
+partintro = element partintro {
+    any.block+
+}
+
+### -------------------------------------
+### Meta-info
+### -------------------------------------
+
+info.with.title = element info {
+    common.attributes,
+    title,
+    any.info*
+}
+
+info.no.title = element info {
+    common.attributes,
+    any.info*
+}
+
+any.info = author | pubdate | keywordset
+
+author = element author {
+    common.attributes,
+    personname,
+    affiliation?
+}
+
+personname = element personname {
+    common.attributes,
+    simple.inline*
+}
+
+affiliation = element affiliation {
+    common.attributes,
+    jobtitle?,
+    orgname
+}
+
+jobtitle = element jobtitle {
+    common.attributes,
+    simple.inline*
+}
+
+orgname = element orgname {
+    common.attributes,
+    simple.inline*
+}
+
+pubdate = element pubdate {
+    common.attributes,
+    text
+}
+
+keywordset = element keywordset {
+    common.attributes,
+    keyword+
+}
+
+keyword = element keyword {
+    common.attributes,
+    text
+}
+
+### -------------------------------------
+### Common attributes
+### -------------------------------------
+
+common.attributes = xml.id.attribute? &
+                    xml.lang.attribute? &
+                    version.attribute? &
+                    role.attribute?
+
+xml.id.attribute = attribute xml:id { xsd:ID }
+
+xml.lang.attribute = attribute xml:lang { text }
+
+version.attribute = attribute version { text }
+
+role.attribute = attribute role { text }
+
+### --------------------------------------------------------------------------
+### Refentry
+### --------------------------------------------------------------------------
+
+refentry = element refentry {
+    common.attributes,
+    info.no.title?,
+    refnamediv+,
+    refsynopsisdiv?,
+    refsection+
+}
+
+refnamediv = element refnamediv {
+    common.attributes,
+    refname,
+    refpurpose
+}
+
+refname = element refname {
+    common.attributes,
+    any.inline*
+}
+
+refpurpose = element refpurpose {
+    common.attributes,
+    any.inline*
+}
+
+refsynopsisdiv = element refsynopsisdiv {
+    common.attributes,
+    title?,
+    synopsis
+}
+
+synopsis = element synopsis {
+    common.attributes,
+    preserve.space,
+    any.inline*
+}
+
+preserve.space =
+  [ a:defaultValue = "preserve" ] attribute xml:space { "preserve" }?
+
+refsection = element refsection {
+    common.attributes,
+    title,
+    ((any.block+, refsection*) | refsection+)
+}
+
+### --------------------------------------------------------------------------
+### Chapter, appendix, section
+### --------------------------------------------------------------------------
+
+chapter = element chapter {
+    common.attributes,
+    title,
+    ((any.block+, section*) | section+)
+}
+
+title = element title {
+    common.attributes,
+    any.inline*
+}
+
+appendix = element appendix {
+    common.attributes,
+    title,
+    ((any.block+, section*) | section+)
+}
+
+section = element section {
+    common.attributes,
+    title,
+    ((any.block+, section*) | section+)
+}
+
+### --------------------------------------------------------------------------
+### Block-level elements
+### --------------------------------------------------------------------------
+
+any.block = simple.block | 
+            figure | table | equation | example | note 
+
+simple.block = para | programlisting |
+               itemizedlist | orderedlist | variablelist | simplelist |
+               informaltable |
+               informalequation | mediaobject
+
+### -------------------------------------
+### Block-level elements having a title
+### -------------------------------------
+
+figure = element figure {
+    common.attributes,
+    title,
+    simple.block+
+}
+
+example = element example {
+    common.attributes,
+    title,
+    simple.block+
+}
+
+note = element note {
+    common.attributes,
+    ## Note is useful with or without a title.
+    title?,
+    simple.block+
+}
+
+equation = element equation {
+    common.attributes,
+    ## Made title required in the Scilab subset.
+    ## (If you don't want a title, use informalequation.)
+    title,
+    mediaobject
+}
+
+table = element table {
+    common.attributes,
+    html.table.attributes,
+    caption,
+    html.table.model
+}
+
+caption = element caption {
+    common.attributes,
+    any.inline*
+}
+
+### -------------------------------------
+### Table
+### -------------------------------------
+
+informaltable = element informaltable {
+    common.attributes,
+    html.table.attributes,
+    html.table.model
+}
+
+html.table.model = 
+  (html.col* | html.colgroup*),
+  html.thead?,
+  html.tfoot?,
+  (html.tbody+ | html.tr+)
+
+html.colgroup = element colgroup { 
+    common.attributes,
+    html.column.attributes,
+    html.col* 
+}
+
+html.col = element col { 
+    common.attributes, 
+    html.column.attributes,
+    empty 
+}
+
+html.thead = element thead { 
+    common.attributes,
+    html.row.attributes,
+    html.tr+ 
+}
+
+html.tfoot = element tfoot { 
+    common.attributes, 
+    html.row.attributes,
+    html.tr+ 
+}
+
+html.tbody = element tbody { 
+    common.attributes, 
+    html.row.attributes,
+    html.tr+ 
+}
+
+html.tr = element tr { 
+    common.attributes, 
+    html.row.attributes,
+    (html.th | html.td)+ 
+}
+
+html.td = element td {
+    common.attributes, 
+    html.cell.attributes,
+    (any.inline* | any.block*)
+}
+
+html.th = element th {
+    common.attributes, 
+    html.cell.attributes,
+    (any.inline* | any.block*)
+}
+
+html.table.attributes =
+    attribute summary { text }? & 
+    attribute width { xsd:integer | xsd:string { pattern = "[0-9]+%" } }? & 
+    attribute border { xsd:nonNegativeInteger }? & 
+    attribute frame {
+        "void" | "above" | "below" | "hsides" | "lhs" | "rhs" | 
+        "vsides" | "box" | "border"
+    }? & 
+    attribute rules { "none" | "groups" | "rows" | "cols" | "all" }? & 
+    attribute cellspacing { 
+        xsd:integer | xsd:string { pattern = "[0-9]+%" }
+    }? &
+    attribute cellpadding { xsd:integer | xsd:string { pattern = "[0-9]+%" } }?
+
+html.column.attributes = 
+    attribute span { xsd:nonNegativeInteger }? & 
+    attribute width { text }? &
+    html.halign.attributes & 
+    html.valign.attributes
+
+html.row.attributes = 
+    html.halign.attributes & 
+    html.valign.attributes
+
+html.cell.attributes =
+    attribute abbr { text }? & 
+    attribute axis { text }? & 
+    attribute headers { text }? & 
+    attribute scope { "row"| "col" | "rowgroup" | "colgroup" }? & 
+    attribute rowspan { xsd:nonNegativeInteger }? & 
+    attribute colspan { xsd:nonNegativeInteger }? &
+    html.halign.attributes & 
+    html.valign.attributes
+
+html.halign.attributes = 
+    attribute align { "left" | "center" | "right" | "justify" | "char" }? & 
+    attribute char { text }? &
+    attribute charoff { xsd:integer | xsd:string { pattern = "[0-9]+%" } }?
+
+html.valign.attributes =
+    attribute valign { "top" | "middle" | "bottom" | "baseline" }?
+
+### -------------------------------------
+### Lists
+### -------------------------------------
+
+itemizedlist = element itemizedlist {
+    common.attributes,
+    spacing.attribute?,
+    listitem+
+}
+
+spacing.attribute = attribute spacing { "compact" | "normal" }
+
+listitem = element listitem {
+    common.attributes,
+    any.block+
+}
+
+orderedlist = element orderedlist {
+    common.attributes,
+    spacing.attribute?,
+    numeration.attribute?,
+    listitem+
+}
+
+numeration.attribute = attribute numeration { 
+    "arabic" | "upperalpha" | "loweralpha" | "upperroman" | "lowerroman"
+}
+
+variablelist = element variablelist {
+    common.attributes,
+    spacing.attribute?,
+    varlistentry+
+}
+
+varlistentry = element varlistentry {
+    common.attributes,
+    term+,
+    listitem
+}
+
+term = element term {
+    common.attributes,
+    any.inline*
+}
+
+simplelist = element simplelist {
+    common.attributes,
+    columns.attribute?,
+    type.attribute?,
+    member+
+}
+
+columns.attribute = attribute columns { xsd:positiveInteger }
+
+type.attribute = attribute type { "horiz" | "vert" | "inline" }
+
+member = element member {
+    common.attributes,
+    any.inline*
+}
+
+### -------------------------------------
+### Paragraphs
+### -------------------------------------
+
+para = element para {
+    common.attributes,
+    any.inline*
+}
+
+programlisting = element programlisting {
+    common.attributes,
+    preserve.space,
+    any.inline*
+}
+
+### -------------------------------------
+### Illustrations
+### -------------------------------------
+
+informalequation = element informalequation {
+    common.attributes,
+    mediaobject
+}
+
+mediaobject = element mediaobject {
+    common.attributes,
+    imageobject
+}
+
+imageobject = element imageobject {
+    common.attributes,
+    (imagedata | imagedata.mathml | imagedata.svg)
+}
+
+imagedata = element imagedata {
+    imagedata.common.attributes,
+    fileref.attribute
+}
+
+fileref.attribute = attribute fileref { xsd:anyURI }
+
+imagedata.common.attributes = common.attributes &
+    imagedata.width.attribute? &
+    imagedata.depth.attribute? &
+    imagedata.align.attribute? &
+    imagedata.valign.attribute? &
+    imagedata.contentwidth.attribute? &
+    imagedata.contentdepth.attribute? &
+    imagedata.scalefit.attribute? &
+    imagedata.scale.attribute?
+
+imagedata.width.attribute = attribute width { text }
+imagedata.depth.attribute = attribute depth { text }
+
+imagedata.align.attribute = attribute align { "left" | "center" | "right" }
+imagedata.valign.attribute = attribute valign { "bottom" | "middle" | "top" }
+
+imagedata.contentwidth.attribute = attribute contentwidth { text }
+imagedata.contentdepth.attribute = attribute contentdepth { text }
+
+imagedata.scalefit.attribute = attribute scalefit { "0" | "1" }
+imagedata.scale.attribute = attribute scale { xsd:positiveInteger }
+
+imagedata.mathml = element imagedata {
+    imagedata.common.attributes,
+    element mml:* { (any.attribute | text | any.element)* }
+}
+
+imagedata.svg = element imagedata {
+    imagedata.common.attributes,
+    element svg:* { (any.attribute | text | any.element)* }
+}
+
+any.attribute = attribute * { text }
+
+any.element = element * - (db:* | html:*) {
+    (any.attribute | text | any.element)*
+}
+
+### --------------------------------------------------------------------------
+### Inline-level elements
+### --------------------------------------------------------------------------
+
+any.inline = simple.inline | 
+             emphasis | literal | 
+             inlineequation
+
+simple.inline = text | phrase | replaceable | subscript | superscript |
+                indexterm | 
+                inlinemediaobject | 
+                link 
+
+### -------------------------------------
+### ``Rich'' inline-level elements
+### -------------------------------------
+
+link = element link {
+    common.attributes,
+    (linkend.attribute | xlink.href.attribute),
+    any.inline*
+}
+
+linkend.attribute = attribute linkend { xsd:IDREF }
+
+xlink.href.attribute = attribute xlink:href { xsd:anyURI }
+
+emphasis = element emphasis {
+    common.attributes,
+    any.inline*
+}
+
+### -------------------------------------
+### Simple inline-level elements
+### -------------------------------------
+
+literal = element literal {
+    common.attributes,
+    simple.inline*
+}
+
+phrase = element phrase {
+    common.attributes,
+    simple.inline*
+}
+
+replaceable = element replaceable {
+    common.attributes,
+    simple.inline*
+}
+
+subscript = element subscript {
+    common.attributes,
+    simple.inline*
+}
+
+superscript = element superscript {
+    common.attributes,
+    simple.inline*
+}
+
+### -------------------------------------
+### Illustrations
+### -------------------------------------
+
+inlineequation = element inlineequation {
+    common.attributes,
+    inlinemediaobject
+}
+
+inlinemediaobject = element inlinemediaobject {
+    common.attributes,
+    imageobject
+}
+
+### -------------------------------------
+### Index entry
+### -------------------------------------
+
+indexterm = element indexterm {
+    common.attributes,
+    primary        
+}
+
+primary = element primary {
+    common.attributes,
+    text     
+}