FLUID-6240: Implement a syllabification preference

Description

Implement a new preference for providing a syllabification adaptation to the content of a page. The enhancement should present words, in the content of the page, broken into their syllables.

e.g. syl•la•ble

See:

• https://issues.gpii.net/browse/GPII-2433
• https://wiki.gpii.net/w/Browser_Adaptation_Design_Research#Syllabification

Comments

• Justin Obara commented 2018-01-22T08:24:31.266-0500

  May be able to use https://github.com/nlp-compromise/nlp-syllables for parsing words into syllables.

• Justin Obara commented 2018-01-23T13:17:04.935-0500

  Potential Issues:

  Breaking words up into syllables is dependent on context (usage/form of the word) and dialects (pronunciation).

  context: re•cord, rec•ord

  pronunciation: cara•mel, car•a•mel

• Justin Obara commented 2018-01-26T11:01:29.764-0500

  Conversation with @@Alan Harnum in the channel about this today: https://botbot.me/freenode/fluid-work/2018-01-26/?msg=96180428&page=1

  tl:dr

  It's hard, and accuracy at best would be 85 - 90%.

• Justin Obara commented 2018-02-05T15:37:08.315-0500

  Based on feedback from the APCP UX team, it was recommended to go with Hypher for now. https://wiki.gpii.net/w/Browser_Adaptation_Design_Research#Questions

  While looking into it more, it seems that hypher requires language patterns that are LGPL licensed. To reduce any issues of breaking or confusing licenses, it's best that we link in these dependencies (e.g. through npm).

  See: https://botbot.me/freenode/fluid-work/2018-02-05/?msg=96512159&page=1

• Justin Obara commented 2018-03-01T08:32:07.639-0500

  Due to the licenses of the language pattern files, we may need to pull them in via NPM. We should probably work on this along with FLUID-6253

• Justin Obara commented 2018-10-19T11:01:42.978-0400

  Below is a review of how the Learning Tools performs with Microsoft Word from Office 365. "?" for UIO+ means that we need to determine how to handle the feature.

  Feature	Learning Tools (Desktop)	Learning Tools (Web)	UIO+
  Show Syllables	view > learning tools > syllables	view > immersive reader > grammar options > syllables	UIO+ > syllables
  Displays in Context	sort of	no	yes
  Is editable	yes	no	? (probably not for inputs, but maybe for dynamic content)
  Syllable separator included text selection	no	yes	yes
  Syllabification affects screen reader output	no	yes	yes
  Syllabification affects self voicing	no	no	?
  Syllabification affects text search	no	yes	yes
  Revertible	yes	yes	?