Re: [lazarus] Suggestion: Wiki for Error Messages
On 9/7/05, Florian Köberle [EMAIL PROTECTED] wrote: What do you think about using a wiki for explaining what a error messagemeans. These pages are then called when the user press F1 in the errormessage window. This should be done in the Documentation Project rather then the wiki, because the documentation will (in the future) be integrated to the IDE. You can use a program called lazde that comes with lazarus to edit the documentation. Unfortunatly I find this program a bit difficult to use.-- Felipe Monteiro de Carvalho
Re: [lazarus] Suggestion: Wiki for Error Messages
Hi, I´ve just seen that lazde is only for the LCL Documentation. So this seams to be the case of creating a new wiki page.-- Felipe Monteiro de Carvalho
Re: [lazarus] Suggestion: Wiki for Error Messages
Florian Köberle wrote: What do you think about using a wiki for explaining what a error message means. These pages are then called when the user press F1 in the error message window. Flo I think it is a good idea, maybe something like www.php.net when they explain what a function does, in there they but the explanation of the functions and then the users adds some comments about that function, but we'll use it to put the user comments on how to solve the error... Just an Idea Luis _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [lazarus] Suggestion: Wiki for Error Messages
Felipe Monteiro de Carvalho wrote: I´ve just seen that lazde is only for the LCL Documentation. So this seams to be the case of creating a new wiki page. It is not only for the LCL, but it can be used for documenting any pascal program of unit. LazDE (residing in the doceditor subdirectory on SVN) is a nice graphical shell for the fpdoc system. Regards, Bram _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [lazarus] Suggestion: Wiki for Error Messages
Luis Francisco Araya wrote: Florian Köberle wrote: What do you think about using a wiki for explaining what a error message means. These pages are then called when the user press F1 in the error message window. I think it is a good idea, maybe something like www.php.net when they explain what a function does, in there they but the explanation of the functions and then the users adds some comments about that function, but we'll use it to put the user comments on how to solve the error... Currently there is a comment-system available for the online html documentation on the FreePascal site. fpdoc (lazde's backend) does list all classes and thus all exception classes for the units it documents. It does not list all possible error messages, so we'd get one page per exception class instead of one page per exception message. Perhaps we can use the Exception.HelpContext property somewhere here? (if no HelpContext is set, the exception class should be used then to display the corresponding exception class overview page) Regards, Bram _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
Re: [lazarus] Suggestion: Wiki for Error Messages
This should be done in the Documentation Project rather then the wiki, because the documentation will (in the future) be integrated to the IDE. As a matter of fact I'm working on a prototype of an integrated documentation tool in lazarus (to be honest it's just a impudent ripp off from lazde ;). The tools works with the fpdoc files and gets input from the uniteditor regarding the source element it's placed at. A selection (could add more as desired) of documentation structure tags will be shown in a slimed form that you can position somewhere conveniently. It will be possible to change the documentation as you are programming, changes will be committed automatically. If it wasn't for all the other work I had to do, I would be providing a patch already. My current guess is that I will commit it somewhere end of this weekend. Darius _ To unsubscribe: mail [EMAIL PROTECTED] with unsubscribe as the Subject archives at http://www.lazarus.freepascal.org/mailarchives
