Re: [amibroker] Looking for Ideas to document my Parameters, AmiBroker Email List Archive

On Dec 6, 2008, at 7:56 AM, Dennis Brown wrote:

Joseph,

There is a different help text for every different parameter. Selecting which text to use is the problem. How do I know which parameter the user wants help with? Pointing to the parameter in the parameters window is the logical answer, but how does the AFL know which parameter is being pointed to? The AFL enhancement suggestions below were made to solve this dilemma.

BR,
Dennis

On Dec 6, 2008, at 2:13 AM, J. Biran wrote:

Is there a way to use F1 to invoke this popup?

--

Joseph Biran
____________________________________________
From: amibroker@xxxxxxxxxxxxxxx [mailto:amibroker@xxxxxxxxxxxxxxx] On Behalf Of Dennis Brown
Sent: Friday, December 05, 2008 9:08 PM
To: amibroker@xxxxxxxxxxxxxxx
Subject: Re: [amibroker] Looking for Ideas to document my Parameters

Hello,

While waiting for a response on the two suggestions below, I gave a shot at trying to implement the idea of having a ParamTrigger() popup some documentation for a whole section. It is not hard to implement. However, it is very cumbersome and does not convey the help for the parameter in question in the section. It was simply unwork able in a practical UI sense. I knew exactly what line of text to write if I could popup text for a specific parameter. However, creating a large paragraph trying to reference each parameter by name followed by a description was a nightmare to write in a way that would make sense to a user. I give up on that idea.

If a user clicks, hovers, etc., on a parameter name (as in the two suggestions) the context of that parameter is implied and needs no further reference in the help text. To simulate this, I would have to have a ParamTrigger() parameter for help on each parameter taking up another line in between each parameter. Definitely not a workable solution.

So, unless someone has another idea, it seems that I am at the mercy of Tomasz to add this capability to AB.

Best regards,
Dennis

On Dec 3, 2008, at 10:57 PM, Dennis Brown wrote:

The suggestions are #1638 and #1639 if you wish to add your votes.

BR,
Dennis

On Dec 2, 2008, at 11:25 AM, Dennis Brown wrote:

Dingo,

Thanks. That is not a half bad idea. I do have many expandable "sections" in my params hier! archy&nb sp;and even though it is not quite modular on the individual parameter level and takes up another line in each section, it would provide the essential functionality of embedding the documentation in the parameters.

Actually, I could save the extra parameter space, by making a shift-click on a Flexible Parameters section header bring up the help text for the section instead of closing or opening the section as an expansion to my FP base functionality. And a right click would be even better, but it will not activate a ParamTrigger(). I could even modify the button text slightly to indicate that a help popup is available. The documentation could then be rolled up into the parameter definitions in the AFL code.

So, there are several possible suggestions to make t his easy for all AFL programmers:

1. Having a command that loads up some tooltip text for each parameter (just before the param statement). AB would then display the text when hovering in the parameter window over the parameter name button. Simple for the programmer to document the param.

2. A Status("Parameter") could be executed after each param statement execution that would return three bits for the cursor is over the name button, or the name button was clicked or it was right clicked. This could be very useful for even more things than just popup documentation. I could definitely put the extra functionality to good use in FP.

3. Alternatively, a ParamStatus("paramName") could be used anywhere in the AFL to return the same information as in 2.

4. Activate and provide the status indicating a right click on a ParamTrigger()

I would prefer #2 or 3 first, but #1 is an independent suggestion that stands alone and could be used in conjunction with the other. #4 is also independent ! but woul d work as a cruder way of doing more with the Params UI for documentation and other functionality.

Any other comments before I write up a suggestion?

Thanks,
Dennis

On Dec 2, 2008, at 9:04 AM, dingo wrote:

how about a "toggle" as the last entry in each section that says "Help on this param". Then show the help when it is clicked?

d
On Tue, Dec 2, 2008 at 8:36 AM, Dennis Brown <see3d@xxxxxxxxxxx> wrote:

Herman,

Thanks for the ideas.
more embedded below.

On Dec 2, 2008, at 5:38 AM, Herman wrote:

First: YES: I WOULD LOVE TO HAVE TOOLTIPS ADDED TO THE PARAM WINDOW. GREAT IDEA!

You should make a suggestion on the feed back site. Since Amibroker, when hovering the cursor over the Param window, already pre-selects the individual parameters (you can see this because they change appearance when you move you cursor over the items) the information you need is already available inside AB. It might be a simple task for TJ to make this available through a Status().

I noticed that the parameter name button changes appearance independent of the parameter button when the cursor is over it. I thought that might be a clue for a way to differentiate a response. If the name button could trigger a ParamTrigger() like response that could also be used for a popup. Your suggestion of a Status() that indicated if the cursor is hovering over a parameter name or even if it was clicked could be a very. Perhaps the status could be used in context so that it could follow an AFL parameter function and indicate if the cursor is currently over that parameter or the name was c! licked.< /div>

I will add a suggestion tomorrow (after any other suggestions come up). I want to make sure I am suggesting something that is feasible so it does not just get rejected out of hand.

As is, except for when you are using a GFX based Params (Buttons) systems, I don't think it is possible. You could however embed P opUpWindow() or ToolTip() in your custom Param functions so that they popup when the param is c licked - however this would be after the fact ;-) Unless you educate your user to only 'confirm' a parameter setting by clicking on it but not changing the parameter. This would require a certain skill.

another way would be to have the Righ! t mouse button popup an information window that is relevant to the current, or last, selected Param. Or pop up a custom menu with relevant information options.

I know how to do this only for ParamTrigger() type parameters. I can only detect user interactions for other types if the parameter is actually changed.

I think it would be very useful to have this function. There are many among us who prefer coding to trading and who write code that is used by others. I myself spend lots of time and write hundreds of emails explaining how things work. Having Param Tooltips would sa ve lots of time all around.

It also makes it much easier to embed the documentation into the code so that it remains up to date with code changes and is handy as a reference during program operation.

Best regards,
herman

Monday, December 1, 2008, 9:55:36 PM, you wrote:

> Hello,

> I have hundreds of parameters in my system (using Flexible
> Parameters). My trading mentor wants to learn and start playing with
> my system in Jan (firs t time AB user). I would like to be able to
> have tooltip text pop up when he is over a parameter name in the
> parameter window, or perhaps by left or right clicking on the
> parameter name, have a commentary window or Gfx text box explaining
> the parameter pop up in the chart.

> I don't have a clue of how to make this happen, or if someone has a
> different brilliant idea of how I can embed my parameter d ocumentation
> into the AFL program so the user can easily reference it.

> Perhaps it is possible to trick the parameter name buttons to send
> their name to somewhere that AFL could access somehow and pop up the
> commentary.

> I wou ld appreciate any ideas.

> Tomasz, If you can think of an AFL enhancement that would make this
> possible, I would love to suggest it. I just don't know what
> suggestion to make that would be practical.

> TIA,
> Dennis