<< help_from_sci utilities Link toolbox help with Scilab one >>

Scilab Help >> Gerenciamento de ajuda online > utilities > help_skeleton

help_skeleton

constrói o esqueleto do arquivo de ajuda xml associado à função Scilab

Seqüência de Chamamento

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

Parâmetros

funname

string : o nome da função

path

string : o endereço onde se criará o arquivo, se for requerido. Se este argumento não for fornecido, o esqueleto é retornado como um string.

language

string :com valor possível "fr_FR" ou "en_US" o padrão é "en_US"

txt

o código xml ou o endereço do arquivo xml completo

Descrição

txt = help_skeleton(funname) gera um vetor de strings contendo o esqueleto do código XML descrevendo a ajuda da função funname.

fullpath = help_skeleton(funname,dirpath) gera o código XML descrevendo a ajuda da função funname em um arquivo nomeado funname.xml no diretório especificado pelo endereço dirpath. Neste caso, a função retorna o endereço do arquivo.

Exemplos

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

Ver Também


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