Added ancient language locale files.

[yeatersink]

Link to issue number:

#16720

Summary of the issue:

Added speech support for the 6 ancient languages released by the most recent version of Lib Louis 3.30.0 on June 5, 2024.

Description of user facing changes

Description of development approach

We ran test on these languages on local computer for the past several months before creating this pull request. The speech works great.

Testing strategy:

Utilized features in various environments, including online in professional websites and applications such as notepad and MS Word.

Known issues with pull request:

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

@coderabbitai summary

[coderabbitai]

Walkthrough

The recent updates introduce new character descriptions and symbolism mappings for several ancient scripts, such as Transliterated-Cuneiform, Akkadian, Akkadian-Sumero, Hebrew, Syriac, and Ugaritic. These enhancements are aimed at improving the NonVisual Desktop Access (NVDA) software by providing detailed descriptions and context for each character. This will aid users in better understanding and utilizing these scripts within the NVDA environment.

Changes

Files/Groups	Change Summaries
source/locale/Transliterated-Cuneiform/characterDescriptions.dic	Added new file with descriptions for specific characters such as left half ring, right half ring, subscript small x, and z with dot below.
source/locale/Transliterated-Cuneiform/symbols.dic	Updated file with a list of Transliterated-Cuneiform symbols and their descriptions.
source/locale/akk-Xsux/characterDescriptions.dic	Added new file with comprehensive list of Akkadian characters and their descriptions.
source/locale/akk-sumero-Xsux/characterDescriptions.dic	Added new file for Akkadian-Sumero with a comprehensive list of character descriptions mapping symbols to their meanings or representations.
source/locale/hbo/characterDescriptions.dic	Added new file with a list of Hebrew characters and their descriptions.
source/locale/hbo/symbols.dic	Added new file listing Hebrew characters with descriptions such as bet with dagesh, dalet with dagesh, hey with dagesh, kaf with dagesh, mem with dagesh, nun with dagesh, pe with dagesh, qof with dagesh, shin with dot, tav with dagesh, and more.
source/locale/syc/characterDescriptions.dic	Added new file providing mappings of Syriac characters to their descriptive names.
source/locale/syc/symbols.dic	Added new file listing Syriac symbols with descriptions and usage contexts.
source/locale/uga/characterDescriptions.dic	Added new file providing mappings of Ugaritic characters to their phonetic descriptions.
source/locale/uga/symbols.dic	Added new file introducing a Ugaritic word divider symbol with associated metadata.

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e57d7e5 and 8282f06.

Files selected for processing (10)

• source/locale/Transliterated-Cuneiform/characterDescriptions.dic (1 hunks)
• source/locale/Transliterated-Cuneiform/symbols.dic (1 hunks)
• source/locale/akk-Xsux/characterDescriptions.dic (1 hunks)
• source/locale/akk-sumero-Xsux/characterDescriptions.dic (1 hunks)
• source/locale/hbo/characterDescriptions.dic (1 hunks)
• source/locale/hbo/symbols.dic (1 hunks)
• source/locale/syc/characterDescriptions.dic (1 hunks)
• source/locale/syc/symbols.dic (1 hunks)
• source/locale/uga/characterDescriptions.dic (1 hunks)
• source/locale/uga/symbols.dic (1 hunks)

Files skipped from review due to trivial changes (7)

• source/locale/Transliterated-Cuneiform/characterDescriptions.dic
• source/locale/akk-Xsux/characterDescriptions.dic
• source/locale/akk-sumero-Xsux/characterDescriptions.dic
• source/locale/hbo/characterDescriptions.dic
• source/locale/syc/characterDescriptions.dic
• source/locale/syc/symbols.dic
• source/locale/uga/characterDescriptions.dic

Additional context used

Path-based instructions (3)

source/locale/uga/symbols.dic (1)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

source/locale/hbo/symbols.dic (1)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

source/locale/Transliterated-Cuneiform/symbols.dic (1)

Pattern **/*: Focus on code smells, logic errors, edge cases, missing test cases, security flaws and serious issues. Avoid commenting on minor issues such as linting, formatting and style issues. This project uses tabs instead of spaces, do not suggest usage of spaces over tabs. Are there any 'red flags' in this code that might warrant closer investigation from a security standpoint? Explain what makes them suspicious.

Additional comments not posted (3)

source/locale/uga/symbols.dic (1)

1-7: Review of Ugaritic Symbols Dictionary

The file is well-structured and follows the expected format for NVDA dictionary files. The entry for the Ugaritic word divider is clear and correctly formatted. No security issues or code smells are detected in this file.

source/locale/hbo/symbols.dic (1)

1-68: Comprehensive Review of Hebrew Symbols Dictionary

The Hebrew symbols dictionary is extensive and appears to be correctly formatted. Each symbol is associated with a clear description and usage context ("most always"). However, there are duplicate entries for some symbols (e.g., bet with dagesh appears twice in lines 8 and 9). It's important to ensure that these duplicates are intentional and correct. Additionally, the use of special characters like check marks and other symbols in lines 13-41 needs careful validation to ensure they are interpreted correctly by NVDA.

source/locale/Transliterated-Cuneiform/symbols.dic (1)

1-78: Detailed Review of Transliterated-Cuneiform Symbols Dictionary

The Transliterated-Cuneiform symbols dictionary is well-structured and comprehensive. Each entry is clearly described and formatted consistently. The use of subscript and special characters (lines 56-70) is notable and should be validated to ensure they are correctly processed by NVDA. There are no apparent security issues or code smells in this file.

Verification successful

To validate the use of subscript and special characters in the Transliterated-Cuneiform symbols dictionary, we need to correct the file type in the rg command. Since we are dealing with a .dic file, we should not specify a file type.

---

Validation of Special Characters in Transliterated-Cuneiform Symbols Dictionary

The special characters ᴹ, ᵈ, and ₈ are correctly present in the dictionary file as intended.

• Verified presence of:
  • ᴹ (subscript capital m)
  • ᵈ (subscript d)
  • ₈ (subscript eight)

Scripts executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Description: Validate the use of subscript and special characters in the Transliterated-Cuneiform symbols dictionary.

# Test: Validate special characters.
rg --type python $'[ᴹᵈ₈]' source/locale/Transliterated-Cuneiform/symbols.dic

Length of output: 108

---

---

Script:

#!/bin/bash
# Description: Validate the use of subscript and special characters in the Transliterated-Cuneiform symbols dictionary.

# Test: Validate special characters.
rg '[ᴹᵈ₈]' source/locale/Transliterated-Cuneiform/symbols.dic

Length of output: 153

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[seanbudd]

Hi @yeatersink - as requested in #16720, we require languages like this to be added via our translation framework, as described here: https://github.com/nvaccess/nvda/blob/master/projectDocs/dev/developerGuide/developerGuide.md#symbol-pronunciation-symbolpronunciation

This will require NV Access to consider adding these languages as available for translation before work starting.

Can you please explain what synthesizers you are using for these languages? I am surprised you are getting "great" speech here without synthesizer support.

PS: Please note, we did not accept the issue, and in fact converted it to a discussion. In future, I would encourage waiting for an issue to get the "triaged" label before opening a PR, as per our contributing guidelines