musescore / musescore/MuseScore
Attach a help link to each function
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 15.1k
- Forks
- 3.3k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 91
Description
Your idea
It will be convenient to attach to each function a link to a related handbook page.
Problem to be solved
Faced with some menus, dialog boxes, text boxes, etc., users can be confused how it works. Now they must look for help via Help > Online handbook and search for the functions interest them, which may be hard to find.
Prior art
Microsoft Excel has attached to each function dialog box a help link to its official documentation.
- Open Microsoft Excel.
- Create a blank workbook.
- Click Formula (in the ribbon bar) > Insert function, or press Alt, M, F, or press Shift + F3 instead (see Using functions and nested functions in Excel formulas for more information).
- Select a function, for example XLOOKUP.
- Click Help on this function.
Similar links to related pages in Handbook is needed.
Additional context
There Online handbook is not enough for a specific function.
Issue type
UX/Interaction bug (incorrect behaviour)
Description with steps to reproduce
- Help / Online handbook
Result: old handbook on musescore.org opens Expected result: new handbook on GitBook opens
The old Handbook does link to the new, but it suggests this is still a work in progress. If so, fine, maybe we shouldn't update the link in the Help menu yet. But this issue could remain open as a reminder we do need to do it at some point.
Supporting files, videos and screenshots
What is the latest version of MuseScore Studio where this issue is present?
OS: Debian GNU/Linux 12 (bookworm), Arch.: x86_64, MuseScore Studio version (64-bit): 4.5.0-250721848, revision: github-musescore-musescore-7c55023
Regression
No.
Operating system
Debian 12
Additional context
No response
Checklist
- This report follows the guidelines for reporting bugs and issues
- I have verified that this issue has not been logged before, by searching the issue tracker for similar issues
- I have attached all requested files and information to this report
- I have attempted to identify the root problem as concisely as possible, and have used minimal reproducible examples where possible
Checklist
- This request follows the guidelines for reporting issues
- I have verified that this feature request has not been logged before, by searching the issue tracker for similar requests
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by locating the Help > Online handbook action and the function dialog interfaces, then determine how functions map to handbook pages. Done means relevant function dialogs expose links to their related handbook pages and the handbook destination in the Help menu is updated from the old site to GitBook.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- desktop, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100