Logo

Integrando o editor de código com ajuda on line (Help)

Gladiston Santana - Um site para chamar de meu

Introdução

A ajuda integrada ao editor (F1) é essencial para consultar rapidamente a documentação de funções, métodos e classes. No instalador oficial do Lazarus, essa integração já vem configurada; em instalações via GIT ou fpcupdeluxe, é preciso configurá-la manualmente.

(Este subtópico pode estar incompleto; contribuições são bem-vindas.)

Quando usado o instalador oficial do Lazarus o editor de código é integrado a ajuda online, ou seja, se você der um F1 quando uma função ou método estiver em foco então uma janela abre-se com uma explicação sobre o mesmo. Infelizmente isso não funciona quando você faz a instalação via GIT, essa integração você precisa fazer manualmente. Vamos ao procedimento.

Vá até a pasta:

$(LazarusDir)\components\chmhelp\lhelp

Lá você encontrará um arquivo intitulado lhelp (Linux, FreeBSD, macOS) ou lhelp.exe se for Windows. Se você não encontrá-lo é porque você não instalou o pacote ‘chmhelppkg.lpk’, o que é bem estranho, já que o mesmo vem pré-instalado logo depois da compilação pronta.

Agora vá para a pasta:

$(LazarusDir)\docs\chm

E lá você deve encontrar por uma série de arquivos com a extensão *.chm. No meu caso, eles não existem, então aponte seu navegador de internet para o seguinte endereço:

Lazarus Documentation no SourceForge

Página de Documentação do Lazarus

Entre no link correspondente à versão mais recente e faça o Download de um arquivo .zip que internamente tem os arquivos de ajuda (.chm):

Download do arquivo de ajuda

Descompacte os arquivos na pasta:

$(LazarusDir)\docs\chm

Ficando assim:

Arquivos CHM extraídos

Imagem meramente ilustrativa da pasta de ajuda.

Neste ponto a IDE do Lazarus já é esperta o suficiente para quando você apertar F1 e chamar a ajuda online. Faça o teste usando o Object Inspector ou alguma função ou método em seu código.

Caso a ajuda online não funcione, vá em Tools | Options | Help, e selecione CHM Help Viewer:

Configuração do Visualizador de Ajuda CHM

Entenda os parâmetros

Conclusão

A documentação e a ajuda online são altamente requeridas. Faz muito sentido você confirmar se a mesma está presente em seu sistema e, se não estiver, seguir os procedimentos delineados.