4D Doc Center : Apêndice A: Designar um arquivo de ajuda personalizado

4D v14.3

Apêndice A: Designar um arquivo de ajuda personalizado

4D permite associar um arquivo de ajuda on-line personalizado a cada um de seus bancos.

O sistema de ajuda on-line personalizado de 4D é compatível com todos os ambientes 4D (base monoposto ou cliente-servidor, interpretada ou compilada, executada com 4D Desktop Interpreted ou integrado com 4D Desktop Volume, etc.).

4D suporta dois formatos de arquivos de ajuda: CHM e HTML. Estes formatos correspondem aos padrões da indústria informática.

Além do mais, é possível associar uma seção específica deste arquivo de ajuda a cada formulário da base, o que lhe permite oferecer uma ajuda contextual on-line.

Configurar o sistema de ajuda on-line da base

Formatos de arquivos

Deve utilizar um dos seguintes formatos:

Formato HTML compilado (extensão “.CHM”), que é o formato padrão de ajuda on-line para Windows. Os arquivos CHM são abertos pela aplicação Microsoft ® HTML Help Executable (HH.EXE), integrada ao sistema operativo. Estes arquivos são compatíveis com Windows XP e Windows Vista. Microsoft® oferece gratuitamente a aplicação HTML Help Workshop, necessária para a preparação e compilação dos arquivos .CHM.
Formato HTML (extensão ”.HTM"), o qual é o formato HTML. Com este formato, você pode criar uma ajuda on-line idêntica para todas as plataformas. A ajuda on-line se mostra em um navegador web.

Associar o arquivo de ajuda em linha à base

Uma vez gerado o arquivo Ajuda, esse deve ser associado a um banco de maneira que seja aberta quando os usuários chamem a ajuda on-line (ver Chamar a ajuda on-line desde uma base). Para designar um arquivo de ajuda a uma base, assegure-se de que:

O nome do arquivo de ajuda seja idêntico ao do arquivo de estrutura da base. Obrigatoriamente deve ter a extensão “.CHM” ou “.HTM”, dependendo de seu formato e plataforma.
O arquivo de ajuda esteja localizado junto ao arquivo de estrutura ou na pasta Resources localizada no mesmo nível do arquivo de estrutura do banco.

4D Server: se quer que o arquivo de ajuda seja accessível a todas as estações de trabalho dos clientes, localize o arquivo na pasta Resources. Então este será transferido automaticamente às estações de trabalho dos clientes.

Os plug-ins podem ter um arquivo de ajuda, que deve localizar-se na pasta PlugIns tanto em aplicações monoposto como no cliente/servidor. O arquivo de ajuda de um plug-in deve ter o mesmo nome do plug-in com a extensão .CHM o .HTM. Para os plug-ins propostos em forma de pasta, o arquivo ajuda deve ser localizado:
- junto ao executado do plug-in, em /Contents/MacOS ou /Contents/Windows
- ou na pasta /Contents/Resources do plug-in.

Os componentes podem igualmente incluir um arquivo de ajuda personalizado, localizado junto ao arquivo de estrutura do componente. Para maiores informações, consulte Ajuda on-line para componentes.

Criar uma ajuda contextual on-line

A criação de ajuda on-line contextual é realizada associando um número de seção com cada um de seus formulários. Quando solicitar a ajuda on-line desde um formulário, é mostrada a página de ajuda correspondente. Quando o usuário solicita a ajuda on-line, é mostrado o tema de ajuda que tem o mesmo ID que o formulário.

A ajuda on-line contextual está disponível:

em Windows, se a ajuda on-line está em formato CHM.
em Windows e Mac OS, se a ajuda on-line está em formato HTML.

A designação de um número de identificação a um formulário é efetuada nas propriedades do formulário. Para maiores informações, consulte Ajuda.

Após ter designado o número de identificação para o formulário, é preciso designar o mesmo número de identificação ao arquivo ajuda. Esta operação varia de acordo com o formato que está utilizando:

Para os arquivos CHM, consulte a documentação da aplicação HTML Help Workshop.
Para os arquivos HTML, você deve declarar cada seção com a ajuda de uma âncora e designar-lhe um número.
Uma seção se declara utilizando um marcador de tipo
```
<A NAME="Section">
```
Por exemplo,
```
 <A NAME="21">
```
O URL da seção é desta forma:
```
<A HREF="#Section">...</A>
```
Por exemplo,
```
<A HREF="#21">...</A>
```

Se o número de seção passado ao formulário é 0 ou se não existe no arquivo, 4D mostra a primeira página do arquivo de ajuda.

Chamar a ajuda on-line desde uma base

Em 4D, pode chamar uma ajuda on-line personalizada de um banco de dados de duas formas:

Escolhendo Ajuda de NomeBanco no menu Ajuda. Neste caso, é mostrada a primeira página do arquivo ajuda.
pressionando a tecla F1(Mac OS e Windows) ou a tecla Help (somente Mac OS) quando é mostrado um formulário no modo Aplicação. Neste caso, se um número de ajuda já tenha sido associado ao formulário, é mostrada a página correspondente (ajuda contextual); do contrário
é mostrada a primeira página do arquivo ajuda.

Nota: em Mac OS, o funcionamento da tecla F1 pode ser personalizado. No modo Aplicação, quando o usuário pressiona a tecla F1:

se um arquivo “NomeBase.HTM” existe junto ao arquivo de estrutura da base, é implementado o mecanismo padrão de gestão de ajudas on-line de 4D. O arquivo de ajuda é aberto em uma janela do navegador automaticamente.
Do contrário, 4D não faz nada e o desenvolvedor deve processar o evento como quiser. Isto permite configurar sistemas de ajuda totalmente personalizados ou designar outra função para a tecla F1.