Steno hints to look up briefs on the fly instead of using static files

[didoesdigital]

Overview

~~By looking up briefs on the fly for steno hints in lessons instead of using the hints supplied by static lesson files, the static lesson generator project (which is not open source) will become redundant. The static lesson generator is error prone, manual, laborious and has no flexibility for people using their own dictionaries. Instead of lesson files containing a word and brief as well as accompanying dictionaries, lessons might only need to be word lists. Metadata in the lesson index could link to any recommended dictionaries.~~

~~Looking up briefs on the fly will also let people use their own dictionaries (#5) to see the hints they prefer in lessons.~~

UPDATE: static lesson generator has been replaced by the open source Typey Type CLI: https://github.com/didoesdigital/typey-type-cli

We currently use the static lesson files for:

A) word lists, B) hints for lessons where the URL does not contain phrasing, prefixes, suffixes, steno party tricks, or collections/tech, and C) the main steno hint (whereas the list of steno hints is already looked up on the fly when using the "Show other stroke hints" settings)

To look up steno hints on the fly for B), we could use lesson metadata to use hints from recommended dictionaries.

[didoesdigital]

Consideration: "I" might be better stroked with EU in a story, 1-R in a roman numerals lesson, or *EUP in a fingerspelling lesson.

[didoesdigital]

Consideration: https://github.com/didoesdigital/steno-dictionaries/issues/93

[didoesdigital]

Consideration: https://github.com/didoesdigital/steno-dictionaries/issues/96

[didoesdigital]

Consideration: https://github.com/didoesdigital/steno-dictionaries/issues/174

[didoesdigital]

Some words that may start showing different briefs:

• "first" may start to show TPEURS instead of TPEUFRT ✅
• "get" may start to show TKPW-T instead of TKPWET (skeleton brief instead of canon)
• "fall" may start to show TPAL instead of TPAUL (alternative instead of canon)
• "situation" may start to show SEUFP instead of SWAEUGS (shorter brief)
• "maiden" may start to show PHAEUD/EPB instead of PHAEUD/*EPB 🙅‍♀️
• "shouldn't" may start to show SH-PBT instead of SHOPBT (skeleton brief instead of canon)
• "we've" may start to show W*EF instead of WAOEF 🤷‍♀️
• "mustn't" may start to show PHUPBT instead of PHUFPBT (seems like a brief instead of phonetic)
• "architecture" may start to show TREGS instead of TREBGS 🤷‍♀️
• "weren't" may start to show W-RPBT instead of WR-PBT 🤷‍♀️
• "V" may start to show 5R instead of SR*P 🙅‍♀️
• "X" may start to show 10R instead of KP*P 🙅‍♀️

[didoesdigital]

Recent changes show hints on the fly when globalUserSettings in local storage has experiments key with an object for the value that includes stenohintsonthefly:true e.g.:

{"experiments":{"stenohintsonthefly":true},"flashcardsCourseLevel":"proficientCourse","showMisstrokesInLookup":false,"writerInput":"raw"}

[didoesdigital]

TODO: add support for special lessons and remove exceptions here: https://github.com/didoesdigital/typey-type/blob/master/src/App.js#L1407-L1414

[didoesdigital]

Consideration: https://github.com/didoesdigital/steno-dictionaries/issues/206

[didoesdigital]

Consideration: unix AO*UPB/T-PLZ

[didoesdigital]

Consideration: hints for multiple suffixes e.g. "buffetings" should show "PWUF/ET/-G/-S" using just the base word "PWUF/ET": "buffet", and the multiple suffixes, "-G": "{^ing}", and "-S": "{^s}",

[didoesdigital]

Consideration: entries ending in "s" should continue to prioritise -S over -Z e.g. "wanderings"

[didoesdigital]

Consideration: https://github.com/didoesdigital/steno-dictionaries/issues/197

[didoesdigital]

Consideration: https://github.com/didoesdigital/steno-dictionaries/pull/306

[didoesdigital]

"Good-by." shows fingerspelling hint.

[didoesdigital]

To test:

King's
"Y--es,"
Madam's
"O
Cinderilla's
oh,
do,
twenty-five
i.e.
i.e.,
well-known
self-control
Boy's
"It's
That's
Rabbit's
l'etat c'est moi

[didoesdigital]

"bulls" shows PWUL/-S but "Bulls" shows fingerspelling

[didoesdigital]

Similar: test with "Mouses"

[didoesdigital]

"delight;" hint shows suppressed space semi-colon instead of spaced semi-colon