[Lazarus] Lazarus trunk help options: CHM Help browser does not show up

Marco van de Voort marcov at stack.nl
Fri Feb 17 17:18:33 CET 2012


On Fri, Feb 17, 2012 at 03:37:49PM +0100, Reinier Olislagers wrote:
> > If you want to create the RTL and FCL docs during installation, you can
> > use according project files. These files are e.g. created by the
> > FPDocManager.
> That's news...must have not been paying attention.
> What are these project files called? Can I get them when installing FPC
> only (i.e. without Lazarus)

In theory

make chm DOCS="rtl fcl" should do it, but it currently hits windows
commandline limits. (see below to get an idea) Dodi is right that the
bulk of the definition of filenames and paths should move out of the
makefile and into a project file. Michael is working on this, but still
WIP.

Prog/ref/user etc stuff require latex and tex4ht. But then it fails (under
windows) on some shell script in the makefile (easily worked around
using cygwin, but not for the unwashed masses). I don't think this will ever
be common round, since tex4ht is funky. 

In short: I would simply download the CHMs, and forget about auto-generation
for now. The sources are not always in a compilable state, and not branch
(trunk vs 2.6.x) and OS independent either


> > In the case of the FPC documentation some paths have to be
> > fixed, so that the other builds can e.g. find the content files. Since
> > the FPC descriptions do not change very often, you can distribute the
> > project files together with your installer.

(IMHO this should not be needed. A system that relies on random hardcoded
paths in a particular setup is flawed)

> > Since you have to download the docs sources in either case, you also can
> > use the supplied MakeFile, of course.
> ... unless I'm overlooking something again, that requires latex to
> export to chm files??
> (eg make chm IIRC)

And tex4ht

> Chances of it being available on Windows, OSX, are not much higher than
> on Linux. Requiring it just to build documentation seems... excessive.

I don't see why.
 
> > Full offline documentation also should include the REF etc. files, which
> > cannot be created like the LCL docs. So it might be easier to download
> > the readily available help files, instead of creating these during the
> > installation.
> .... that's the solution I'm going for right now... ;)

The 2.6.0 CHMs are available from FPC ftp (dist/<release>/docs/doc-chm.zip). So that leaves only the lazarus
LCLs.

There are irregular snapshots on my homepage:

http://www.stack.nl/~marcov/doc-chm.zip

these do contain lcl stuff.

----------------------


