Context-sensitive help

[serendipity]

Hi Don,
How difficult would it be to implement Context-sensitive help?
For example, if I press F1 while on Find files tab, help jumps to Find files section.

I use one program at work which has this and it greatly improves my understanding of the program.

[admin]

I have context-sensitive help in the configuration dialog. It's not difficult.

[serendipity]

I have context-sensitive help in the configuration dialog. It's not difficult.

Yeah those info tips in config are great!
This is a low-prio for myself since i know XY fairly well, but could you put context-sensitive help to your list?
Thanks.

[admin]

I have context-sensitive help in the configuration dialog. It's not difficult.

Yeah those info tips in config are great!
This is a low-prio for myself since i know XY fairly well, but could you put context-sensitive help to your list?
Thanks.

Info Tips? I mean context-sensitive help (F1).

[serendipity]

I have context-sensitive help in the configuration dialog. It's not difficult.

Yeah those info tips in config are great!
This is a low-prio for myself since i know XY fairly well, but could you put context-sensitive help to your list?
Thanks.

Info Tips? I mean context-sensitive help (F1).

Wow! i did not know that.
That's already awesome, would be also nice to have such a thing in the main interface (especially Info Panel).
Like for example, i was trying something with dupes during the weekend and wanted to see help, it takes several clicks to get to help.
Like you have the help button in config, is it possible to have either a button or "?" icon in IP which takes user to relevant help section?

[admin]

I see no good place for such a button, but a context-sensitive F1 when the focus is in the IP would be possible.

[neminem]

It's fairly common for dialogs to have Help buttons (generally in the bottom left corner) that show help for the dialog, but that the main form of a program just allows accessing context-sensitive help using F1. I agree, having the main form hooked up to a CSH system based on the focused tab would not be a bad idea. (I dunno how XY implements its help... in our case (I was the one who implemented CSH in the program I work on ), adding the system itself was pretty easy, but... actually locating and adding the name of the correct help page to every possible place someone might hit F1 was rather more effort. Worth it eventually? I'd say yes. Worth it right now? If this were my program, I'd probably say no. Not my program, though. :p)

[serendipity]

I see no good place for such a button, but a context-sensitive F1 when the focus is in the IP would be possible.

Yes that's an option, but to be honest if there's no button (or visual indication of help), not many will know or remember to use F1 key.
I don't want you to spend time on something if it will be overlooked easily.

btw, somewhat offtopic: i feel many XY features go unnoticed because it gets buried this way.
One example is the right-click (which is so universal to XY), not many newbies know that XY has lots of little gems hidden underneath that right-click. Another one is holding down a key while clicking something.
I know Don has added tooltips in several places to remind us of this, but there should be a more definitive way to drive this point to newbies.
@Don: Is "tip of the day" off by default? Whenever i try fresh XY install i don't see any tips.

[admin]

I see no good place for such a button, but a context-sensitive F1 when the focus is in the IP would be possible.

Yes that's an option, but to be honest if there's no button (or visual indication of help), not many will know or remember to use F1 key.
I don't want you to spend time on something if it will be overlooked easily.

btw, somewhat offtopic: i feel many XY features go unnoticed because it gets buried this way.
One example is the right-click (which is so universal to XY), not many newbies know that XY has lots of little gems hidden underneath that right-click. Another one is holding down a key while clicking something.
I know Don has added tooltips in several places to remind us of this, but there should be a more definitive way to drive this point to newbies.
@Don: Is "tip of the day" off by default? Whenever i try fresh XY install i don't see any tips.

"tip of the day" is so unsexy, I decided to turn it off.

buried: yes, this problem is not solvable IMO. Actually in my experience 50% of users would not see the feature if there was only one! (slightly exaggerating)

generally: multilingual support is next.

[serendipity]

"tip of the day" is so unsexy, I decided to turn it off.

I understand it's somewhat intrusive and gets annoying. And probably unsexy because of the 90 entries there, nobody will read through them. If there were like 5 very good tips (and rest optional) users would be interested. Maybe make a poll to ask what those 5 are?

buried: yes, this problem is not solvable IMO. Actually in my experience 50% of users would not see the feature if there was only one! (slightly exaggerating)
generally: multilingual support is next.

I agree.

[serendipity]

Code: Select all

+ Context Sensitive Help: Now most Info Panel tabs will pop Context 
      Sensitive Help on F1.

Thanks for this.
Btw i see it works only if i have focus inside the relevant tab. If for example i click on meta tag and immediate hit F1 it does not work. I have to also click inside the panel for context-help to work.

[admin]

Code: Select all

+ Context Sensitive Help: Now most Info Panel tabs will pop Context 
      Sensitive Help on F1.

Thanks for this.
Btw i see it works only if i have focus inside the relevant tab. If for example i click on meta tag and immediate hit F1 it does not work. I have to also click inside the panel for context-help to work.

Yes, I made it focus-dependent. You think it should even pop meta tab help when the focus is in e.g. the Tree?

[serendipity]

Yes, I made it focus-dependent. You think it should even pop meta tab help when the focus is in e.g. the Tree?

Yes, definitely helps. Maybe other ui elements like list management, background jobs etc too?

[admin]

Yes, I made it focus-dependent. You think it should even pop meta tab help when the focus is in e.g. the Tree?

Yes, definitely helps. Maybe other ui elements like list management, background jobs etc too?

I will add some stuff now and then.

But I think it should stay focus-dependent.

[serendipity]

I will add some stuff now and then.
But I think it should stay focus-dependent.

Sure, its already a huge help to have this. Especially to point newbies to the right place.
Thanks.