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

Add tooltips for Orientation module #375

Open
kchall opened this issue Sep 23, 2024 · 5 comments
Open

Add tooltips for Orientation module #375

kchall opened this issue Sep 23, 2024 · 5 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@kchall
Copy link
Member

kchall commented Sep 23, 2024

Tooltips for showing abbreviated forms of the orientation module when hovering over modules in the summary window (like the ones below for hand configuration and movement) should be added.

image image

List of abbreviations is available here: https://docs.google.com/spreadsheets/d/1qdf72ivD_tLFBvVQgSkzesyzVF_HWb1llmc2fmaqPI8/edit?gid=528233643#gid=528233643

Sample corpus with orientations coded:
https://www.dropbox.com/scl/fi/rgqta83dp7ohh0uc1g24q/SLPAA_sample_corpus_with_orientations.slpaa?rlkey=f9ea72g9tj0l98wv3e3ktbzfl&dl=0

@kchall kchall added enhancement New feature or request good first issue Good for newcomers labels Sep 23, 2024
@kvesik
Copy link
Collaborator

kvesik commented Sep 25, 2024

The abbreviations string should be built by OrientationModule.getabbreviation() -- currently there is a method stub that just returns "Orientation abbreviations not yet implemented".

@kvesik
Copy link
Collaborator

kvesik commented Oct 8, 2024

@Eth-Jin Additional things to consider and/or places to look for inspiration as you are working on this issue:

  • use OrientationModule.palm and OrientationModule.root to access palm and finger root direction info
  • use OrientationModule.phonlocs (of type PhonLocations and inherited from ParameterModule) to access phonological and phonetic location info
  • combine the info from above using Signtype.makeabbreviationstring() as an example of how you might organize the relevant text in between punctuation elements like ";" and "(" and ")" to form an abbreviation string formatted in the correct way-- refer to the abbreviations spreadsheet to see examples of Kathleen's desired formatting
  • you are also welcome to look at any of the getabbreviation() methods from other modules if you're curious, but most of them are either not implemented yet or structured quite differently than this one will need to be
  • you don't need to implement the tooltip itself, because the graphic summary just pulls from the getabbreviation() method and shows the tooltip automatically... so it's just the actual text string that we need

@kchall I noticed that in the abbreviations spreadsheet, you include the module name (e.g. "H1.Ori1") in the abbreviation, but that's not what we've done so far for signtype or hand config-- is it ok to just have the content info itself in the tooltip, without also including the module name?

@kchall
Copy link
Member Author

kchall commented Oct 8, 2024

@kvesik, @Eth-Jin Ah, right -- thanks for pointing that out, Kaili! No, we don't need to include the module name. I'll modify the spreadsheet accordingly.

@gracemyz
Copy link
Contributor

gracemyz commented Feb 2, 2025

@kvesik, @Eth-Jin Ah, right -- thanks for pointing that out, Kaili! No, we don't need to include the module name. I'll modify the spreadsheet accordingly.

@kchall does this apply to all modules? I see that module names are still included in the abbreviations spreadsheet for movement, location, and relation .

@kchall
Copy link
Member Author

kchall commented Feb 3, 2025

@kvesik, @Eth-Jin Ah, right -- thanks for pointing that out, Kaili! No, we don't need to include the module name. I'll modify the spreadsheet accordingly.

@kchall does this apply to all modules? I see that module names are still included in the abbreviations spreadsheet for movement, location, and relation .

Thanks, @gracemyz -- right, this should apply to all modules. The module IDs are just for the labels on the summary window, but don't have to appear in the tooltips themselves. I've updated the other spreadsheets. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

4 participants