TranslationFileReader is a VS Code extension that automatically inserts translations from XLIFF files as code comments into your AL files.
It helps Business Central developers and localization teams to quickly and accurately comment and review their multilingual extensions.
Getting Started
Folder / File Processing
If you want to process an entire folder, you can do so via the corresponding setting. Simply enter the path to the desired folder. (The tool will process it recursively.)
If, on the other hand, you only want to process a single file, please open the respective .al file directly in Visual Studio Code.
Lang Keys and XLF Paths
Next, it is important that you specify the language keys. These must be specified in the same order in which the XLF files are integrated.
This means: If, for example, the German XLF file is listed first, enter DEU first in the settings. For each additional existing XLF file, enter the corresponding language key in the appropriate order.
2.1 Select the XLF Paths
Here you can select the XLF paths one or more as described above you must then adjust the langkeys so that the correct translation is used for the translation the xlf that is set first is also in the .al later in the first place
Important:
The language keys (Lang Keys) and the XLF paths are currently not arranged one below the other in the settings. This function is still being worked on and was not initially the focus of development.
Log
If you need a log to track what exactly has been translated, you can activate this setting. The tool then logs all translations carried out and makes the information available for analysis.
You have three options for logging translations:
always - The log is saved automatically with every run. Enter a storage path for this under Log Storage Path. All logs are saved in this folder.
ask - At the end of processing, the tool asks whether the log should be saved. You can then decide individually.
never - No log is saved.
Running the TranslationFileReader
To run the TranslationFileReader, open the command palette in Visual Studio Code. To do this, click in the search bar and press > or use the key combination Ctrl + P (or Cmd + P on macOS) to open the menu.
A selection window appears with the available commands for the extension. Select the desired command to start the translation process.
execution options and progress bar
After starting the extension, you have two options for executing the TranslationFileReader:
Folder - Starts the processing of an entire folder.
Current File - Starts the processing of the currently opened .al file.
Status display:
The current status is displayed at the bottom left of Visual Studio Code:
Whether the translation is started,
in progress or
completed.
In addition, a 0-100 % progress indicator appears, which shows the current processing status.
Note on performance:
Processing multiple files can take up to 30 seconds per file, depending on their size. We are currently working on optimizing the speed, it has not been the main focus of development so far.
Tip:
If you set log creation to "never", this can slightly improve the execution speed.
Contribute
Even without a public repository, we welcome feedback:
Bugs & Feature Requests
Just send us an e-mail to
adriano.stipanovic@biteam.com
and briefly describe what is not working or what you would like to see as a new feature.
General questions
For questions about using the extension, you can also reach us at
adriano.stipanovic@biteam.com.
Thank you for your feedback - this way we can continuously improve TranslationFileReader!
