[fpc-devel] FPDoc projects future

2011-11-29 Thread Hans-Peter Diettrich
In my review of the fpdoc project option some questions popped up. The most important question: should fpdoc be usable for creating online help only, or should it also allow users to create offline documentation on their local machine? When a user can create documentation files for local use, t

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread Marco van de Voort
In our previous episode, Hans-Peter Diettrich said: > In my review of the fpdoc project option some questions popped up. The > most important question: should fpdoc be usable for creating online help > only, or should it also allow users to create offline documentation on > their local machine?

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread michael . vancanneyt
On Wed, 30 Nov 2011, Hans-Peter Diettrich wrote: In my review of the fpdoc project option some questions popped up. The most important question: should fpdoc be usable for creating online help only, or should it also allow users to create offline documentation on their local machine? When a

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread Marco van de Voort
In our previous episode, michael.vancann...@wisa.be said: > > will reside in an unrelated directory branch, so that all references to the > > FPC documentation depend on the directory structure of the user machines. > > Explain why you think this requires a fixed directory structure ? In plain h

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread michael . vancanneyt
On Wed, 30 Nov 2011, Marco van de Voort wrote: In our previous episode, michael.vancann...@wisa.be said: will reside in an unrelated directory branch, so that all references to the FPC documentation depend on the directory structure of the user machines. Explain why you think this requires

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread Marco van de Voort
In our previous episode, michael.vancann...@wisa.be said: > > (so rtl/xxx/yy.html referencing fcl/zzz/ooo.html is done by generating a > > link to ../../fcl/zzz/ooo.html ) > > > > But this is an html format problem, not a fpdoc problem. > > I thought the cross-references are done based on the loc

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread Graeme Geldenhuys
On 30 November 2011 01:33, Hans-Peter Diettrich wrote: > In my review of the fpdoc project option some questions popped up. The most > important question: should fpdoc be usable for creating online help only, or > should it also allow users to create offline documentation on their local > machine?

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread Graeme Geldenhuys
On 30 November 2011 10:11, Marco van de Voort wrote: > I don't see plain html as a valid target for offline help. I reserve that > for CHM.  With the textmode IDE, the plain html was nothing but pain. Indeed. HTML lacks a TOC, Index, searching etc. Plus it is verbose and HUGE in terms of disk spac

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread Hans-Peter Diettrich
michael.vancann...@wisa.be schrieb: It seems to me you are reading too much in fpdoc. fpdoc takes some input files and produces output. No more, no less. All the questions you ask have more to do with 'how do I organize my work with fpdoc' rather than with 'how should fpdoc function'. You sh

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread Hans-Peter Diettrich
michael.vancann...@wisa.be schrieb: (so rtl/xxx/yy.html referencing fcl/zzz/ooo.html is done by generating a link to ../../fcl/zzz/ooo.html ) But this is an html format problem, not a fpdoc problem. I thought the cross-references are done based on the location of the cxt file, and all links

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread michael . vancanneyt
On Wed, 30 Nov 2011, Hans-Peter Diettrich wrote: michael.vancann...@wisa.be schrieb: It seems to me you are reading too much in fpdoc. fpdoc takes some input files and produces output. No more, no less. All the questions you ask have more to do with 'how do I organize my work with fpdoc' r

Re: [fpc-devel] FPDoc projects future

2011-11-30 Thread Hans-Peter Diettrich
michael.vancann...@wisa.be schrieb: You should understand the problems of Windows users. Until now they cannot produce local documentation, due to several bugs in the Makefiles, fpdoc and related tools. This is a bad situation for documentation writers, which cannot test their work thoroughly.

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread michael . vancanneyt
On Wed, 30 Nov 2011, Hans-Peter Diettrich wrote: michael.vancann...@wisa.be schrieb: You should understand the problems of Windows users. Until now they cannot produce local documentation, due to several bugs in the Makefiles, fpdoc and related tools. This is a bad situation for documentati

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread Graeme Geldenhuys
On 30 November 2011 22:14, Hans-Peter Diettrich wrote: > Now you hear some, most probably from the first user of fpdoc on Windows ;-) I use fpdoc under Windows without problems. Though mostly for generating documentation for my own projects, not FPC ones. I also use a console utility program with

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread michael . vancanneyt
On Thu, 1 Dec 2011, Graeme Geldenhuys wrote: On 30 November 2011 22:14, Hans-Peter Diettrich wrote: Now you hear some, most probably from the first user of fpdoc on Windows ;-) I use fpdoc under Windows without problems. Though mostly for generating documentation for my own projects, not F

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread Felipe Monteiro de Carvalho
On Wed, Nov 30, 2011 at 9:14 PM, Hans-Peter Diettrich wrote: > Now you hear some, most probably from the first user of fpdoc on Windows ;-) If you were, then this file would not exist: http://svn.freepascal.org/cgi-bin/viewvc.cgi/trunk/docs/html/build_html.bat?root=lazarus&view=log I have built

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread Michael Schnell
On 11/30/2011 12:33 AM, Hans-Peter Diettrich wrote: Should we introduce a single (HTML) documentation directory, on every target machine, where *all* package documentations can reside side-by-side, with fixed relative references? Or should HTML documentation be deprecated, in favor of more po

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread Hans-Peter Diettrich
Felipe Monteiro de Carvalho schrieb: On Wed, Nov 30, 2011 at 9:14 PM, Hans-Peter Diettrich wrote: Now you hear some, most probably from the first user of fpdoc on Windows ;-) If you were, then this file would not exist: Examples which *happen* to work are not a proof for the absence of bugs

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread Michael Schnell
On 11/30/2011 01:18 PM, Graeme Geldenhuys wrote: I'm also working on a new ePub output format - specialized for tablet usage. Never heard of same. Is this supposed to replace *.inf ? -Michael ___ fpc-devel maillist - fpc-devel@lists.freepascal.org

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread Graeme Geldenhuys
On 1 December 2011 13:45, Michael Schnell wrote: > > Never heard of same. Is this supposed to replace *.inf ? No, ePub is a specialised HTML/XHTML archive format. A single file used for electronic books. It is most often used on tablet pc's, smart phones and e-Book readers like Amazon Kindle.

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread Marco van de Voort
In our previous episode, Graeme Geldenhuys said: > My main problem at the moment is again the Latex format. Manipulate the generated HTML? > It is very hard to convert LaTex to any other format (and still look > good). This was the main reason I wanted to implement ePub support. But > maybe a b

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread Graeme Geldenhuys
On 1 December 2011 15:37, Marco van de Voort wrote: > In our previous episode, Graeme Geldenhuys said: >> My main problem at the moment is again the Latex format. > > Manipulate the generated HTML? Yes, I was thinking in that same direction. >> maybe a better idea is to improve the LaTex-to-PDF

Re: [fpc-devel] FPDoc projects future

2011-12-01 Thread Michael Schnell
On 12/01/2011 04:16 PM, Graeme Geldenhuys wrote: Yes, I was thinking in that same direction. My son some time ago wrote a HTML parser / Writer that creates a linked List of objects (similar to the XML parser) . Maybe this could be helpful. -Michael

Re: [fpc-devel] FPDoc projects future

2011-12-02 Thread Graeme Geldenhuys
On 1 December 2011 13:44, Michael Schnell wrote: > I (tried to) use DocView (*.inf files) for local help. Seems very > promising. I've just released fpGUI v0.8. With that release comes pre-built binaries for DocView, and pre-built documentation in INF format. You can download them from the follo