Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

additional ways to reach Help/documentation #999

Closed
skurfer opened this issue Jul 17, 2012 · 5 comments
Closed

additional ways to reach Help/documentation #999

skurfer opened this issue Jul 17, 2012 · 5 comments
Assignees
Milestone

Comments

@skurfer
Copy link
Member

@skurfer skurfer commented Jul 17, 2012

I thought of this as I wrote documentation for the E-mail Support plug-in. (The only way you’ll ever see it is if you hold ⌥ when clicking the list of installed plug-ins.)

For those plug-ins that supply a pref pane, there should be a Help button above or below the pref pane’s view that opens the documentation for the plug-in that provides the prefs.

That would provide a more obvious way to reach documentation for a hidden plug-in (if it has prefs), and would also provide quick answers for users looking at the prefs and wondering “What does this setting do?”

@skurfer
Copy link
Member Author

@skurfer skurfer commented Jul 17, 2012

Oh, crap. Looks like we’ll by typing 4-digit numbers after this. :-)

@HenningJ
Copy link
Contributor

@HenningJ HenningJ commented Jul 17, 2012

We should have a 4-digit-Party :-)

I agree with this feature request. This help button should have the same shortcut as the one in the plugins preferences (I think ⌘⌥?).
If we want to be really fancy, we could define a dedicated preferences section in the help file and automatically scroll to that if called from the plugin's pref pane.

@skurfer
Copy link
Member Author

@skurfer skurfer commented Jul 18, 2012

This help button should have the same shortcut

Good idea.

If we want to be really fancy, we could define a dedicated preferences section in the help file and automatically scroll to that if called from the plugin's pref pane.

The new system (#988) will automatically add id="preferences" to any heading named “Preferences”, so if there’s a way to link to an anchor tag within a WebKit view, it should be pretty easy.

@hmelman
Copy link

@hmelman hmelman commented Aug 17, 2012

I think there should be a ? help button next to the i button on the plugin preference pane. Now that the help is useful, it's a pain to have to open the sidebar to get to the ? button. Also, since I'm already mousing to select the plugin and probably mousing to move (or at least close) the popup help window, I'd rather not have to move back to the keyboard to use ⌥⌘? to bring up help, clicking a button is easier.

@skurfer
Copy link
Member Author

@skurfer skurfer commented Aug 17, 2012

I think there should be a ? help button next to the i button on the plugin preference pane.

Also a good idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants