doc (CHM) snapshot updated 2020-12-30

[marcov]

 Andrey Sobol submitted some fpdoc fixes, which was a trigger to do a beta build of the (chm) docs.  It uses lazarus trunk and fpc 3.2.1 compiled with fpc trunk fpdoc.

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

[dsiders]

Andrey Sobol submitted some fpdoc fixes, which was a trigger to do a beta build of the (chm) docs.  It uses lazarus trunk and fpc 3.2.1 compiled with fpc trunk fpdoc.

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

There is a problem with page footers in lcl.chm and lazutils.chm. It displays the path to the xml file and not its content.
For example:

/fpc/lazarus/docs/html/locallclfooter.xml

[marcov]

That path should be ok I think, that is where the lazarus dir is.

Hmm. I assume that points to fpdoc then.

[dsiders]

That path should be ok I think, that is where the lazarus dir is.

Hmm. I assume that points to fpdoc then.

It worked as expected for fcl.chm and rtl.chm. They don't rely on build_lcl_docs.exe. Just a thought.

[marcov]

But FPC's docs don't use --footer, they only use --footer-date

e.g. the line for rtl:

fpdoc --macro=FPCDIR=/fpc2/fpc --project=rtl-project.xml --format=chm --output=rtl.chm --footer-date="mmm dd yyyy" --auto-toc --auto-index --make-searchable --css-file=/fpc2/fpc/utils/fpdoc/fpdoc.css "--chm-title=(RTL) Runtime Library"
F

[Andrey Sobol]

In such format that works

Code: Pascal  [Select][+][-]

1.    --footer=@G:\_PROJECTS\L02_Tests\tstSimple\footer.xml

@ - is required for read as included file

[dsiders]

In such format that works

Code: Pascal  [Select][+][-]

1.    --footer=@G:\_PROJECTS\L02_Tests\tstSimple\footer.xml

@ - is required for read as included file

If that is true, it is definitely different than previous versions.

[Andrey Sobol]

Inside of fpdoc are existed defaults for different package names. When I did my test builds,  I noticed that they were also not added. I didn`t digging deeper.

[marcov]

Note also that I have been using trunk fpdoc.

[marcov]

The documentation snapshot has been updated with docs generated on 2020-12-30 using FPC fixes and lazarus trunk using fpdoc trunk.

This is mainly to test Andrey Sobol's recent fixes.

 The various CHMs are significantly shorter, but as far as I can see it is mostly there. Maybe some index is systematically smaller.

If you use these CHMs and notice something strange, don't hesitate to report it here.

P.s. the related fpdoc fixes will only be merged back after 3.2.2, since they are interwoven are 300+ revs of fcl-passrc/pas2js revs.

[dsiders]

The documentation snapshot has been updated with docs generated on 2020-12-30 using FPC fixes and lazarus trunk using fpdoc trunk.

This is mainly to test Andrey Sobol's recent fixes.

 The various CHMs are significantly shorter, but as far as I can see it is mostly there. Maybe some index is systematically smaller.

If you use these CHMs and notice something strange, don't hesitate to report it here.

P.s. the related fpdoc fixes will only be merged back after 3.2.2, since they are interwoven are 300+ revs of fcl-passrc/pas2js revs.

Page footers in lcl.chm and lazutils.chm are still broken. It displays the file name instead of its content.

No other issues so far.

[EDIT]
Perhaps the smaller CHM filer size is due to the missing page footers.

[dsiders]

I stand corrected.

The contents tree structure for Classes and Object by Unit is missing files. Several files. The files are listed in the "Reference for package lazutils" page though. And that page contains content that does not belong there. Looks like the description from LazListClasses.xml.

Something is definitely wrong with navigation.

I do not see anything wrong yet with lcl.chm (other than the footers).

[Andrey Sobol]

The contents tree structure for Classes and Object by Unit is missing files. Several files.

The class tree are built from sources now, but a class hep are from fpdoc .xml files, I think need off  inks in the tree class without  a help info. I'l do it late.
Andrey.

[Andrey Sobol]

Have someone a  link from TOC without a content info for example?

[dsiders]

Have someone a  link from TOC without a content info for example?

Are you referring to the missing items in the TOC tree?