Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Hans-Peter Diettrich
waldo kitty schrieb: question) what about the possibility of "local" notes... notes that are only stored on the local machine? You can do with the downloaded doc sources whatever you like. so, basically, i'm working on the documentation and write a "local" note that only belongs on my machi

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Hans-Peter Diettrich
Graeme Geldenhuys schrieb: No offence, but Michael is trying to be accommodating here. Appreciated :-) But with every since code change he makes, you seem to find more and more "problems" (those are debatable). What problems? I only tried to give some *possible* use cases for an intended

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Michael Schnell
On 02/14/2012 10:42 AM, Graeme Geldenhuys wrote: I don't really see this as a problem. After all, you need to download the INF or CHM or HTML or PDF offline help anyway. The "distribution" (version 1.0) might include those. Not many people want to go the "build your own docs" route. But pl

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Michael Schnell
On 02/14/2012 10:44 AM, Graeme Geldenhuys wrote: That is already on my docview todo list, and should be one of the next things I implement (in a week or two). Sounds Great ! Looking forward to testing this. -Michael -- ___ Lazarus mailing list Lazar

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Felipe Monteiro de Carvalho
On Tue, Feb 14, 2012 at 10:42 AM, Graeme Geldenhuys wrote: >>> I seriously doubt that, for the simple reason it is not implemented using >>> the LCL. > > I don't really see this as a problem. But it is the main issue. > After all, you need to download > the INF or CHM or HTML or PDF offline help

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Graeme Geldenhuys
On 14 February 2012 10:58, Sven Barth wrote: > The only thing > needed for DocView is the possibility to communicate using IPC (@Graeme?). That is already on my docview todo list, and should be one of the next things I implement (in a week or two). -- Regards,   - Graeme - __

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Graeme Geldenhuys
On 14 February 2012 10:48, Michael Schnell wrote: >> Despite DocViews obvious intrinsic qualities: >> >> I seriously doubt that, for the simple reason it is not implemented using >> the LCL. I don't really see this as a problem. After all, you need to download the INF or CHM or HTML or PDF offline

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Sven Barth
Am 14.02.2012 09:48, schrieb Michael Schnell: On 02/13/2012 04:20 PM, Michael Van Canneyt wrote: Despite DocViews obvious intrinsic qualities: I seriously doubt that, for the simple reason it is not implemented using the LCL. Is the CHM viewer based on the LCL ? Yes, it is. I don't know if

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Michael Schnell
On 02/13/2012 04:20 PM, Michael Van Canneyt wrote: Despite DocViews obvious intrinsic qualities: I seriously doubt that, for the simple reason it is not implemented using the LCL. Is the CHM viewer based on the LCL ? I don't know if/how it is possible to create an installable Lazarus Package

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Graeme Geldenhuys
On 14 February 2012 10:06, wrote: > > It is more 'I had this planned, it can also be used to solve your problem'. > > But if it's not wanted, hey, suit yourself... +1 @DoDi No offence, but Michael is trying to be accommodating here. But with every since code change he makes, you seem to find mo

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread michael . vancanneyt
On Tue, 14 Feb 2012, Graeme Geldenhuys wrote: On 14 February 2012 04:54, waldo kitty wrote: so, basically, i'm working on the documentation and write a "local" note that only belongs on my machine so that it doesn't "pollute" the documentation... This is something that does not belong in F

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread Graeme Geldenhuys
On 14 February 2012 04:54, waldo kitty wrote: > so, basically, i'm working on the documentation and write a "local" note > that only belongs on my machine so that it doesn't "pollute" the > documentation... This is exactly how DocView's annotations work, and this is exactly how I improve FPC and

Re: [Lazarus] Adding Notes in FPDoc

