Table of Contents

Namespace Tlumach.Base

Classes

ArbParser

A parser for files in Arb format (JSON with extra features).

ArbPlaceholder

This class is used for internal needs. Applications work with Placeholder class instances instead.

BaseGenerator

Includes core functions that generate the C# source code.

BaseJsonParser

The base parser for JSON-formatted configuration and translation files.

BaseKeyValueParser

The base parser for key-value configuration and translation files (ini and toml).

BaseParser
BaseTableParser

The base class for CSV and TSV parsers.

BaseTranslationManager

The base class shared between the main class hierarchy and Generator.

BaseXMLParser
CsvParser
CultureNameMatchEventArgs
FileFormats
GenericParserException
HierarchicalKeyComparer
IniParser

The parser for simple ini-style translation files.

JsonParser

The parser for simpler JSON translation files.

KeyIndex
KeyLocation

The holder for information about where the keys are located in the source files. Unfortunately, this works only for key=value and table formats for now.

ParserConfigException
ParserFileException
ParserLoadException
Placeholder

Represents a single placeholder within a templated entry.

ResxParser
StringCatParser

Parser for Apple String Catalog files (.xcstrings). A single .xcstrings file contains translations for all locales in the format: strings → key → localizations → lang → stringUnit → value.

TemplateParserException
TemplateProcessingException

This exception gets thrown when an error occurs when processing a translation unit that is a template and inserting values into this template.

TextFileParseException
TextParseException
TlumachException
TomlParser

The parser for TOML translation files.

Translation

Contains translation entries that belong to one locale. Each entry is identified by the unique key, which is composed of the key name and the names of all its parent group names joined by dot ".", e.g., "group.subgroup.key". Key names are stored without case conversion but are searched for in a case-insensitive manner.

TranslationConfiguration

Contains the configuration built when parsing source files and passed to the translation manager by the translation unit.

TranslationEntry

Represents an entry in the translation file. An entry may have a value (some text in a specific language) or be a reference to an external file with a translation.

Instances of this class are always owned by a dictionary which keeps the keys, and that dictionary is transferred in a way that specifies the locale. For this reason, TranslationEntry does not hold a key or locale ID.

TranslationTree

Contains translation entries that belong to one locale as a tree.

This class is for internal use and for parsers from other formats.

.
TranslationTreeLeaf

Contains one translation entry in the tree.

This class is for internal use and for parsers from other formats.

.
TranslationTreeNode

Contains a group of translation entries in the tree.

This class is for internal use and for parsers from other formats.

.
TsvParser
Utils

Contains helper functions, usable across the library.

XliffParser

Parser for XLIFF 2.2 (eXtensible Localization Interchange File Format). XLIFF is a bitext format that combines source and target translations in a single file.

Enums

TextFormat

Specifies how the library should deal with translation entries which may support placeholders or reserved characters.