vativeApps Localisation Extension Documentation

Note: The vativeApps Localisation extension is designed for the exclusive use of employees within the vativeApps Organization. It is tailored to meet the specific requirements of vativeApps projects and may not adhere to standard localization practices.

This extension is optimized for internal projects and may not be suitable for all types of projects or general use. It follows vativeApps' unique workflow and may not conform to widely accepted localization methodologies.

Before using this extension for projects outside the vativeApps Organization, please ensure that it aligns with your project's specific requirements and localization practices. Be aware that its functionality may not be applicable to all scenarios.

For questions, feedback, or inquiries regarding this extension's usage, please contact the vativeApps support team.

Compatibility

The vativeApps Localisation extension is designed for use with Flutter projects. It is optimized to enhance the localization workflow within the Flutter framework.

Key Points:

• Flutter Projects: This extension is tailored to meet the localization needs of Flutter app development.

• Flutter Compatibility: It is compatible with Flutter projects and integrates seamlessly with Flutter's internationalization and localization features.

While this extension may work with other project types, its features and functionality have been primarily developed to support Flutter app development. Users are encouraged to consider their specific project requirements when using this extension.

For assistance with integrating this extension into your Flutter projects, refer to the Usage section of this documentation.

Table of Contents

• Overview
• Installation
• Usage
  • Assigning Localisation Folder
  • Generating a Language File
  • Adding a String to Localization
  • Analyzing a Folder for Strings
  • Translate Language
• Important Considerations
• Configuration
• Keyboard Shortcuts

Overview

The vativeApps Localisation extension for Visual Studio Code simplifies the process of managing localization strings in your project. With this extension, you can easily add new strings to your localization files, generate language files, and analyze your project folders for untranslated strings.

Installation

To install the vativeApps Localisation extension, follow these steps:

1. Launch Visual Studio Code.
2. Open the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window.
3. Search for "vativeApps Localisation" in the Extensions view search box.
4. Click the "Install" button next to the extension offered by vativeApps.
5. Once the extension is installed, you can access its features.

Usage

Assigning Localisation Folder

The script requires a localisation folder assigned where it can generate required wrappers to manage multiple languages.

1. Create a "localisation" folder in your 'lib' folder.
2. Right-click on the newly created folder and choose "Make this localisation folder" from the context menu.
3. You will be prompted to confirm the localisation folder's location. You can also change the path if needed.
4. The script will generate required files and you can now generate languages, analyse and add localisation.

Generating a Language File

To generate a language file, follow these steps:

1. Right-click on a folder in your project to create the language file.
2. Choose "Generate Language File" from the context menu.
3. Enter the language name and language code.
4. A language file with the specified name will be created in the localisation folder.

Adding a String to Localization

To add a string to localization, follow these steps:

1. Select the text you want to add to localization.
2. Right-click on the selected text.
3. Choose "Add to Localisation" from the context menu.
4. Enter a key name for the selected text.
5. The selected text will be added to your localization files with the provided key.

Analyzing a Folder for Strings

To analyze a folder for untranslated strings, follow these steps:

1. Right-click on a folder in your project.
2. Choose "Analyze Folder for Strings" from the context menu.
3. Untranslated strings within the selected folder and its subfolders will be displayed.

Translate Language

The "Translate Language" feature allows you to translate the content of a language file into specified language. To translate a language file:

1. Right-click on the language file you want to translate.
2. Select "Translate Language" from the context menu.
3. The extension will translate the content of the language file and update it with the translated strings.

Important Considerations

• Organization-Specific: This extension is designed specifically for use by employees of vativeApps and is optimized for Flutter projects. It may not conform to standard practices and may have organization-specific requirements.

• Flutter Projects: The extension is best suited for Flutter projects and assumes a specific project structure.

• Persistence of Language: When changing the application's language using setLanguage, remember to store the selected language code persistently. On application startup, retrieve the stored language code and call setLanguage to ensure the language change is maintained across sessions.

Configuration

The vativeApps Localisation extension can be configured using the following settings:

• localizationFolderPath: The path to the localization folder in your project. This setting allows you to specify the location of your localization files.

Keyboard Shortcuts

You can set up keyboard shortcuts to quickly access the extension's functionality. By default, the extension provides the following keyboard shortcuts:

• Ctrl+T: Shortcut for "Add to Localisation"

You can customize these shortcuts by editing your Visual Studio Code keybindings settings.

Feedback and Contributions

We welcome feedback and contributions from vativeApps employees to enhance this extension. Please get in touch with the vativeApps team for collaboration and improvements.

This documentation provides an overview of the vativeApps Localisation extension and how to use it. If you have any questions, feedback, or encounter issues, please feel free to reach out to us.

Enjoy using the vativeApps Localisation extension, and may it simplify your localization workflow!