Você está na página 1de 9

Criando uma Documentao Utilizando HelpCase

Postados: John Lennon [j.lennon@netmake.com.br] Endereo da Pgina: http://www.netmake.com.br/knowledge/article-88.html HelpCase

um gerador de documentao web totalmente integrado com os projetos desenvolvidos no ScriptCase. Com o HelpCase a documentao do seu sistema se torna uma tarefa muito mais fcil e no ser preciso utilizar uma outra ferramenta, sendo desta forma mais uma facilidade implementada.

HelpCase - Criando um Manual Um Manual construido no HelpCase est sempre associado a um Projeto do ScriptCase. Na interface de criar (ver figura1) um novo Manual no exibido uma opo para escolha do Projeto, pois o Projeto j est implicitamente selecionado sendo ele o projeto em que o ScriptCase esteja acessando no momento.

Page 1/9 PDF Generated by PHPKB Knowledge Base Script

Page 2/9 PDF Generated by PHPKB Knowledge Base Script

Figura1: Criando um Novo Manual

Iniciando um Projeto

HelpCase - Editando um Projeto

Page 3/9 PDF Generated by PHPKB Knowledge Base Script

Page 4/9 PDF Generated by PHPKB Knowledge Base Script

Barra de Botes Superior: Est barra responsvel pela manuteno das pastas e arquivos contidos no diretorio selecionado. Inicialmente o Projeto contm um nico diretrio chamado root ( ). Os diretrio que forem criados sero exibidos no menu treeview.

Criando um Novo diretrio Cria um novo diretrio no manual no diretrio selecionado.

Diretrio criado na Raiz do Root.

Page 5/9 PDF Generated by PHPKB Knowledge Base Script

Criando um Novo Arquivo HTML

Arquivo Html criado na Raiz do Diretrio (form_cadastro).

* - Realizando Upload de Imagens e Documentos.


Selecionando a Barra de Ferramentas a opo - Upload

Formulrio de Upload de Imagens.

Page 6/9 PDF Generated by PHPKB Knowledge Base Script

Page 7/9 PDF Generated by PHPKB Knowledge Base Script

Imagem arquivada no mesmo diretrio de (_images).

Para realizar includes de arquivos, temos uma opo na barra de Ferramentas do Editor, onde realiza a chamada da incluso onde estar dispon-vel o arquivo inclu-do. S necessrio informar o nome do arquivo que foi realizado o upload dentro do diretrio (_commons). Veja na Imagem Abaixo:

Editanto o Arquivo Html.

Editanto o Arquivo Html utilizando o Editor, com as opes na Barra de Ferramentas. * - A Imagem selecionada abre uma janela para a Insero de uma Imagem. Informando o endereo da Imagem (sempre a partir da pasta de seu manual HelpCase). Neste exemplo apartir da pasta (_images) sendo observada na Imagem abaixo.

Arquivo Html com as Configuraes de Texto e Imagem Definidas. (Depois Salve clicando no Boto Salvar).

Selecionando a Opo de Pginal Inicial do Manual.

Page 8/9 PDF Generated by PHPKB Knowledge Base Script

Pginal Inicial do Manual. (Depois Salve clicando no Boto Salvar).

Gerando o Manual. Selecinando o Link da Barra de Ferramentas (Gerar WebHelp)

Manual Gerado. 1 - Arquivo Html do Manual. 2 - O arquivo zipado contendo imagens e arquivos do Manual.

Manual Gerado.

Item do Link do Manual.

Page 9/9 PDF Generated by PHPKB Knowledge Base Script