Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On Wed, 8 Feb 2012, Reinier Olislagers wrote: fpdocs Revision 889 svn revert --recursive . Open FPDocEditor on ExpandFileName, type a space somewhere, click Save icon. (Space seems to be automatically removed) This gives a 605 kb diff file; uploaded to https://bitbucket.org/reiniero/fpc_laz_patch_playground/downloads/FPCDocs_r889_StartingFPDocEditor.diff To my untrained (and probably tired ;) eye), it seems that the file had been formatted in a certain way and fpde forces its own format on the file Correct. I use a plain text editor to edit the documentation. It still works faster than any tool I've seen. Michael. ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On Wed, 8 Feb 2012 09:26:10 +0100 (CET) michael.vancann...@wisa.be wrote: On Wed, 8 Feb 2012, Reinier Olislagers wrote: fpdocs Revision 889 svn revert --recursive . Open FPDocEditor on ExpandFileName, type a space somewhere, click Save icon. (Space seems to be automatically removed) This gives a 605 kb diff file; uploaded to https://bitbucket.org/reiniero/fpc_laz_patch_playground/downloads/FPCDocs_r889_StartingFPDocEditor.diff To my untrained (and probably tired ;) eye), it seems that the file had been formatted in a certain way and fpde forces its own format on the file Correct. I use a plain text editor to edit the documentation. It still works faster than any tool I've seen. Yes, but without any indentation it is hard to read. Mattias ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On Wed, 8 Feb 2012, Mattias Gaertner wrote: On Wed, 8 Feb 2012 09:26:10 +0100 (CET) michael.vancann...@wisa.be wrote: On Wed, 8 Feb 2012, Reinier Olislagers wrote: fpdocs Revision 889 svn revert --recursive . Open FPDocEditor on ExpandFileName, type a space somewhere, click Save icon. (Space seems to be automatically removed) This gives a 605 kb diff file; uploaded to https://bitbucket.org/reiniero/fpc_laz_patch_playground/downloads/FPCDocs_r889_StartingFPDocEditor.diff To my untrained (and probably tired ;) eye), it seems that the file had been formatted in a certain way and fpde forces its own format on the file Correct. I use a plain text editor to edit the documentation. It still works faster than any tool I've seen. Yes, but without any indentation it is hard to read. Allow me to disagree... It's much easier to read than the XML which the FPDoc editors produce :-) Michael. ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On 8 February 2012 10:44, Mattias Gaertner wrote: Yes, but without any indentation it is hard to read. Indentation (whitespace), which is purely for human enjoyment, causes problems in some of the fpdoc output formats that don't ignore such whitespace in the final output. TXT, IPF, RTF etc are some of them affected. -- Regards, - Graeme - ___ fpGUI - a cross-platform Free Pascal GUI toolkit http://fpgui.sourceforge.net ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On 8 February 2012 11:15, michael.vancanneyt@ wrote: Yes, but without any indentation it is hard to read. Allow me to disagree... +1 I edit my documentation using the source code editor of my IDE. I get syntax highlighting for free, and I make extensive use of code templates to reduce a LOT of typing (yeah XML is damn verbose). -- Regards, - Graeme - ___ fpGUI - a cross-platform Free Pascal GUI toolkit http://fpgui.sourceforge.net ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On 8-2-2012 10:15, michael.vancann...@wisa.be wrote: On Wed, 8 Feb 2012, Mattias Gaertner wrote: On Wed, 8 Feb 2012 09:26:10 +0100 (CET) michael.vancann...@wisa.be wrote: On Wed, 8 Feb 2012, Reinier Olislagers wrote: To my untrained (and probably tired ;) eye), it seems that the file had been formatted in a certain way and fpde forces its own format on the file Correct. I use a plain text editor to edit the documentation. It still works faster than any tool I've seen. Yes, but without any indentation it is hard to read. Allow me to disagree... It's much easier to read than the XML which the FPDoc editors produce :-) I was going to respond with a remark about the lack of usability of FPDoc and LazDE but I'll sleep on it - I think I've not been thinking straight lately. In any case, thanks a lot to you both for your efforts with FPC Lazarus... Regards, Reinier ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On Wed, 8 Feb 2012 11:43:19 +0200 Graeme Geldenhuys graemeg.li...@gmail.com wrote: On 8 February 2012 10:44, Mattias Gaertner wrote: Yes, but without any indentation it is hard to read. Indentation (whitespace), which is purely for human enjoyment, causes problems in some of the fpdoc output formats that don't ignore such whitespace in the final output. TXT, IPF, RTF etc are some of them affected. fpdoc uses xml and in most xml formats anything between two tags that consists only of space characters is ignored. That's why normally the indentation is only for readability and can be changed without altering the xml. As far as I know fpdoc does the same. If not, then this is uncommon and should get a prominent hint in the docs. If fpdoc uses the usual xml rules than the output backends must do the same. Of course it would be nicer if the used xml readers/writers can be told to keep the spaces. Especially for version control systems. I will take a look. Mattias ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On 8 February 2012 17:03, Mattias Gaertner wrote: fpdoc uses xml and in most xml formats anything between two tags that consists only of space characters is ignored. Yes, there is no technical problems with indenting XML tags. But read further... altering the xml. As far as I know fpdoc does the same. FPDoc Editor indents help text / content too, thus adding whitespace into the help itself. This white spaces might be ignore by fpdoc's Latex and HTML output (eg: a web browser viewing the generated HTML), but such whitespace is not ignored by IPF, TXT, RTF etc output writers and there associated viewers. I can't remember if I filed any bug report on this, but I do know I raised the issue with Michael at one point. That's when he told me the problem lies with FPDoc Editor, and not fpdoc. Since then I edit the XML via my source code editor. I'll search my email history to find you that example. -- Regards, - Graeme - ___ fpGUI - a cross-platform Free Pascal GUI toolkit http://fpgui.sourceforge.net ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On Wed, 8 Feb 2012 16:03:05 +0100 Mattias Gaertner nc-gaert...@netcologne.de wrote: [...] Of course it would be nicer if the used xml readers/writers can be told to keep the spaces. Especially for version control systems. I will take a look. The xml reader/writer used by the fpdoc editor now preserve the attribute order and have options to preserve white spacing. This means the fpdoc editor now only changes the edited element and keeps the rest. There are still some whitespace issues about the edited element. Mattias ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
Re: [fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
On 2/8/2012 18:56, Mattias Gaertner wrote: On Wed, 8 Feb 2012 16:03:05 +0100 Mattias Gaertnernc-gaert...@netcologne.de wrote: [...] Of course it would be nicer if the used xml readers/writers can be told to keep the spaces. Especially for version control systems. I will take a look. The xml reader/writer used by the fpdoc editor now preserve the attribute order and have options to preserve white spacing. This means the fpdoc editor now only changes the edited element and keeps the rest. excellent! :) There are still some whitespace issues about the edited element. there's always something to do, eh? ;) ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
[fpc-pascal] FPCDocs: diff: saving fpdoc gives huge diff
fpdocs Revision 889 svn revert --recursive . Open FPDocEditor on ExpandFileName, type a space somewhere, click Save icon. (Space seems to be automatically removed) This gives a 605 kb diff file; uploaded to https://bitbucket.org/reiniero/fpc_laz_patch_playground/downloads/FPCDocs_r889_StartingFPDocEditor.diff To my untrained (and probably tired ;) eye), it seems that the file had been formatted in a certain way and fpde forces its own format on the file Regards, Reinier ___ fpc-pascal maillist - fpc-pascal@lists.freepascal.org http://lists.freepascal.org/mailman/listinfo/fpc-pascal
