%helps

Descrição

A variável global %helps é uma matriz N x 2 de strings. A k-ésima linha de %helps, %helps(k,:) representa o k-ésimo capítulo do manual e é feita de dois strings:

%helps(k,1) é o nome de endereço absoluto de um diretório.

%helps(k,2) é um título para este diretório. Por exemplo, para k=2, nós temos o capítulo de gráficos %helps(2,:).

A variável %helps é definida no arquivo de inicialização do Scilab SCI+"/scilab.start".

Para adicionar um novo diretório de ajuda, o usuário deve adicionar uma linha a %helps. (Uma linha para cada diretório).

Por exemplo, %helps=[%helps; "Path-Of-My-Help-Dir","My-Title"]; habilita o navegador de ajuda do Scilab a procurar por itens do manual de ajuda no diretório com endereço "Path-Of-My-Help-Dir".

"My-Title" é, então, o título do novo capítulo de ajuda.

Um diretório válido deve conter:

1- Um conjunto de arquivos.html (ex.: item1.html, item2.html etc). Os arquivos .html são geralmente construídos de arquivos XML.

2- Um arquivo whatis.html, que deve conter um formato especial. Cada linha de whatis deve ser como segue:

<BR><A HREF="item.html">item</A> - rapida descricao

item é o item da ajuda, i.e. o comando help item exibe o conteúdo do arquivo item.html.

O comando apropos keyword retorna as linhas de todos os arquivos whatis.html nos quais a palavra-chave keyword aparece.

Em plataformas Linux, o Scilab provê um Makefile para transformar páginas .xml pages em páginas .html (ver SCIDIR/examples/man-examples).

Exemplos

global %helps  // This instruction creates a local %helps variable connected to the global one
%helps
if %helps==[]                    // No help chapter is registered for any external module
    if atomsGetInstalled()==[]   // If no external module is installed
        atomsInstall uman;       //  we install the "uman" one (available for all plateforms)
    end
    atomsLoad(atomsGetInstalled()(1));  // We load the first module, included its help pages
    %helps                       // Now the external chapter should be registered
end

Ver Também

• apropos — procura por palavras-chave na ajuda do Scilab
• help — queries and displays help pages in the Scilab help browser