2012-02-14 Thread michael . vancanneyt
On Tue, 14 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: Now the lazarus team needs to decide how it intends to use the new feature. When a decision has been reached, I'll see how I can help (if any help is still needed). This reminds me on: Here's the solution, where

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread waldo kitty
On 2/13/2012 19:24, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: Now the lazarus team needs to decide how it intends to use the new feature. When a decision has been reached, I'll see how I can help (if any help is still needed). This reminds me on: Here's the solution, where's th

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Hans-Peter Diettrich
Michael Van Canneyt schrieb: Now the lazarus team needs to decide how it intends to use the new feature. When a decision has been reached, I'll see how I can help (if any help is still needed). This reminds me on: Here's the solution, where's the problem? DoDi -- __

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Michael Van Canneyt
On Mon, 13 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: On Mon, 13 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: People need to agree on: 1) Which attributes to support by default. 2) What values the attributes can take. 3) what to do if an at

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Hans-Peter Diettrich
Michael Van Canneyt schrieb: On Mon, 13 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: People need to agree on: 1) Which attributes to support by default. 2) What values the attributes can take. 3) what to do if an attribute is absent. IMO we have to agree in the firs

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Michael Van Canneyt
On Mon, 13 Feb 2012, Michael Schnell wrote: Great Stuff indeed ! So I think DocView finally is qualified as the most desired candidate for the default help viewer for Lazarus (not excluding that other help viewers might be selected instead or additionally). Despite DocViews obvious intrin

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Michael Van Canneyt
On Mon, 13 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: People need to agree on: 1) Which attributes to support by default. 2) What values the attributes can take. 3) what to do if an attribute is absent. IMO we have to agree in the first place about the *intended us

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Michael Schnell
Great Stuff indeed ! So I think DocView finally is qualified as the most desired candidate for the default help viewer for Lazarus (not excluding that other help viewers might be selected instead or additionally). -Michael -- ___ Lazarus mailing li

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Graeme Geldenhuys
On 13 February 2012 17:00, Michael Van Canneyt wrote: > > Let us not forget that DOCView's INF format is just one of the possible > output formats. > Which means a FPDoc solution for notes must be generally applicable, and not > taylored to the INF specs. I fully understand that. I was simply des

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Michael Van Canneyt
On Mon, 13 Feb 2012, Graeme Geldenhuys wrote: On 13 February 2012 16:01, Michael Schnell wrote: Great stuff, but Greame stated that he is about to make the verbosity level (that already is supported by inf files) selectable on the DocView GUI. It is like Michael van Canneyt said, use att

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Hans-Peter Diettrich
Michael Van Canneyt schrieb: People need to agree on: 1) Which attributes to support by default. 2) What values the attributes can take. 3) what to do if an attribute is absent. IMO we have to agree in the first place about the *intended use* for the notes. The first implementation looks l

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Graeme Geldenhuys
On 13 February 2012 16:01, Michael Schnell wrote: > > Great stuff, but Greame stated that he is about to make the verbosity level > (that already is supported by inf files) selectable on the DocView GUI. It is like Michael van Canneyt said, use attribute in the tag. I'll then modify the fpdoc I

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Michael Schnell
On 02/13/2012 02:56 PM, Michael Van Canneyt wrote: All that can not be achieved with only a level of verbosity. But it can easily be achieved by adding attributes to each note, and reacting on these attributes. This is already implemented in revision 20335. Great stuff, but Greame stated that h

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Michael Van Canneyt
On Mon, 13 Feb 2012, Hans-Peter Diettrich wrote: Graeme Geldenhuys schrieb: A better help system should allow to show or hide details based on more criteria. In Delphi and MS (.NET...) help it would be helpful to show the texts associated with a specific language. In FPC/Lazarus help the pl

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Hans-Peter Diettrich
Graeme Geldenhuys schrieb: On 11 February 2012 12:23, Michael Van Canneyt wrote: Seeing the discussions about annotating the documentation created by FPDoc, I added support for notes. (revision 20304) Thank you Michael, this should definitely come in handy for some people. Not me ;-) I al

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Graeme Geldenhuys
On 13 February 2012 12:30, Michael Schnell wrote: > just "Notes" that can be hidden. But I would vote for letting the user > decide at any point in time to switch the verbosity level in the help viewer > itself rather than use a static environment variable. That's already on my DocView todo list

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Michael Schnell
On 02/13/2012 09:30 AM, Graeme Geldenhuys wrote: So based on this, fpdoc notes could be displayed or hidden using a single INF file - simply by toggling the value of the IPF_KEYS environment variable. IMHO, multiple verbosity levels are a great idea and even more useful than just "Notes" that

Re: [Lazarus] Adding Notes in FPDoc

2012-02-13 Thread Graeme Geldenhuys
On 11 February 2012 12:23, Michael Van Canneyt wrote: > > Seeing the discussions about annotating the documentation created by FPDoc, > I added support for notes. > (revision 20304) Thank you Michael, this should definitely come in handy for some people. I also investigated this functionality fu

Re: [Lazarus] Adding Notes in FPDoc

