Lazarus Offline Documentation

With this article you will know to integrate existing HTML documentation about Run-Time Library (RTL) , Free Component Library (FCL) and Lazarus Component Library (LCL) into Lazarus.

First that at all download the file ftp: // ftp.freepascal.org/pub/fpc/dist/docs-2.2.2/doc-html.zip and descompress in the directory $LAZARUS_DIR/docs/offline that before we have created.

To this documentation lacks the relating one to the LCL with what we have several options to obtain it.

Si eres usuario de Linux ( imagino que para MacOS tambien sirve ) puedes ejecutar el script update_lcl_html.sh que se encuentra en $LAZARUS_DIR/docs/html. Al terminar el proceso habra creado el directorio lcl con la documentacion que moveremos a nuestro $LAZARUS_DIR/docs/offline .

Si eres usuario de Windows ( o quieres mantener actualizada tu documentacion HTML ) puedes descargarte el archivo ftp://ftp.freepascal.org/pub/lazarus/fpc-lazarus-doc-html-20080920.tar.bz2 que viene con la documentacion de la RTL, FCL y LCL . Fijarse que se actualiza cada dia, con lo que mañana ya no servira el link asi que tendreis que entrar a mano en ftp://ftp.freepascal.org/pub/lazarus/ y bajaros el fpc-lazarus-doc-html-*.tar.bz2 correspondiente ;)

Bien, en este punto ya tenemos toda la estructura con la documentacion offline en nuestro ordenador, ahora solo falta configurar Lazarus.

Para ello accedemos al menu “Ayuda > Configurar Ayuda”. En la pestaña “General” ponemos en el “FPC Doc HTML Path” el directorio $LAZARUS_DIR/docs/offline y en la pestaña “Base de Datos” , seleccionamos RTLUnits y en BaseURL ponemos el directorio $LAZARUS_DIR/docs/offline/rtl y asi con FCLUnits y LCLUnits con sus directorios correspondientes.

Ahora para comprobar que lo hemos hecho bien vamos al editor de codigo fuente, seleccionamos TForm (por ejemplo) apretamos F1 y voilà , se nos abre la ayuda local en el navegador :)