Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
6.0.0 - English

Change language to:
Français - 日本語 - Português - Русский

Please note that the recommended version of Scilab is 2024.1.0. This page might be outdated.
See the recommended documentation of this function

Scilab Help >> Documentation system > Link toolbox help with Scilab one

Link toolbox help with Scilab one

How to make hyperlink in toolbox help pointing to Scilab's items


Since Scilab 5.3.1, the hyperlinks in a toolbox help can be used to point on any help pages or to execute demos in the console.

Now you can link a demo Uicontrol demo or execute a script about.sce


  • To link from two external modules, the syntax is: <link type="scilab" linkend="">fun_in_module_name</link> Usually, the name of the function is the id of the page.

  • To link from a external module to a Scilab function, the syntax is: <link type="scilab" linkend="">bvode</link> Usually, the name of the function is the id of the page.

  • To enable the execution of a script, the syntax is: <link type="scilab" linkend="mytoolbox.exec/macros/fooexec.sce">macros/fooexec.sce</link>

  • To enable the execution of a demo, the syntax is: <link type="scilab" linkend="mytoolbox.demos/mydemo.dem">My demo</link>


<?xml version="1.0" encoding="UTF-8"?>
    <refentry xmlns:scilab=""
      <refnamediv xml:id="foo">
        <refpurpose>calculates foo</refpurpose>
        <!-- Link on Scilab's help -->
        <para>Firstly a link on <link type="scilab" linkend="">bvode</link> in the Scilab Doc</para>
        <!-- Link on a demo, foodemo must be in toolbox_path/demos/ -->
        <para>Secondly a link on <link type="scilab" linkend="mytoolbox.demos/foodemo">My demo</link></para>
        <!-- the executed macro will be toolbox_path/macros/fooexec.sce -->
        <para>Thirdly a link on <link type="scilab" linkend="mytoolbox.exec/macros/fooexec.sce">macros/fooexec.sce</link></para>
        <!-- a link for erroneous links -->
        <para>Fourthly a link on <link type="scilab" linkend="">invalid link</link></para>
      <programlisting role="example">
        plot3d() // should link on plot3d
Report an issue
<< help_skeleton Documentation system Scilab documentation format >>

Copyright (c) 2022-2024 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Tue Feb 14 15:03:08 CET 2017