Difference between revisions of "Introduction"
(→Rule Sets) |
(→Command Center) |
||
(147 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
+ | = Lingoport - Overview = |
||
− | == About Globalyzer == |
||
+ | Lingoport provides products and services which help our clients continuously meet [https://lingoport.com/what-is-i18n/ internationalization] and ongoing localization challenges relating to software development and active globalization. |
||
− | Learn more [[about Globalyzer]] |
||
+ | For more information about internationalization: https://lingoport.com/what-is-i18n/ |
||
− | == Install == |
||
− | [[Install|Installation protocols]] for [[Install#Windows|Windows]], [[Install#Linux|Linux]] and [[Install#Mac|Mac OS]]. |
||
+ | The Lingoport Products help software engineering teams with the [[Terms_and_Definitions#globalization|globalization]] tasks: |
||
− | == Rule Sets == |
||
+ | * Automatically find and manage [[Terms_and_Definitions#internationalization|internationalization]] issues and [[Terms_and_Definitions#localization|localization]] changes in your source code and [[Terms_and_Definitions#repository|repositories]] for a wide variety of programming languages. |
||
− | Guidelines for creating and managing [[Rules| rule sets]]. |
||
+ | * Integrate with [[Terms_and_Definitions#TMS|translation management systems]] and [[Terms_and_Definitions#localization|localization]] vendors for rapid [[Terms_and_Definitions#globalization|globalization]] development, testing and deployment. |
||
+ | * Verify translations in an efficient, process-driven manner. |
||
+ | * Works behind your firewall keeping your source code secure. |
||
+ | ===Contact Information:=== |
||
− | == Workbench == |
||
+ | Phone: +1 303-444-8020 |
||
− | Further information on the Globalyzer Client aka Globalyzer [[Workbench]] |
||
+ | Email: info at Lingoport.com |
||
− | == Command Line Interface == |
||
− | Guidelines on running the Globalyzer [[Command Line Interface]]. |
||
+ | Lingoport, Inc. |
||
− | ==FAQ== |
||
+ | |||
− | Tips and best practices available at: [[FAQ]] |
||
+ | |||
+ | == Services == |
||
+ | Lingoport has been providing software [http://www.lingoport.com/software-internationalization-services/ internationalization (i18n) consulting services] since the company's inception in 2001. |
||
+ | |||
+ | These services include: |
||
+ | * '''I18n Analysis''' - plan for new i18n projects, or gap analysis for mitigating i18n issues. A Lingoport architect and supporting team members clarify i18n business, technical and resource requirements based on market requirements, development discussions, programming technologies and Globalyzer scanning results. |
||
+ | * '''I18n Implementation''' - Lingoport provides i18n development teams that can work in a hybrid approach, collaborating with client teams, as well as in turnkey fashion. |
||
+ | * '''General i18n Consulting and Custom Projects''' - Sometimes specific problem solving or i18n bug fixing is needed. Lingoport can fulfill that resource need, working in coordination with your teams. |
||
+ | * '''Process Customization''' - Any Lingoport product purchase includes consulting time to customize and optimize the Lingoport product suite for the customer. |
||
+ | |||
+ | == Lingoport Products == |
||
+ | [[File:Lingoport Products Overview.JPG|700px|center]] |
||
+ | |||
+ | The Lingoport products support the continuous globalization process, from the code repository to the translation vendors and back. |
||
+ | |||
+ | '''[[About Globalyzer | Globalyzer]]''' – Supports individuals and entire development teams in finding, fixing and maintaining internationalization issues in code in a broad list of programming languages. (More information at [http://lingoport.com/globalyzer Lingoport.com/Globalyzer]). |
||
+ | |||
+ | '''[[About Localyzer | Localyzer]]''' – Provides simplified resource file management, verification and translation updating. Localyzer helps development and localization teams keep up with initial and ongoing application interface resources, their translation and automated re-insertion into product builds. (More information at [https://lingoport.com/software-internationalization-products/localyzer-localization-automation/ Lingoport.com/Localyzer]). |
||
+ | * '''Machine Translation''' - Lingoport Supports several popular machine translation vendors as part of the continuous globalization and localization process. |
||
+ | ** [https://aws.amazon.com/translate/ AWS Translate] |
||
+ | ** [https://www.systransoft.com/systran/translation-technology/neural-machine-translation-nmt/ Systran] |
||
+ | ** [https://cloud.google.com/translate Google Translate] |
||
+ | ** [https://www.microsoft.com/en-us/translator/ Microsoft Translator] |
||
+ | * '''Translation Management Systems(TMS)''': Lingoport Localyzer is integrated with leading TMS platforms for a fully automated process from code repository to translator and back. |
||
+ | |||
+ | '''[[LocalyzerQA | LocalyzerQA]]''' - A simplified way to perform linguistic review and verify and correct translation issues as part of the continuous globalization process. |
||
+ | |||
+ | '''Express Suite'''- uses the Lingoport software suite and integrates core capabilities with GitHub to bring developers instant access to languages, all integrated with the way they already work. Linguistic review is done in context, for accuracy and application specific terminology. |
||
+ | * [[Globalyzer i18n Express |Globalyzer i18n Express]]- Globalyzer i18n Express is a GitHub application which scans the added and modified files checked in on a GitHub commit, looking for i18n issues. The committed files are scanned with default rule sets. Files checked in will be scanned and a summary will be added as a comment to the commit in GitHub. |
||
+ | * [[Localyzer Express |Localyzer Express]] - Localyzer Express is a GitHub application which allows for a near immediate machine translation of standard application resource files. Resource files are used by internationalized applications to display user facing strings (such as user interface labels) in different locales (languages, country, variant). As an example, messages.properties, an English resource file, can be translated in French and Japanese, respectively messages_fr.properties and messages_ja.properties. |
||
+ | * [[LocalyzerQA | LocalyzerQA]] - A simplified way to perform linguistic review in a running application and verify and correct translation issues as part of the continuous globalization process. When paired with [[Localyzer Express |Localyzer Express]], it allows for an ''always-on'' machine translation followed by linguistic review in the context of the running application. |
||
+ | |||
+ | == Command Center == |
||
+ | |||
+ | [[File:IntroductionSignIn.jpg|600px|center]] |
||
+ | |||
+ | '''Command Center''' is the hub of the Lingoport products. See it all, drill down, create notifications and manage the process. Bridge gaps between localization & development. Increase visibility and track globalization metrics. |
||
+ | |||
+ | With Command Center, Globalyzer and Localyzer projects can be created and managed together with their data source repositories and the translation management systems. It has been designed to make it easy to manage globalization and localization within an organization by administrators, managers, developers and translators. |
||
+ | |||
+ | [[File:CCProjects.jpg|600px|center]] |
||
+ | |||
+ | ==== Additional Specialized Applications ==== |
||
+ | In addition to the product suite, Lingoport has several integrated components to create and maintain software |
||
+ | for any language or cultural format in every release increment : |
||
+ | |||
+ | * '''IDE (Integrated Development Environment) Integration''': Developers can identify and fix globalization and localization issues in real time. |
||
+ | * '''LingoBot''' : Slack and Microsoft Teams system integration |
||
+ | Together with the products and assorted specialized applications, Lingoport enables continuous tracking and updates to the [[Terms_and_Definitions#internationalization|internationalization]] and [[Terms_and_Definitions#localization|localization]] status of software products. |
||
+ | |||
+ | =The Continuous Globalization Process = |
||
+ | |||
+ | * The process starts with the code repository. Developers check in code. |
||
+ | * Command Center is where both Globalyzer and Localyzer application work side by side |
||
+ | ** Globalyzer reports the globalization issues to be corrected in the code. |
||
+ | ** Localyzer is used to: |
||
+ | *** set up the locales to translate to |
||
+ | *** identify the resource file types |
||
+ | *** set up the translation vendor, the TMS (translation management system), or the machine translation engine. |
||
+ | * Globalyzer can be used to create the resource files and push them to the code repository. |
||
+ | * Globalyzer and Localyzer analyses are executed from Command Center. The resource files are identified and what needs to be sent to be translated. If a translation vendor is machine translation, then the Localyzer job automatically does the translation, and pushes the translated files back to the code repository. |
||
+ | * The Command Center Localyzer page has a button to send identified files to the translation vendor. Localyzer automatically checks for returned files, imports them and push the files back to the repository. |
||
+ | * During the Linguistic Review process, LingoportQA uses a special locale with identifier keys that can be used to indicate which terms need to be corrected. LingoportQA submits the change. |
||
+ | ** For machine translation Localyzer projects, the code is fixed and the new strings is pushed to the repo. |
||
+ | ** For TMS projects, an additional approval step is done, the files are imported and pushed to the repo. |
||
+ | |||
+ | =Lingoport Product Details= |
||
+ | ==Globalyzer== |
||
+ | Scans code and detects internationalization (i18n) issues |
||
+ | |||
+ | * Connects to the Globalyzer server and logs in. (This might not happen if local rule sets are used) |
||
+ | * Downloads rule sets from server, or uses local rulesets. |
||
+ | * Uses rule set to scan code. |
||
+ | * Displays the i18n issues. |
||
+ | * Can run on developer machines in an Integrated Development Environment |
||
+ | * Runs on the Continuous Globalization System - these results are displayed on Lingoport Dashboard |
||
+ | |||
+ | Lingoport's Globalyzer scans source code for [[Terms_and_Definitions#internationalization|internationalization]] issues. It uses sets of regular expression based rules [[Terms_and_Definitions#ruleset|('rule sets')]] on tokens found by lexers/parsers to detect these issues and to filter false positives. These rule sets are synced and stored on a single server, and may be downloaded onto numerous client applications which perform the source code scans. Please note that the rule sets are only lists of regular expressions, and do not contain any code. |
||
+ | |||
+ | Client applications include an [[Terms_and_Definitions#IDE|IDE]] tool ([[Terms_and_Definitions#GlobalyzerIDE|"Globalyzer in IDE"]]), a desktop client ([[Terms_and_Definitions#GlobalyzerWorkbench|"Globalyzer Workbench"]]), command line clients ([[Terms_and_Definitions#GlobalyzerCommandLine|"Globalyzer CLI"]] and [[Terms_and_Definitions#GlobalyzerLite|"Globalyzer Lite"]]), and an [[Terms_and_Definitions#GlobalyzerAPI|API]] that may be used to construct custom programs including Globalyzer code scanning functionality. Client applications may produce scan results in XML, CSV, HTML and Excel formats. Results are also consumed by the Lingoport Dashboard to be analyzed and displayed. The desktop client may also be used to view the results directly. It may be used to scan files that developers are working on, and will display the scan results in the IDEs console output window. |
||
+ | |||
+ | <b>Globalyzer Server</b> - allows development teams around the world to share and collaborate together using high powered [[Terms_and_Definitions#internationalization|internationalization]] [[Terms_and_Definitions#ruleset|rule sets]] during scanning of code. Development Teams can set up their own server, or use Lingoport's Globalyzer Server to set up users and rule sets. |
||
+ | |||
+ | <b>Globalyzer Clients</b> |
||
+ | *<b>Globalyzer Lite in IDE</b> - It is ideal for [[Terms_and_Definitions#scan|scanning]] code for internationalization issues on the fly and generating corresponding reports. It does not require an external database. Globalyzer Lite parses and executes Globalyzer Lite Project Definition XML files. Globalyzer Lite in IDE can be incorporated into developers' IDE platforms for a true continuous improvement and development system. |
||
+ | *<b>Globalyzer Workbench</b> - provides a fully functional code analysis and editing environment for finding, fixing, testing and reporting on internationalization issues in a wide variety of programming languages. Globalyzer Workbench runs as a stand-alone desktop editor in an Eclipse Environment. |
||
+ | ** Creates the Project Definition XML files. |
||
+ | ** Sets up the Machine Learning environment. |
||
+ | ** Updates Rule Sets on the server and exports them to the local clients. |
||
+ | ** Creates the resource files to be used by Localyzer . |
||
+ | |||
+ | *<b>Globalyzer Command Line</b> - create automated [[Terms_and_Definitions#scan|Globalyzer scans]] as part of your [[Terms_and_Definitions#ContinuousIntegration|continuous integration]] so that you can report and track internationalization issues over time. There is also a Globalyzer Ant Client, Maven Client and XSL Client. |
||
+ | |||
+ | *<b>Globalyzer API</b> - allows you to create [[Terms_and_Definitions#Globalyzerprojects|Globalyzer projects]] and [[Terms_and_Definitions#scan|scans]], execute scans, and generate reports from a Java program. |
||
+ | |||
+ | ==Localyzer (formerly LRM) == |
||
+ | Localyzer manages [[Terms_and_Definitions#resourcefiles|resource files]], which contain application text as key-value pairs (the keys are used in the application to retrieve the associated text). Resource files are typically translated across languages as part of the [[Terms_and_Definitions#localization|localization]] process. Localyzer is used to determine the translation status of these resource files using a MySQL database. It also automates the process of sending text out to [[Terms_and_Definitions#translationvendor|translation vendors]] when changes are made to be base (usually English) application text. |
||
+ | |||
+ | Localyzer also performs various checks regarding the resource files. These checks include confirmation of file integrity, detection of duplicate or missing keys, and numerous other validations. When a translation vendor returns translated text for these resource files, Localyzer will detect the new content and perform its validations. If the validations pass then Localyzer will merge the new translations into appropriate resource files and check these in to source control. The check-in is typically done on a dedicated localization branch. |
||
+ | |||
+ | ==InContext Translation == |
||
+ | Used by translators, resource files are instrumented as they are sent to [[Terms_and_Definitions#TMS|translation management systems]] so that they can see the string in the application and its context in order to translate more effectively. |
||
+ | |||
+ | ==InContext QA== |
||
+ | The translation reviewer can easily select instrumented resources in an application, identify poor translations, and give suggestions for making improvements. InContext QA greatly improves the translation quality assurance process and can be a vital part of the continuous improvement environment. |
||
+ | |||
+ | ==Lingoport Dashboard== |
||
+ | The Lingoport Dashboard displays the [[Terms_and_Definitions#internationalization|internationalization]] and [[Terms_and_Definitions#localization|localization]] status of software projects. The Lingoport Dashboard scans source code and reads in XML reports generated by Globalyzer and Localyzer. It then sends the information to the web server built on the [[Terms_and_Definitions#SonarQube|SonarQube]] platform and displays the information in an easy to digest fashion. This information includes all detected internationalization issues, which may be viewed in source code - with the affected line(s) highlighted. The translation status, translation history, and current translation efforts for projects are also displayed. |
||
+ | |||
+ | |||
+ | == Services used by Lingoport products == |
||
+ | To check on services used by the Lingoport processes: |
||
+ | *incontext-server.service |
||
+ | *lingoport-lingobot.service |
||
+ | *localyzerqa-server.service |
||
+ | |||
+ | |||
+ | As the sudo user, these can be checked with the command: |
||
+ | sudo systemctl status <service name> |
||
+ | |||
+ | The services can be started with: |
||
+ | sudo systemctl start <service name> |
||
+ | |||
+ | The services can be stopped with: |
||
+ | sudo systemctl stop <service name> |
Latest revision as of 19:15, 19 March 2024
Lingoport - Overview
Lingoport provides products and services which help our clients continuously meet internationalization and ongoing localization challenges relating to software development and active globalization.
For more information about internationalization: https://lingoport.com/what-is-i18n/
The Lingoport Products help software engineering teams with the globalization tasks:
- Automatically find and manage internationalization issues and localization changes in your source code and repositories for a wide variety of programming languages.
- Integrate with translation management systems and localization vendors for rapid globalization development, testing and deployment.
- Verify translations in an efficient, process-driven manner.
- Works behind your firewall keeping your source code secure.
Contact Information:
Phone: +1 303-444-8020
Email: info at Lingoport.com
Lingoport, Inc.
Services
Lingoport has been providing software internationalization (i18n) consulting services since the company's inception in 2001.
These services include:
- I18n Analysis - plan for new i18n projects, or gap analysis for mitigating i18n issues. A Lingoport architect and supporting team members clarify i18n business, technical and resource requirements based on market requirements, development discussions, programming technologies and Globalyzer scanning results.
- I18n Implementation - Lingoport provides i18n development teams that can work in a hybrid approach, collaborating with client teams, as well as in turnkey fashion.
- General i18n Consulting and Custom Projects - Sometimes specific problem solving or i18n bug fixing is needed. Lingoport can fulfill that resource need, working in coordination with your teams.
- Process Customization - Any Lingoport product purchase includes consulting time to customize and optimize the Lingoport product suite for the customer.
Lingoport Products
The Lingoport products support the continuous globalization process, from the code repository to the translation vendors and back.
Globalyzer – Supports individuals and entire development teams in finding, fixing and maintaining internationalization issues in code in a broad list of programming languages. (More information at Lingoport.com/Globalyzer).
Localyzer – Provides simplified resource file management, verification and translation updating. Localyzer helps development and localization teams keep up with initial and ongoing application interface resources, their translation and automated re-insertion into product builds. (More information at Lingoport.com/Localyzer).
- Machine Translation - Lingoport Supports several popular machine translation vendors as part of the continuous globalization and localization process.
- Translation Management Systems(TMS): Lingoport Localyzer is integrated with leading TMS platforms for a fully automated process from code repository to translator and back.
LocalyzerQA - A simplified way to perform linguistic review and verify and correct translation issues as part of the continuous globalization process.
Express Suite- uses the Lingoport software suite and integrates core capabilities with GitHub to bring developers instant access to languages, all integrated with the way they already work. Linguistic review is done in context, for accuracy and application specific terminology.
- Globalyzer i18n Express- Globalyzer i18n Express is a GitHub application which scans the added and modified files checked in on a GitHub commit, looking for i18n issues. The committed files are scanned with default rule sets. Files checked in will be scanned and a summary will be added as a comment to the commit in GitHub.
- Localyzer Express - Localyzer Express is a GitHub application which allows for a near immediate machine translation of standard application resource files. Resource files are used by internationalized applications to display user facing strings (such as user interface labels) in different locales (languages, country, variant). As an example, messages.properties, an English resource file, can be translated in French and Japanese, respectively messages_fr.properties and messages_ja.properties.
- LocalyzerQA - A simplified way to perform linguistic review in a running application and verify and correct translation issues as part of the continuous globalization process. When paired with Localyzer Express, it allows for an always-on machine translation followed by linguistic review in the context of the running application.
Command Center
Command Center is the hub of the Lingoport products. See it all, drill down, create notifications and manage the process. Bridge gaps between localization & development. Increase visibility and track globalization metrics.
With Command Center, Globalyzer and Localyzer projects can be created and managed together with their data source repositories and the translation management systems. It has been designed to make it easy to manage globalization and localization within an organization by administrators, managers, developers and translators.
Additional Specialized Applications
In addition to the product suite, Lingoport has several integrated components to create and maintain software for any language or cultural format in every release increment :
- IDE (Integrated Development Environment) Integration: Developers can identify and fix globalization and localization issues in real time.
- LingoBot : Slack and Microsoft Teams system integration
Together with the products and assorted specialized applications, Lingoport enables continuous tracking and updates to the internationalization and localization status of software products.
The Continuous Globalization Process
- The process starts with the code repository. Developers check in code.
- Command Center is where both Globalyzer and Localyzer application work side by side
- Globalyzer reports the globalization issues to be corrected in the code.
- Localyzer is used to:
- set up the locales to translate to
- identify the resource file types
- set up the translation vendor, the TMS (translation management system), or the machine translation engine.
- Globalyzer can be used to create the resource files and push them to the code repository.
- Globalyzer and Localyzer analyses are executed from Command Center. The resource files are identified and what needs to be sent to be translated. If a translation vendor is machine translation, then the Localyzer job automatically does the translation, and pushes the translated files back to the code repository.
- The Command Center Localyzer page has a button to send identified files to the translation vendor. Localyzer automatically checks for returned files, imports them and push the files back to the repository.
- During the Linguistic Review process, LingoportQA uses a special locale with identifier keys that can be used to indicate which terms need to be corrected. LingoportQA submits the change.
- For machine translation Localyzer projects, the code is fixed and the new strings is pushed to the repo.
- For TMS projects, an additional approval step is done, the files are imported and pushed to the repo.
Lingoport Product Details
Globalyzer
Scans code and detects internationalization (i18n) issues
- Connects to the Globalyzer server and logs in. (This might not happen if local rule sets are used)
- Downloads rule sets from server, or uses local rulesets.
- Uses rule set to scan code.
- Displays the i18n issues.
- Can run on developer machines in an Integrated Development Environment
- Runs on the Continuous Globalization System - these results are displayed on Lingoport Dashboard
Lingoport's Globalyzer scans source code for internationalization issues. It uses sets of regular expression based rules ('rule sets') on tokens found by lexers/parsers to detect these issues and to filter false positives. These rule sets are synced and stored on a single server, and may be downloaded onto numerous client applications which perform the source code scans. Please note that the rule sets are only lists of regular expressions, and do not contain any code.
Client applications include an IDE tool ("Globalyzer in IDE"), a desktop client ("Globalyzer Workbench"), command line clients ("Globalyzer CLI" and "Globalyzer Lite"), and an API that may be used to construct custom programs including Globalyzer code scanning functionality. Client applications may produce scan results in XML, CSV, HTML and Excel formats. Results are also consumed by the Lingoport Dashboard to be analyzed and displayed. The desktop client may also be used to view the results directly. It may be used to scan files that developers are working on, and will display the scan results in the IDEs console output window.
Globalyzer Server - allows development teams around the world to share and collaborate together using high powered internationalization rule sets during scanning of code. Development Teams can set up their own server, or use Lingoport's Globalyzer Server to set up users and rule sets.
Globalyzer Clients
- Globalyzer Lite in IDE - It is ideal for scanning code for internationalization issues on the fly and generating corresponding reports. It does not require an external database. Globalyzer Lite parses and executes Globalyzer Lite Project Definition XML files. Globalyzer Lite in IDE can be incorporated into developers' IDE platforms for a true continuous improvement and development system.
- Globalyzer Workbench - provides a fully functional code analysis and editing environment for finding, fixing, testing and reporting on internationalization issues in a wide variety of programming languages. Globalyzer Workbench runs as a stand-alone desktop editor in an Eclipse Environment.
- Creates the Project Definition XML files.
- Sets up the Machine Learning environment.
- Updates Rule Sets on the server and exports them to the local clients.
- Creates the resource files to be used by Localyzer .
- Globalyzer Command Line - create automated Globalyzer scans as part of your continuous integration so that you can report and track internationalization issues over time. There is also a Globalyzer Ant Client, Maven Client and XSL Client.
- Globalyzer API - allows you to create Globalyzer projects and scans, execute scans, and generate reports from a Java program.
Localyzer (formerly LRM)
Localyzer manages resource files, which contain application text as key-value pairs (the keys are used in the application to retrieve the associated text). Resource files are typically translated across languages as part of the localization process. Localyzer is used to determine the translation status of these resource files using a MySQL database. It also automates the process of sending text out to translation vendors when changes are made to be base (usually English) application text.
Localyzer also performs various checks regarding the resource files. These checks include confirmation of file integrity, detection of duplicate or missing keys, and numerous other validations. When a translation vendor returns translated text for these resource files, Localyzer will detect the new content and perform its validations. If the validations pass then Localyzer will merge the new translations into appropriate resource files and check these in to source control. The check-in is typically done on a dedicated localization branch.
InContext Translation
Used by translators, resource files are instrumented as they are sent to translation management systems so that they can see the string in the application and its context in order to translate more effectively.
InContext QA
The translation reviewer can easily select instrumented resources in an application, identify poor translations, and give suggestions for making improvements. InContext QA greatly improves the translation quality assurance process and can be a vital part of the continuous improvement environment.
Lingoport Dashboard
The Lingoport Dashboard displays the internationalization and localization status of software projects. The Lingoport Dashboard scans source code and reads in XML reports generated by Globalyzer and Localyzer. It then sends the information to the web server built on the SonarQube platform and displays the information in an easy to digest fashion. This information includes all detected internationalization issues, which may be viewed in source code - with the affected line(s) highlighted. The translation status, translation history, and current translation efforts for projects are also displayed.
Services used by Lingoport products
To check on services used by the Lingoport processes:
- incontext-server.service
- lingoport-lingobot.service
- localyzerqa-server.service
As the sudo user, these can be checked with the command:
sudo systemctl status <service name>
The services can be started with:
sudo systemctl start <service name>
The services can be stopped with:
sudo systemctl stop <service name>