2012-02-12 Thread Sven Barth
On 11.02.2012 22:55, Michael Van Canneyt wrote: In fact, not so different from a WIKI, but more structured. And now: Since we now have notes, these can be displayed, and edited by all. Wow... this sounds nice O.O It's actually a very old idea. Being old does not necessarily mean that it c

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Michael Van Canneyt
On Sat, 11 Feb 2012, Sven Barth wrote: On 11.02.2012 20:35, Michael Van Canneyt wrote: [snip] In fact, not so different from a WIKI, but more structured. And now: Since we now have notes, these can be displayed, and edited by all. Wow... this sounds nice O.O It's actually a very ol

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Sven Barth
On 11.02.2012 20:35, Michael Van Canneyt wrote: On Sat, 11 Feb 2012, Howard Page-Clark wrote: On 11/2/12 3:04, Michael Van Canneyt wrote: Within the tag, you can include one or more tags. Why so complicated? Can you give a *reasonable* example of the intended usage of this feature? Ye

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Michael Van Canneyt
On Sat, 11 Feb 2012, Sven Barth wrote: On 11.02.2012 16:04, Michael Van Canneyt wrote: On Sat, 11 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: Seeing the discussions about annotating the documentation created by FPDoc, I added support for notes. (revision 20304)

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Michael Van Canneyt
On Sat, 11 Feb 2012, Howard Page-Clark wrote: On 11/2/12 3:04, Michael Van Canneyt wrote: Within the tag, you can include one or more tags. Why so complicated? Can you give a *reasonable* example of the intended usage of this feature? Yes. User notes on a website. This website has been

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Sven Barth
On 11.02.2012 16:04, Michael Van Canneyt wrote: On Sat, 11 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: Seeing the discussions about annotating the documentation created by FPDoc, I added support for notes. (revision 20304) Thanks :-) In short: At the level of the

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Michael Van Canneyt
On Sat, 11 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: And now you have the incredible nerve to complain that ...your descriptions have not been very helpful so far, I'm still waiting for at least one practical example - XML, not usage :-( Well. Your reply shows yo

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Reinier Olislagers
On 11-2-2012 19:27, Howard Page-Clark wrote: > On 11/2/12 3:04, Michael Van Canneyt wrote: >> Yes. User notes on a website. This website has been in the pipeline for >> a long time. > The prospect of a website dedicated to discussion of documentation seems > to me to be a helpful move forward. This

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Howard Page-Clark
On 11/2/12 3:04, Michael Van Canneyt wrote: Within the tag, you can include one or more tags. Why so complicated? Can you give a *reasonable* example of the intended usage of this feature? Yes. User notes on a website. This website has been in the pipeline for a long time. The prospect o

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Hans-Peter Diettrich
Michael Van Canneyt schrieb: And now you have the incredible nerve to complain that ...your descriptions have not been very helpful so far, I'm still waiting for at least one practical example - XML, not usage :-( Well. Your reply shows you have not actually read the fpdoc docs (it contains

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Michael Van Canneyt
On Sat, 11 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: Why so complicated? Can you give a *reasonable* example of the intended usage of this feature? Yes. User notes on a website. This website has been in the pipeline for a long time. Sorry, I cannot establish any

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Hans-Peter Diettrich
Michael Van Canneyt schrieb: Why so complicated? Can you give a *reasonable* example of the intended usage of this feature? Yes. User notes on a website. This website has been in the pipeline for a long time. Sorry, I cannot establish any connection from a website to the syntax and usage

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Hans-Peter Diettrich
Sven Barth schrieb: On 11.02.2012 15:02, Hans-Peter Diettrich wrote: What about a less structured solution, e.g. for an alternative use of the just introduced tag? (exact syntax to be specified) That example would be a violation of the XML specification. For this stands the (...) postscript

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Michael Van Canneyt
On Sat, 11 Feb 2012, Hans-Peter Diettrich wrote: Michael Van Canneyt schrieb: Seeing the discussions about annotating the documentation created by FPDoc, I added support for notes. (revision 20304) Thanks :-) In short: At the level of the , and tags, you can now include a tag. Wi

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Sven Barth
On 11.02.2012 15:02, Hans-Peter Diettrich wrote: What about a less structured solution, e.g. for an alternative use of the just introduced tag? (exact syntax to be specified) That example would be a violation of the XML specification. The following would have been sufficient: XYZ deserves a

Re: [Lazarus] Adding Notes in FPDoc

2012-02-11 Thread Hans-Peter Diettrich
Michael Van Canneyt schrieb: Seeing the discussions about annotating the documentation created by FPDoc, I added support for notes. (revision 20304) Thanks :-) In short: At the level of the , and tags, you can now include a tag. Within the tag, you can include one or more tags. W