Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Mailing lists / lazarus / 2008-09

How to install local copy of RTL/FCL/LCL documentation (from CCR)?

7 messages · 5 people ·

Reply by email Subscribe to this list Your subscription

Read-only archive. Use j and k to move between messages.

Graeme Geldenhuys
to Tom Verhoeff
Tom Verhoeff wrote 6 lines
How can one install a local copy of the documentation for RTL/FCL/LCL in a form that is now on-line available at <http://lazarus-ccr.sourceforge.net/docs/> How up to date is that documentation?

You can get the latest RTL and FCL documentation from the following SubVersion repository:
http://svn.freepascal.org/svn/fpcdocs/trunk

The LCL documentation (*.xml files) are included with Lazarus in the SubVersion repository:
http://svn.freepascal.org/svn/lazarus/trunk

Lazarus can be setup to read the LCL and RTL docs directly from the XML files as tooltip help.

You can also generate your own HTML documentation using fpdoc.

Pre-generated HTML, PDF etc documentation can also be downloaded from: http://www.freepascal.org/down/docs/docs.var

If you downloaded or generated the HTML documentation, you can tell Lazarus IDE where to find the docs, instead of going onto the internet: "Help | Configure Help"

Regards,
- Graeme -

_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/

Reply by email

Graeme Geldenhuys
to Reenen Laurie: Please tell us more! I'd love to know how we can do this. Any wiki page that exists on…
Reenen Laurie wrote 5 lines
> Lazarus can be setup to read the LCL and RTL docs directly from the > XML files as tooltip help. Please tell us more! I'd love to know how we can do this. Any wiki page that exists on how to do this?

:-) This has been is v0.9.25 (svn trunk) for some time now. Lazarus automatically finds the LCL documentation. I think it does for RTL as well (Mattias?).

For external packages (*.lpk) like tiopf.lpk or fpgui_toolkit.lpk you do the following:
* Open the xxx.lpk package
* Click "Options | IDE Integration" and then fill in the path(s) to the *.xml docs in the "FPDoc file paths" edit box.

Now if you hover the mouse over something like TfpgWindow (a window class, part of fpGUI Toolkit), a tooltip will appear containing the help defined in the *.xml files. :-) An awesome feature in Lazarus!!

Regards,
- Graeme -

_______________________________________________
fpGUI - a cross-platform Free Pascal GUI toolkit
http://opensoft.homeip.net/fpgui/

Reply by email

Vincent Snijders
to Graeme Geldenhuys: You can get the latest RTL and FCL documentation from the following SubVersion repository:
Graeme Geldenhuys wrote 10 lines
On 9/16/08, Tom Verhoeff wrote: > How can one install a local copy of the documentation for RTL/FCL/LCL > in a form that is now on-line available at > > <http://lazarus-ccr.sourceforge.net/docs/> > > How up to date is that documentation? Pre-generated HTML, PDF etc documentation can also be downloaded from: http://www.freepascal.org/down/docs/docs.var

latest 'release':
https://sourceforge.net/project/showfiles.php?group_id=92177&package_id=138755&release_id=559542

snapshot:
ftp://ftp.hu.freepascal.org/pub/lazarus/fpc-lazarus-doc-html-20080902.tar.bz2

Vincenet

Reply by email

Chris Kirkpatrick
to Graeme Geldenhuys: :-) This has been is v0.9.25 (svn trunk) for some time now. Lazarus automatically finds…

You can get a (nearly!) nightly build of all the html docs at ftp://ftp.hu.freepascal.org/pub/lazarus/

There will be a file called
fpc-lazarus-doc-html-20080902.tar.bz2
(It's actually a couple of weeks since it was last updated - the numbers obviously give the date, but when all is working correctly it happens almost nightly).

Regards - Chris

Graeme Geldenhuys wrote 37 lines
On Tue, Sep 16, 2008 at 3:54 PM, Reenen Laurie wrote: >> Lazarus can be setup to read the LCL and RTL docs directly from the >> XML files as tooltip help. >> > Please tell us more! I'd love to know how we can do this. Any wiki > page that exists on how to do this? > :-) This has been is v0.9.25 (svn trunk) for some time now. Lazarus automatically finds the LCL documentation. I think it does for RTL as well (Mattias?). For external packages (*.lpk) like tiopf.lpk or fpgui_toolkit.lpk you do the following: * Open the xxx.lpk package * Click "Options | IDE Integration" and then fill in the path(s) to the *.xml docs in the "FPDoc file paths" edit box. Now if you hover the mouse over something like TfpgWindow (a window class, part of fpGUI Toolkit), a tooltip will appear containing the help defined in the *.xml files. :-) An awesome feature in Lazarus!! Regards, - Graeme - _______________________________________________ fpGUI - a cross-platform Free Pascal GUI toolkit http://opensoft.homeip.net/fpgui/ _______________________________________________ Lazarus mailing list http://www.lazarus.freepascal.org/mailman/listinfo/lazarus

Reply by email