[Maintenance]: Add a help window

Open
#6,172 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
java
Domain
design, desktop

Research direction

Start by reviewing the UI text referenced in PR #6015 and the dialogs and tools where explanatory text crowds out controls. Identify a suitable way to open fuller help text in a separate, positionable window while preserving its context. Done when users can view the explanation and the relevant controls at the same time; the issue names no source files or tests.

Written by the indexing model from the issue text.

Description

code-maintenance design needed feature
Describe the problem

Help text is available at numerous points in the UI.
It appears in the status bar for most tools, and various dialogue boxes contain explanatory text.
There is a conflict in providing sufficient text for clarity, and brevity in order to fit the UI. This can result in the explanatory text crowding out the actual controls it explains making it difficult to reference the text and the controls at the same time.

The improvement you'd like to see

Where the text in-place is too large, or is deserving of fuller explanation, provide a help facility that opens a new window containing the text. This way the user can position it where they can see both the text and its context.

Expected Benefits

Cleaner UI.
Better user experience.

Additional Context

#6015 comment

Dominant language
Java
Stars
927
Forks
286
Avg merge
3d 17h
Merged PRs (30d)
94

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from RPTools/maptool

All issues in RPTools/maptool

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.