Intro
Tlumach.NET is a flexible library that provides translation and localization support to all kinds of .NET applications: from desktop WinForms, WPF, UWP, WinUI, and console to mobile MAUI and Avalonia to server Razor and Blazor.
Table of Contents
- Configuration Files: Structure and format of a configuration file
- Translation Files and Formats: Everything related to translation files, their formats, and supported locations
- Strings and Translations: Everything about the fundamentals - text strings and translation units
- Templates and Placeholders: What are templated translation units and how to use placeholders in translation units efficiently
- Generator: What Generator is and when you use it
- Language management: How to list and switch languages
- Integration with XAML: Binding of XAML elements to generated translation units for automatic updates of the UI
- Dependency Injection: Using Tlumach via Dependency Injection in modern .NET versions
- Glossary: The list of most frequent terms in this documentation
The Ways to Use Tlumach
Tlumach can be used in different ways depending on your application type and the way the localized text is to be used:
- XAML-based desktop and mobile .NET applications, use in XAML UIs. You can bind XAML attributes to translation units as shown below. This way, when the language is switched in the translation manager, UI elements get updated automatically.
- Websites and Web, console, and server applications which output the text from code or web files, as well as WinForms applications. There, you can access generated TranslationUnit instances in code to pick the text for current or specific locale. The use of generated TranslationUnit objects ensures that there is no mistake made when referencing the text.
- Any application. The basic way to access translations is to create and use an instance of the TranslationManager class to retrieve specific translation units by key (a simple string). This class is always available and used internally by TranslationUnit objects.
Each of the ways is documented below.
Getting Started
It is a good idea to check [out] the samples that can be found in Tlumach repository on GitHub before proceeding with the below instructions.
Choose the desired way of using Tlumach to read specific Getting Started instructions:
- Getting Started for integration with WPF
- Getting Started for integration with UWP
- Getting Started for integration with WinUI
- Getting Started for integration with MAUI
- Getting Started for integration with Avalonia
- Getting Started for work with generated translation units (recommended for web, server, and console applications, as well as WinForms applications)
- Getting Started for work via Dependency Injection
- Getting Started for work via TranslationManager (for fine control over the process and for creating translation tools)