Re: [fpc-pascal] Re: FCL-DB/SQLDB docs started
The list of possible nodes is found, of course, in the FPDoc manual. Some examples of fairly densely populated descriptions are in StdCtrls, DBCtrls, Dialogs, and also in Controls, Graphics, and Forms. In general the TCustom components are the most fully described. StdCtrls, DBCtrls, Menus have got large Topic sections with extensive seealso references. (A Topic is not, of course, seen by LazDoc, nor is there a mechanism for creating one - there is such a mechanism in LazDE). I have submitted a new bug report. Regards - Chris Mattias Gärtner wrote: For examples see the first few entries in the public/published section for TComboBox and TCustomComboBox in stdctrls. Thanks. I was searching for some good examples. Where can I find a list of all possible nodes that lazde/ladoc creates? Or can you give me some examples, where I can see all flavors? To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [fpc-pascal] Re: FCL-DB/SQLDB docs started
Hi Mattias - I note from the bug report 0010686 that you have fixed the immediate problem, and on re-building Lazarus from SVN this morning I find that I can now save short descriptions from LazDoc in the IDE, and also things that I type in other boxes such as description. However the LazDoc Description panel does not show text that pre-exists in the XML file, and we run the risk of overtyping anything that may already be there by using LazDoc, as entries made using LazDoc do get saved; similarly, it fails to display the existing contents of seealso fields in the XML file. As noted before, LazDoc doesn't display formatted text (such as underline, italic or bold, marked by iword/i), and I find that if I try to copy inherited short titles I don't copy the italic etc words. For examples see the first few entries in the public/published section for TComboBox and TCustomComboBox in stdctrls. Should I raise a new Bug report, or add this to the existing one? Regards - Chris Mattias Gaertner wrote: On Wed, 23 Jan 2008 16:33:23 + Chris Kirkpatrick [EMAIL PROTECTED] wrote: Hi Mattias - I have looked at LazDoc in the IDE. It is very nice in principle, and allows us to copy inherited properties, for example. However, I cannot save any changes that I make with LazDoc in the IDE. If I make a change and press SAVE, then go to another property, when I come back to the property I just changed, there is nothing left! If I exit from the project, saving changes, none of my changes made with PazDoc are saved. I can still edit the XML file using LazDe as a separate application, and the changes are saved OK. I have submitted a bug report for the IDE LazDoc. Thanks. I will take a look. Mattias _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [fpc-pascal] Re: FCL-DB/SQLDB docs started
Zitat von Chris Kirkpatrick [EMAIL PROTECTED]: Hi Mattias - I note from the bug report 0010686 that you have fixed the immediate problem, and on re-building Lazarus from SVN this morning I find that I can now save short descriptions from LazDoc in the IDE, and also things that I type in other boxes such as description. :) bug #1 fixed However the LazDoc Description panel does not show text that pre-exists in the XML file, and we run the risk of overtyping anything that may already be there by using LazDoc, as entries made using LazDoc do get saved; similarly, it fails to display the existing contents of seealso fields in the XML file. bug #2 As noted before, LazDoc doesn't display formatted text (such as underline, italic or bold, marked by iword/i), bug #3 and I find that if I try to copy inherited short titles I don't copy the italic etc words. Probably bug #4 For examples see the first few entries in the public/published section for TComboBox and TCustomComboBox in stdctrls. Thanks. I was searching for some good examples. Where can I find a list of all possible nodes that lazde/ladoc creates? Or can you give me some examples, where I can see all flavors? Should I raise a new Bug report, or add this to the existing one? Please create a new one (or more if you like). Mattias _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [fpc-pascal] Re: FCL-DB/SQLDB docs started
Hi John, Joost and Adrian - As you might know, I have been trying to get the documentation for parts of the Lazarus Component Library (LCL) into shape, mainly by putting information into the .XML files associated with each Unit, to enable generation of .HTML files using FPDoc. Quite a few elements in the LCL are now documented to the stage that useful information appears as on-line hints when using the Lazarus IDE. I have started trying to describe some of the Data-Aware components (see the DataAccess and Data Control tabs in the Component Palette) but am having to delve deeply into the SQLDb and Db files in the FCL in order to get information to describe the use of these components. So I should very much like to collaborate with you guys in improving the documentation of sqldb and fc-db, as well as the stuff in the LCL. I agree we should try to use the FPDoc approach as suggested by Joost. I have been given commit access to the /docs/xml/lcl/ directory in the lazarus SVN tree. At present the SQLDb and fcl-db documentation files would not appear in that pathway, and we would need to find some way of sharing our work on the files - perhaps we need to find a branch of SVN to which some or all of us gain access. I am copying this communication to the lazarus developers list, as they are the guys with write-access to the appropriate SVN repositories, and may be able to offer suggestions on how best to proceed. I am also copying it to the main lazarus mailing list, in the hope that more volunteers may emerge! Please keep in touch and keep the impetus going. Regards - Chris John wrote: Adrian Maier wrote: Are there any people still interested in making it possible to have some real docs for sqldb and fcl-db ? If so, let's organize ourselves and see what needs to be done . I am very interested in the subject but I can't do it myself alone : if I knew enough about sqldb I wouldn't be so unhappy about the lack of documentation . Hi Adrian, I am also. cheers, John Sunderland ___ fpc-pascal maillist - [EMAIL PROTECTED] http://lists.freepascal.org/mailman/listinfo/fpc-pascal _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [fpc-pascal] Re: FCL-DB/SQLDB docs started
Chris Kirkpatrick wrote: Hi John, Joost and Adrian - snip So I should very much like to collaborate with you guys in improving the documentation of sqldb and fc-db, as well as the stuff in the LCL. I agree we should try to use the FPDoc approach as suggested by Joost. snip _ I agree with FPDoc in principle, but I haven't been able to get any sort of handle on how it works. And I HAVE downloaded the documentation for it and tried to read it. It was a while ago, but my memory is that, like most IT documentation, it assumes you know basically what you are trying to do, and just need to be reminded of the details. I am also confused about the difference/connection between fpdoc, lazdoc and lazde (have I even got the names right ? I think there have been others mentioned as well on this list). I'll try to have another read. :-) cheers, John Sunderland _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [fpc-pascal] Re: FCL-DB/SQLDB docs started
Zitat von John [EMAIL PROTECTED]: Chris Kirkpatrick wrote: Hi John, Joost and Adrian - snip So I should very much like to collaborate with you guys in improving the documentation of sqldb and fc-db, as well as the stuff in the LCL. I agree we should try to use the FPDoc approach as suggested by Joost. snip _ I agree with FPDoc in principle, but I haven't been able to get any sort of handle on how it works. And I HAVE downloaded the documentation for it and tried to read it. It was a while ago, but my memory is that, like most IT documentation, it assumes you know basically what you are trying to do, and just need to be reminded of the details. I am also confused about the difference/connection between fpdoc, lazdoc and lazde (have I even got the names right ? I think there have been others mentioned as well on this list). lazdoc and lazde are now the same (since two weeks). fpdoc is a command line utility. lazdoc/lazde is a graphical editor for fpdoc files. I'll try to have another read. :-) Mattias _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [fpc-pascal] Re: FCL-DB/SQLDB docs started
Explanation of some Lazarus documentation terms: FPDoc - the command-line tool that is part of FPC and is documented in the FPC manuals. Includes MakeSkel, for constructing a skeleton XML file from the unit source code. LazDE, aka Lazarus Documentation Editor - an application found in /lazarus/docedit/lazde.lpi which you have to compile and use to edit XML files built using MakeSkel; this is probably the most useful app for doing the documentation, but takes a bit of getting used to. LazDoc - part of the Lazarus IDE,; if you open a LazDoc window, you should (if you have specified the correct paths etc) be able to edit documentation XML files in parallel with the .pp or .pas source files. I'm afraid I've never got it to work satisfactorily. However, it now has a new feature (you don't even have to open a window or anything) whereby a hinting pop-up appears if you hover over a keyword etc in your source file in the source editor - it searches the source file and the XML file to find information about the keyword and displays it (usually the short description of the entity). It is very clever, but needs quite a lot of tweaking (acknowledged by the developers) to correct it and make it fully functional. I use it a lot to check on-line if the changes I have made with LazDE produce sensible results. There is also the option, of course, of hitting F1 for Help while highlighting a keyword, in which case you get taken to the appropriate SourceForge HTML file, which unfortunately can be several days out of date. Hope this helps. Regards - Chris John wrote: Chris Kirkpatrick wrote: Hi John, Joost and Adrian - snip So I should very much like to collaborate with you guys in improving the documentation of sqldb and fc-db, as well as the stuff in the LCL. I agree we should try to use the FPDoc approach as suggested by Joost. snip _ I agree with FPDoc in principle, but I haven't been able to get any sort of handle on how it works. And I HAVE downloaded the documentation for it and tried to read it. It was a while ago, but my memory is that, like most IT documentation, it assumes you know basically what you are trying to do, and just need to be reminded of the details. I am also confused about the difference/connection between fpdoc, lazdoc and lazde (have I even got the names right ? I think there have been others mentioned as well on this list). I'll try to have another read. :-) cheers, John Sunderland _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [fpc-pascal] Re: FCL-DB/SQLDB docs started
Hi Mattias - I have looked at LazDoc in the IDE. It is very nice in principle, and allows us to copy inherited properties, for example. However, I cannot save any changes that I make with LazDoc in the IDE. If I make a change and press SAVE, then go to another property, when I come back to the property I just changed, there is nothing left! If I exit from the project, saving changes, none of my changes made with PazDoc are saved. I can still edit the XML file using LazDe as a separate application, and the changes are saved OK. I have submitted a bug report for the IDE LazDoc. Regards - Chris Mattias Gärtner wrote: lazdoc and lazde are now the same (since two weeks). fpdoc is a command line utility. lazdoc/lazde is a graphical editor for fpdoc files. Mattias _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
