Recent

Author Topic: the fpdoc output formats  (Read 1305 times)

Andrey Sobol

  • New Member
  • *
  • Posts: 48
the fpdoc output formats
« on: November 27, 2020, 06:08:03 pm »
Can anyone say more about the used output formats by fpdoc.exe?
What I see now:
- the html has hierarchy problems, but actively used, it's clear.
- chm also.
- xml - produce simple data. It is used?
- dxml - an empty output. It is used?
- txt - the exception, but is simpley corrected.  It is used?
- man - produce simple data. It is used?
- rtf - output is a corrupted file. It is used?
- latex - I think is used but I can`t check it at windows.

Which formats should be tested before a patching?
How are generated the pdf documentation?

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 9439
  • FPC developer.
Re: the fpdoc output formats
« Reply #1 on: November 27, 2020, 06:25:26 pm »
Latex used for pdf, downloadable from site.
html for website.
chm for offline help in IDE(s).

Some of the others are generated out of habit (txt,rtf), but I'm not aware of serious use.

What is the bugreport number for the hierarchy problems?

Andrey Sobol

  • New Member
  • *
  • Posts: 48
Re: the fpdoc output formats
« Reply #2 on: November 27, 2020, 06:51:32 pm »
« Last Edit: November 27, 2020, 08:10:20 pm by Andrey Sobol »

PascalDragon

  • Hero Member
  • *****
  • Posts: 3170
  • Compiler Developer
Re: the fpdoc output formats
« Reply #3 on: November 28, 2020, 11:30:43 am »
Can anyone say more about the used output formats by fpdoc.exe?

You missed the IPF format. It's mainly used for the documentation of fpGUI currently (fpGUI provides the utlity DocView to view them) and the resulting INF files are also supported by FPC's textmode IDE.

Please not that it's hard to say which formats are really used. While the FPC project itself might only really use the HTML, CHM and Latex outputs other third party users might use formats that suite them more (like IPF for fpGUI).

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 9439
  • FPC developer.
Re: the fpdoc output formats
« Reply #4 on: November 28, 2020, 11:44:27 am »
.PS is btw also a format that is generated. Related to PDF, but afaik it was mostly as a base for the printers of the early FPC books.

Andrey Sobol

  • New Member
  • *
  • Posts: 48
Re: the fpdoc output formats
« Reply #5 on: November 29, 2020, 07:04:53 am »
.PS is btw also a format that is generated.
I don`t see btw writer into the fpdoc project.

You missed the IPF format.
I can`t test the .ipf files at a windows. I have tried to use the  wifpc converter, but it produce a converting error at windows (fatal error 10: invalid language code). The DocView don`t open ipf files directly. :(

marcov

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 9439
  • FPC developer.
Re: the fpdoc output formats
« Reply #6 on: November 29, 2020, 12:13:08 pm »
My bad. I meant multiple formats are generated from the latex, not just PDF.

IPF: Graeme was working on a native(=Pascal) compiler, but I haven't heard much about IPF lately.

 

TinyPortal © 2005-2018