How shoralbrt/transliterator works
Transliterator converts vocalised Arabic into Cyrillic or academic Latin through a segment-based tajweed pipeline; the same core serves the browser and CLI. The browser also supports corpus surahs, reading settings, editable profiles, localization, and feedback. The excerpts show the core processing stages and some service wiring; other browser and CLI capabilities are included where the README documents them, so their internal connections are not inferred beyond that evidence.
Main entry points: RulesService.cs Tajweed orchestration · TransliterationService.cs Transliteration service · Program.cs Web application · UserProfileRepository.cs User profile repository
Components 27
User interfaces
- Web application
Transliterator.Web/Program.cs - Browser page
Transliterator.Web/wwwroot/js/page.js - CLI application
Transliterator.Cli/CliApp.cs
Transliteration pipeline
- Orthography normalization
Transliterator.Core/Services/Phonology/ArabicNormalizer.cs - Arabic segment parser
Transliterator.Core/Services/Phonology/ArabicParser.cs - Phonological segments
Transliterator.Domain/Phonology/Segment.cs - Tajweed orchestration
Transliterator.Core/Services/Rules/RulesService.cs - Pause and wasl
Transliterator.Core/Services/Rules/WaqfRule.cs - Article assimilation
Transliterator.Core/Services/Rules/ArticleRule.cs - Consonant assimilation
Transliterator.Core/Services/Rules/AssimilationRule.cs - Nasal rules
Transliterator.Core/Services/Rules/NasalRule.cs - Emphasis rules
Transliterator.Core/Services/Rules/EmphasisRule.cs - Madd rules
Transliterator.Core/Services/Rules/MaddRule.cs - Qalqalah rules
Transliterator.Core/Services/Rules/QalqalahRule.cs - Profile renderer
Transliterator.Core/Services/Phonology/CyrillicRenderer.cs - Transliteration service
Transliterator.Core/Services/TransliterationService.cs - Reading options
Transliterator.Domain/Phonology/ReadingOptions.cs
Profiles and corpus
- User profile repository
Transliterator.Core/Repositories/UserProfileRepository.cs - Built-in profiles
Transliterator.Core/Repositories/EmbeddedProfileRepository.cs - Surah corpus
Transliterator.Core/Repositories/EmbeddedCorpusRepository.cs - Browser local storage
Transliterator.Web/Storage/LocalStorageStore.cs - Profile editor
Transliterator.Core/Services/ProfileEditor.cs
Browser features
- Settings panels
Transliterator.Core/Services/PagePanels.cs - Feedback client
Transliterator.Core/Services/FeedbackClient.cs - Feedback worker
feedback-worker/src/feedback.js
Other components
- User
- GitHub issues
Connections 31
- User → Browser page: enters text
README.md - Web application → Transliteration service: registers service
Transliterator.Web/Program.cs - Browser page → Transliteration service: requests transliteration
README.md - User → CLI application: provides input
README.md - CLI application → Transliteration service: requests transliteration
Transliterator.Cli/CliServices.cs - Transliteration service → User profile repository: loads profile
Transliterator.Core/Services/TransliterationService.cs - Transliteration service → Orthography normalization: normalizes text
Transliterator.Core/Services/TransliterationService.cs - Transliteration service → Arabic segment parser: parses text
Transliterator.Core/Services/TransliterationService.cs - Arabic segment parser → Phonological segments: creates segments
Transliterator.Core/Services/Phonology/ArabicParser.cs - Transliteration service → Tajweed orchestration: applies rules
Transliterator.Core/Services/TransliterationService.cs - Tajweed orchestration → Pause and wasl: applies first
Transliterator.Core/Services/Rules/RulesService.cs - Tajweed orchestration → Article assimilation: applies
Transliterator.Core/Services/Rules/RulesService.cs - Tajweed orchestration → Consonant assimilation: applies
Transliterator.Core/Services/Rules/RulesService.cs - Tajweed orchestration → Nasal rules: applies
Transliterator.Core/Services/Rules/RulesService.cs - Tajweed orchestration → Emphasis rules: applies
Transliterator.Core/Services/Rules/RulesService.cs - Tajweed orchestration → Madd rules: applies
Transliterator.Core/Services/Rules/RulesService.cs - Tajweed orchestration → Qalqalah rules: applies
Transliterator.Core/Services/Rules/RulesService.cs - Transliteration service → Profile renderer: renders segments
Transliterator.Core/Services/TransliterationService.cs - Profile renderer → User profile repository: uses profile
README.md - User → Surah corpus: chooses surah
README.md - Web application → Surah corpus: registers repository
Transliterator.Web/Program.cs - Web application → User profile repository: registers repository
Transliterator.Web/Program.cs - User profile repository → Built-in profiles: loads built-ins
Transliterator.Core/Repositories/UserProfileRepository.cs - User profile repository → Browser local storage: reads and writes
Transliterator.Web/Program.cs - Web application → Profile editor: registers editor
Transliterator.Web/Program.cs - User → Settings panels: sets reading options
README.md - Web application → Settings panels: registers panel service
Transliterator.Web/Program.cs - User → Feedback client: sends feedback
README.md - Feedback client → Feedback worker: submits message
README.md - Feedback worker → GitHub issues: opens issue
README.md - Feedback client → GitHub issues: opens fallback form
README.md