Difference between revisions of "Lazarus Offline Documentation"

From Lazarus wiki
Jump to navigationJump to search
(New page: 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. Firs...)
 
Line 5: Line 5:
 
To this documentation lacks the relating one to the LCL with what we have several options to obtain it.
 
To this documentation lacks the relating one to the LCL with what we have several options to obtain it.
  
 +
If you are a Linux user (I imagine that for MacOS also it serves) you can execute the script '''update_lcl_html.sh''' that is in $LAZARUS_DIR/docs/html. When the process finishes have created the directory '''lcl''' with the documentation that we will move to $LAZARUS_DIR/docs/offline.
  
 +
If you are a Windows user (or you want to keep your HTML documentation updated) you can download the file ftp: // ftp.freepascal.org/pub/lazarus/fpc-lazarus-doc-html-20080920.tar.bz2 that comes with the documentation of the RTL, FCL and LCL. Look that it is updated every day, with what tomorrow already the link will not serve and you must enter by hand ftp: // ftp.freepascal.org/pub/lazarus/ and download correspondent fpc-lazarus-doc-html-*.tar.bz2 ;)
  
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 .
+
Well, in this point already we have the whole structure with the documentation offline in our computer, now only Lazarus is necessary to configure.
 
 
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.
 
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 :)
 
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 :)

Revision as of 14:35, 23 September 2008

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.

If you are a Linux user (I imagine that for MacOS also it serves) you can execute the script update_lcl_html.sh that is in $LAZARUS_DIR/docs/html. When the process finishes have created the directory lcl with the documentation that we will move to $LAZARUS_DIR/docs/offline.

If you are a Windows user (or you want to keep your HTML documentation updated) you can download the file ftp: // ftp.freepascal.org/pub/lazarus/fpc-lazarus-doc-html-20080920.tar.bz2 that comes with the documentation of the RTL, FCL and LCL. Look that it is updated every day, with what tomorrow already the link will not serve and you must enter by hand ftp: // ftp.freepascal.org/pub/lazarus/ and download correspondent fpc-lazarus-doc-html-*.tar.bz2 ;)

Well, in this point already we have the whole structure with the documentation offline in our computer, now only Lazarus is necessary to configure.

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 :)