D:\repo\fpcdocs>make CHM DOCS="rtl fcl"
make html HTMLFMT=chm
make[1]: Entering directory `D:/repo/fpcdocs'
../fpc/utils/fpdoc/fpdoc  --warn-no-node --package=rtl --descr=rtl.xml
--content=rtl.xct --hide-protected --descr=system.xml --input="-dfpdocsystem
-- -dHASGETHEAP
STATUS -dSUPPORT_DOUBLE ../fpc/rtl/win32/system.pp -Fi../fpc/rtl/win32
-Fi../fpc/rtl/unix -Fi../fpc/rtl/inc -Fi../fpc/rtl/i386 -dCPU32 -dHASVARIANT
- -dFPC_HAS_TY
PE_EXTENDED -dHASWIDECHAR -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
-Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=objpas.xml
- --input="-dHASINTF ../fpc/rtl/objpas/
objpas.pp -Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix
-Fi../fpc/rtl/linux" --descr=types.xml --input="../fpc/rtl/objpas/types.pp
- -Fi../fpc/rtl/win
-Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"
- --descr=strutils.xml --input="../fpc/rtl/objpas/strutils.pp
- -- -Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -
Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=sysutils.xml
--input="../fpc/rtl/unix/sysutils.pp -Fi../fpc/rtl/objpas/sysutils
-- -Fi../fpc/rtl/inc -Fi../fpc/rtl/w
in -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"
--descr=strings.xml --input="../fpc/rtl/inc/strings.pp -Fi../fpc/rtl/i386
-- -Fi../fpc/rtl/inc -Fi..
/fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"
/  --descr=mouse.xml --input="../fpc/rtl/unix/mouse.pp -Fi../fpc/rtl/inc
/  -- -Fi../fpc/rtl/win
 -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"
 - --descr=keyboard.xml --input="../fpc/rtl/unix/keyboard.pp
 - -- -Fi../fpc/rtl/inc -Fi../fpc/rtl/win -Fi..
/fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=crt.xml
/  --input="../fpc/rtl/unix/crt.pp -Fi../fpc/rtl/inc -Fi../fpc/rtl/win
/  -- -Fi../fpc/rtl/win32 -
Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=video.xml
--input="../fpc/rtl/unix/video.pp -Fi../fpc/rtl/inc -Fi../fpc/rtl/win
-- -Fi../fpc/rtl/win32 -Fi../fpc/rtl
/unix -Fi../fpc/rtl/linux" --descr=dos.xml --input="../fpc/rtl/unix/dos.pp
/  -Fi../fpc/rtl/inc -dcpui386 -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
/  - -Fi../fpc/rtl/unix
-Fi../fpc/rtl/linux" --descr=sockets.xml --input="-dver1_0
-  ../fpc/rtl/unix/sockets.pp -Fi../fpc/rtl/inc -Fi../fpc/rtl/win32
- -Fi../fpc/rtl/win -Fi../fpc/rtl/win3
2 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=objects.xml
--input="../fpc/rtl/inc/objects.pp -Fi../fpc/rtl/i386 -Fi../fpc/rtl/win32
-- -Fi../fpc/rtl/win -Fi../
fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=heaptrc.xml
--input="../fpc/rtl/inc/heaptrc.pp -Fi../fpc/rtl/i386 -Fi../fpc/rtl/win32
-- -Fi../fpc/rt
l/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"
--descr=mmx.xml --input="../fpc/rtl/i386/mmx.pp -Fi../fpc/rtl/win32
-- -Fi../fpc/rtl/win -Fi../fp
c/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=ipc.xml
--input="../fpc/rtl/unix/ipc.pp -Fi../fpc/rtl/win32 -Fi../fpc/rtl/win
-- -Fi../fpc/rtl/win32 -F
i../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=printer.xml
--input="../fpc/rtl/unix/printer.pp -Fi../fpc/rtl/win32 -Fi../fpc/rtl/inc
-- -Fi../fpc/rtl/win -Fi../fpc/
rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=typinfo.xml
--input="../fpc/rtl/objpas/typinfo.pp -Fi../fpc/rtl/win32 -Fi../fpc/rtl/win
-- -Fi../fpc/rtl/
win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"  --descr=ports.xml
--input="../fpc/rtl/unix/ports.pp -Fi../fpc/rtl/win32 -Fi../fpc/rtl/win
-- -Fi../fpc/rtl/win32 -Fi
../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=getopts.xml
--input="../fpc/rtl/inc/getopts.pp -Fi../fpc/rtl/win32 -Fi../fpc/rtl/win
-- -Fi../fpc/rtl/win32 -Fi../fpc/
rtl/unix -Fi../fpc/rtl/linux" --descr=emu387.xml
--input="../fpc/rtl/go32v2/emu387.pp -Fi../fpc/rtl/i386 -Fi../fpc/rtl/win
-- -Fi../fpc/rtl/win32 -Fi../fpc/rtl/uni
x -Fi../fpc/rtl/linux" --descr=dxeload.xml
--input="../fpc/rtl/go32v2/dxeload.pp -Fi../fpc/rtl/i386 -Fi../fpc/rtl/win
-- -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi
../fpc/rtl/linux" --descr=go32.xml --input="../fpc/rtl/go32v2/go32.pp
-Fi../fpc/rtl/i386 -Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix
-  -Fi../fpc/rtl/
linux" --descr=gpm.xml --input="-dVER1_0 ../fpc/rtl/linux/gpm.pp
-Fi../fpc/rtl/i386 -Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix
- -Fi../fpc/rtl/linux
" --descr=graph.xml --input="../fpc/packages/graph/src/unix/graph.pp
-Fi../fpc/packages/graph/src/inc -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
- -Fi../fpc/rtl/unix -
Fi../fpc/rtl/linux" --descr=oldlinux.xml
--input="../fpc/rtl/linux/oldlinux.pp -Fi../fpc/rtl/linux -Fi../fpc/rtl/unix
-- -Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi.
./fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=unixtype.xml
--input="../fpc/rtl/unix/unixtype.pp -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux
-- -Fi../fpc/rtl/linux/i386 -F
i../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"
--descr=baseunix.xml --input="../fpc/rtl/unix/baseunix.pp -Fi../fpc/rtl/unix
-- -Fi../f
pc/rtl/linux -Fi../fpc/rtl/linux/i386 -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
-Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=unix.xml
- --input="../fpc/rtl/unix/u
nix.pp -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux -Fi../fpc/rtl/linux/i386
-Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix
- -Fi../fpc/rtl/linux" --descr=cla
sses.xml --input="../fpc/rtl/win32/classes.pp -Fi../fpc/rtl/objpas/classes
-Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux
- -dfpdocs
ystem" --descr=unixutil.xml --input="../fpc/rtl/unix/unixutil.pp
-Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix
- -Fi../fpc/rtl/linux" --descr=x86.xml -
-input="../fpc/rtl/unix/x86.pp -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
- -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=dynlibs.xml
- - --input="../fpc/rtl/inc/dynlibs
.pas -Fi../fpc/rtl/unix -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
-Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=linux.xml
- --input="../fpc/rtl/linux/linux.pp -Fi..
/fpc/rtl/linux -Fi../fpc/rtl/unix -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
/ -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=math.xml
/ - --input="../fpc/rtl/objpas/math
.pp -Fi../fpc/rtl/i386 -dFPC_HAS_TYPE_EXTENDED -Fi../fpc/rtl/win
-Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"
- --descr=matrix.xml --input="../fpc/
rtl/inc/matrix.pp -Fi../fpc/rtl/inc -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
-Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"  --descr=dateutils.xml
- --input="../fpc/rtl/obj
pas/dateutils.pp -Fi../fpc/rtl/objpas -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
-Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=wincrt.xml
- --input="../fpc/packages/
graph/src/win32/wincrt.pp" --descr=clocale.xml
--input="../fpc/rtl/unix/clocale.pp -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
-- -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"
 --descr=cthreads.xml --input="../fpc/rtl/unix/cthreads.pp -Fi../fpc/rtl/win
 -- -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux"
 -- - --descr=cmem.xml --inpu
t="../fpc/rtl/inc/cmem.pp -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
-Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=cwstring.xml
-  --input="../fpc/rtl/unix/cwstring.p
p -Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix
-Fi../fpc/rtl/linux" --descr=exeinfo.xml --input="../fpc/rtl/inc/exeinfo.pp
- -Fi../fpc/rtl/win -Fi../f
pc/rtl/win32 -Fi../fpc/rtl/unix -Fi../fpc/rtl/linux" --descr=lineinfo.xml
--input="../fpc/rtl/inc/lineinfo.pp -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
-- -Fi../fpc/rt
l/unix -Fi../fpc/rtl/linux" --descr=lnfodwrf.xml
--input="../fpc/rtl/inc/lnfodwrf.pp -Fi../fpc/rtl/win -Fi../fpc/rtl/win32
-- -Fi../fpc/rtl/unix -Fi../fpc/rtl/linu
x" --descr=ctypes.xml --input="../fpc/rtl/inc/ctypes.pp -Fi../fpc/rtl/unix
-Fi../fpc/rtl/win -Fi../fpc/rtl/win32 -Fi../fpc/rtl/unix
- -Fi../fpc/rtl/linux" --forma
t=chm --output=rtl.chm --footer-date="mmm dd yyyy" --auto-toc --auto-index
--make-searchable
'..' is not recognized as an internal or external command,
operable program or batch file.
make[1]: *** [rtl.chk] Error 1
make[1]: Leaving directory `D:/repo/fpcdocs'
make: *** [CHM] Error 2

D:\repo\fpcdocs>




More information about the Lazarus mailing list