Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tsvetomir/xlf-extract
Extract source messages from XLIFF (.XLF) files and stores them in YAML files for translation
https://github.com/tsvetomir/xlf-extract
Last synced: about 1 month ago
JSON representation
Extract source messages from XLIFF (.XLF) files and stores them in YAML files for translation
- Host: GitHub
- URL: https://github.com/tsvetomir/xlf-extract
- Owner: tsvetomir
- License: bsd-3-clause
- Created: 2017-02-08T22:59:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-21T10:08:16.000Z (over 5 years ago)
- Last Synced: 2024-09-25T04:59:42.756Z (about 2 months ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/tsvetomir/xlf-extract)
[](https://badge.fury.io/js/xlf-extract)
# xlf-extract
Extracts source messages from XLIFF (.xlf) files into a translation bundle. This is a simple YAML file that can be copied and translated for different locales.
The translated messages can be populated back into the XLIFF files using [xlf-translate](https://www.npmjs.com/package/xlf-translate).
These tools are intended to simplify the localization of [Angular 2 i18n](https://angular.io/docs/ts/latest/cookbook/i18n.html) - enabled apps.
In Angular 2 each change in the application may alter the unit IDs in the message file. Normally, you'd have to track each unit and update its translation.
With this set of tools the correct translations can be filled-in automatically from the YAML message bundles based on your unique keys.
See the [sample i18n Angular app](https://github.com/tsvetomir/angular-cli-i18n-sample) for more details.
## Installation
`npm install -g xlf-extract`
## Usage
`xlf-extract messages.xlf --lang-file=lang/en.yml`
This will extract all source elements from the `messages.xlf` file into the language file.
Optionally, specify `--use-target` to extract the `target` (translated) messages:
`xlf-extract --use-target messages.xlf --lang-file=lang/en.yml`
## Description
Normally, you'd localize an attribute using the following syntax:
```html
Hello!
```
This utility makes use of the optional meaning tag to associate the message with an unique key.
```html
Hello!
```
The key will be persisted in the messages file as a "meaning":
```xml
Hello!
A hello world message for the localized component
localized.component.hello
```
This utility will extract the source messages along with descriptions into a message bundle. This file is then copied and translated for different locales.
The message bundle is an YAML file that lists all messages as a tree. For example, the `localized.component.hello` key and its translation are represented as:
```yaml
localized:
component:
# A hello world message for the localized component
hello: Bonjour!
```
To populate the message file with the translations from the message bundle, use the [xlf-translate companion tool](https://www.npmjs.com/package/xlf-translate).
## See Also
* [xlf-translate companion tool](https://www.npmjs.com/package/xlf-translate)
* [Sample usage in an i18n Angular app](https://github.com/tsvetomir/angular-cli-i18n-sample)
* [Angular 2 - Internationalization (i18n)](https://angular.io/docs/ts/latest/cookbook/i18n.html)
* [Deploying an i18n Angular app with angular-cli](https://medium.com/@feloy/deploying-an-i18n-angular-app-with-angular-cli-fc788f17e358#.2qlq8lfad)