Proposal Smart Help

From Audacity Wiki
Revision as of 12:58, 25 April 2011 by James (talk | contribs) (Link to UX site.)
Jump to: navigation, search
Proposal pages help us get from feature requests into actual plans. This page is a proposal for context sensitive help in the preferences panels.
Proposal pages are used on an ongoing basis by the Audacity development team and are open to edits from visitors to the wiki. They are a good way to get community feedback on a proposal.


  • Note: Proposals for Google Summer of Code projects are significantly different in structure, are submitted via Google's web app and may or may not have a corresponding proposal page.


Proposed Feature

Detailed context sensitive information on each configurable parameter in the preferences panel. This information will be automatically extracted from the html help reference section which has been written with this use in mind.


Developer Backing

  • James Crook I have done some development work which could be built on for this. The most useful part is a change in ShuttleGui.


Use Cases

  • Shorter descriptions: This will allow us to use very short descriptions in the preferences panel, e.g. just a tick box with the word 'Overdub' beside it. Experienced users will already know what this does. Inexperienced users or users who have forgotten what the parameters in a particular parameter group do can click on the title for a group to get a description for each parameter in the group.
  • Audacity GUI as the index: Instead of reading the manual and finding the right place in it, Audacity can find the right place and just present the information you asked for.


See Also