Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
2025.0.0 - Français


help_skeleton

build the skeleton of the xml help file associated to a Scilab function

Syntax

txt = help_skeleton(funname [,path [,language]])

Arguments

funname

character string : the name of the function

path

character string : the path where the file will be create if required. If this argument is not given the skeleton is returned as a string.

language

character string :with possible value "fr_FR" or "en_US" the default is "en_US"

txt

the XML code or the complete XML file path

Description

txt = help_skeleton(funname) generates a vector of strings containing the skeleton of the XML code describing the help of the function funname.

fullpath = help_skeleton(funname,dirpath) generates the XML code describing the help of the function funname in a file named funname.xml in the directory specified by the path dirpath. In this case the function returns the file path.

Examples

function [y, z]=foo(a, b),y=a+b,z=1,endfunction
p=help_skeleton('foo',TMPDIR)
if (isdef('editor') | (funptr('editor')<>0)) then
  editor(p);
end

See also

Report an issue
<< help_from_sci utilities Link toolbox help with Scilab one >>

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:
Thu Oct 24 11:16:04 CEST 2024