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

Table for the international phonetic alphabet #16829

Merged
merged 3 commits into from
Jul 8, 2024

Conversation

zstanecic
Copy link
Contributor

@zstanecic zstanecic commented Jul 6, 2024

Link to issue number:

fixes #16773

Summary of the issue:

This pull request adds the International phonetic alphabet braille table inly on output, as requested in the issue referenced above.

Description of user facing changes

Added new International phonetic alphabet braille table in the braille settings dialog, output braille table section

Description of development approach

Changed the brailleTables.py and changes.t2t accordingly, all this based on the beta branch, targeted to 2024.3

Testing strategy:

Ran NVDA from source and verified that the braille table works.

Known issues with pull request:

None known

Code Review Checklist:

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

Summary by CodeRabbit

  • New Features

    • Added a braille table for the International Phonetic Alphabet (IPA).
    • eSpeak now supports the Karakalpak language.
  • Documentation

    • Updated user documentation to reflect new Braille tables for Cyrillic Serbian, Yiddish, ancient languages, Turkish, and IPA.
    • Included updates to Unicode CLDR for additional language supports.

@zstanecic zstanecic requested a review from a team as a code owner July 6, 2024 16:53
@zstanecic zstanecic requested review from gerald-hartig and removed request for a team July 6, 2024 16:53
Copy link
Contributor

coderabbitai bot commented Jul 6, 2024

Walkthrough

In this update, a new Braille table for the International Phonetic Alphabet (IPA) was added to source/brailleTables.py, extending available language support within the Liblouis library. Additionally, updates to the user documentation reflect these changes and additional language supports in Unicode CLDR and eSpeak.

Changes

File Change Summary
source/brailleTables.py Added a new Braille table for the International Phonetic Alphabet (IPA) with the identifier "IPA.utb" and set input parameter to False.
user_docs/en/changes.md Documented the inclusion of new Braille tables for Cyrillic Serbian, Yiddish, ancient languages, Turkish, and International Phonetic Alphabet (IPA), updated Unicode CLDR with additional language supports, and noted eSpeak’s added support for the Karakalpak language.

Sequence Diagram(s)

1. Adding a new Braille Table

sequenceDiagram
    participant Developer
    participant BrailleTables
    participant UserDocs

    Developer->>BrailleTables: Add "IPA.utb" Braille table
    Developer->>UserDocs: Update changes.md to include IPA Braille table
Loading

Assessment against linked issues

Objective (Issue #16773) Addressed Explanation
Enable the IPA Braille Table in NVDA
Document new Braille tables and language supports in the changes.md

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
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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range and nitpick comments (3)
user_docs/en/changes.md (3)

18-20: Correct the punctuation and improve readability.

There is an extra comma after "ancient languages" and the term "International phonetic alphabet" should be capitalized.

- Liblouis has been updated, adding new Braille tables for Cyrillic Serbian, Yiddish, several ancient languages,, Turkish, and International phonetic alphabet.
+ Liblouis has been updated, adding new Braille tables for Cyrillic Serbian, Yiddish, several ancient languages, Turkish, and International Phonetic Alphabet.

18-20: Ensure consistent formatting for new entries.

The new additions should follow the one sentence per line format for better readability and consistency.

- eSpeak has been updated, adding support for the Karakalpak language.
- Unicode CLDR has also been updated.
+ eSpeak has been updated, adding support for the Karakalpak language.
+ Unicode CLDR has also been updated.

49-49: Ensure consistent capitalization and punctuation.

The term "International phonetic alphabet" should be capitalized, and the entry should end with a period.

- * International phonetic alphabet. (#16773)
+ * International Phonetic Alphabet. (#16773)

source/brailleTables.py Outdated Show resolved Hide resolved
@CyrilleB79
Copy link
Collaborator

Maybe my question is naive.

But why wouldn't a user be able to write IPA braille, e.g. to write the phonetic transcription of a word. Of course, it's quite unlikely that a user writes a long text in IPA. But wouldn't a user want to configure a specific profile to enable only to write phonetic transcriptions?

Cc @josephsl

source/brailleTables.py Outdated Show resolved Hide resolved
user_docs/en/changes.md Outdated Show resolved Hide resolved
user_docs/en/changes.md Outdated Show resolved Hide resolved
seanbudd
seanbudd previously approved these changes Jul 8, 2024
@seanbudd seanbudd added this to the 2024.3 milestone Jul 8, 2024
@seanbudd seanbudd merged commit 73ea664 into nvaccess:beta Jul 8, 2024
1 check was pending
@CyrilleB79
Copy link
Collaborator

But why wouldn't a user be able to write IPA braille, e.g. to write the phonetic transcription of a word. Of course, it's quite unlikely that a user writes a long text in IPA. But wouldn't a user want to configure a specific profile to enable only to write phonetic transcriptions?

@seanbudd, I can see that you have just merged this PR. Would you be able to answer this question? I.e. why not include this table for input?

@zstanecic
Copy link
Contributor Author

Hi @CyrilleB79
The answer is very simple and rational:
some braille systems are too complex for the input , because there can be multiple character definitions in the table, i.e it can be contextual.
It is better to assume it for ipa, unless we get the report from the users that it is safe to do so on the input.
It is best to get this report from somebody who digged deeper into Ipa.
It is the highly specialized thing used in academic environment, so we need to be cautious here.

@CyrilleB79
Copy link
Collaborator

OK @zstanecic. If a specialist need this, they will probably ask it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants