LRM strings Support
Contents
Example .strings file
/* Class = "IBUILabel"; text = "or"; ObjectID = "DTz-P6-Y3D"; */ "DTz-P6-Y3D.text" = "or"; /* Class = "IBUITextField"; placeholder = "Username"; ObjectID = "FiC-Ph-wbo"; */ "FiC-Ph-wbo.placeholder" = "Username"; /* Class = "IBUILabel"; text = "The username or password was incorrect."; ObjectID = "tDx-oc-GBE"; */ "tDx-oc-GBE.text" = "The username or \"password\" was incorrect.";
strings parser type
valid IOS .strings syntax
Files that use the strings parser are expected to have valid IOS .strings syntax
.strings uses the strings parser type
When defining a project containing LRM Standard .strings resource files, there is no need to define a <parser-type> as the strings parser will always be used.
unique file extension needs to define strings parser type
If a unique file extension is a valid .strings file, then the <parser-type> should be strings in the project definition file.
Missed Translations for new files
By default, LRM will ignore missed translations; text that is the same in both the base resource file and the target resource file. The exception is for a new IOS file; a file that has never been processed by LRM. Typically, when a new IOS base resource file is created, the subsequent target locale files are also created. This means that the target file exists but contains text of the base locale rather than the target locale. In this case, for IOS files, if the file has not been processed by LRM, then any missed translation will be contained in the next prep kit. Once the file has been processed by LRM, any new missed translations will be ignored.
Regular Expression
When working with and IOS resource file .strings format, the default parameter regex setting will be the following:
%([dsf]|(d$[dsf@])|(.df)|@)|%\{w+\}
This will handle most use cases correctly. However, if the TMS being used is XTM, please consider that XTM will automatically append an integer to the parameters in the returned translations if there currently is not one present in the base resource file. For details on this, please refer to the section :
As noted in the XTM Cloud Special Instructions, the correct course to handle this is to modify the base resource file so that it has the integers already applied in the parameter(s). At that point the returned translations will be allowed to import without causing a parameter mismatch error due to XTM modifying the parameter automatically.
There is one additional change that should be made to the parameter regex setting in order to pull this all together. Modify the parameter regex in the project from the default to the below:
(%([dsf]|(\d+\$[dsf@])|(\.\d+f)|@))|%\{\w+\}
This change will take into account the possibility of there being an integer in the parameter as would be added by XTM so that the source and translations containing the XTM parameter with the integer will be correctly identified as a parameter by Localyzer allowing it to correctly validate parameter mismatches.
Failure to make this change after both the base resource and translations have incorporated the additional integer within their respective parameter(s) will result in the inability to detect a legitimate parameter mismatch for these specific parameters as Localyzer will no longer see them as parameters and simply allow them to pass as normal strings. This results in not having the benefit of parameter mismatch checking for those specific parameters.
Bad IOS comments don't cause any errors. Why not?
If an IOS file has a comment that is not ended properly, no error is thrown. For example, if a comment doesn't have an ending */, such as /*Bad comment, then no errors are found. In other words, the file is still parsed correctly even though the comment is missing the ending syntax. Since the file is parsed correctly, LRM is able to find the key/values.
Command Center Configuration
<TO_DO>
Internal Example of Project Definition for Resources
This section is for internal checking only, not for Command Center.
The following is an example of strings resource file definitions. See resource extensions for more information.
<resource-extensions>
<resource-extension>
<!-- parser-type not needed since .strings is a standard LRM extension that maps to the strings parser type -->
<extension>strings</extension>
<file-name-pattern/>
<use-pattern-on-dflt-locale>1</use-pattern-on-dflt-locale>
<file-location-pattern>l_c_v</file-location-pattern>
<use-location-pattern-on-dflt-locale>1</use-location-pattern-on-dflt-locale>
<base-file-encoding>UTF-8</base-file-encoding>
<localized-file-encoding>UTF-8</localized-file-encoding>
<parameter-regex-pattern><![CDATA[(%([dsf]|(\d+\$[dsf@])|(\.\d+f)|@))|%\{\w+\}]]></parameter-regex-pattern>
</resource-extension>
<resource-extension>
<!-- parser-type is required because .myext is not a standard LRM extension -->
<extension>myext</extension>
<parser-type>strings</parser-type>
<file-name-pattern/>
<use-pattern-on-dflt-locale>1</use-pattern-on-dflt-locale>
<file-location-pattern>l_c_v</file-location-pattern>
<use-location-pattern-on-dflt-locale>1</use-location-pattern-on-dflt-locale>
<base-file-encoding>UTF-8</base-file-encoding>
<localized-file-encoding>UTF-8</localized-file-encoding>
<parameter-regex-pattern><![CDATA[(%([dsf]|(\d+\$[dsf@])|(\.\d+f)|@))|%\{\w+\}]]></parameter-regex-pattern>
</resource-extension>
</resource-extensions>