Localyzer Configuration FAQ - Revision history

Olibouban: Olibouban moved page LRM Configuration FAQ to Localyzer Configuration FAQ

2021-11-30T15:22:49Z

Olibouban moved page LRM Configuration FAQ to Localyzer Configuration FAQ

← Older revision	Revision as of 15:22, 30 November 2021
(No difference)

Llawson: /* Sample File */

2019-04-26T20:47:22Z

Sample File

← Older revision		Revision as of 20:47, 26 April 2019
Line 52:		Line 52:
	<group-name>Lingoport</group-name>		<group-name>Lingoport</group-name>
	<top-level-dir>/var/lib/jenkins/jobs/Lingoport.SampleLRM/workspace</top-level-dir>		<top-level-dir>/var/lib/jenkins/jobs/Lingoport.SampleLRM/workspace</top-level-dir>
			<send-unique-file-names>0</send-unique-file-names>
	<detect-errors>		<detect-errors>
	<missed-trans-error>0</missed-trans-error>		<missed-trans-error>0</missed-trans-error>

Llawson: /* Sample File */

2017-06-27T18:49:04Z

Sample File

← Older revision		Revision as of 18:49, 27 June 2017
Line 46:		Line 46:

	<?xml version="1.0" encoding="UTF-8" standalone="no"?>		<?xml version="1.0" encoding="UTF-8" standalone="no"?>
	<~~lrmconf~~>		<lrmprojectdefinition>
	<model-version>3.1.14</model-version>		<model-version>3.1.14</model-version>
	<project-name>SampleLRM</project-name>		<project-name>SampleLRM</project-name>
Line 76:		Line 76:
	</resource-extensions>		</resource-extensions>
	<dirset>		<dirset>
	<include-dir>/</include-dir>		<includes>
			<include-dir-file>/</include-dir-file>
	</includes>		</includes>
	<excludes>		<excludes>
Line 86:		Line 87:
	</excludes>		</excludes>
	</dirset>		</dirset>
	</~~lrmconf~~>		</lrmprojectdefinition>

	</pre>		</pre>


	=== Explanation ===		=== Explanation ===

Olibouban: /* Explanation */

2017-04-20T22:56:58Z

Explanation

← Older revision		Revision as of 22:56, 20 April 2017
Line 125:		Line 125:
	<li> <b>base-file-encoding</b> the encoding of the files to translate</li>		<li> <b>base-file-encoding</b> the encoding of the files to translate</li>
	<li> <b>localized-file-encoding</b> the encoding of the translated files</li>		<li> <b>localized-file-encoding</b> the encoding of the translated files</li>
	<li> <b>parameter-regex-pattern</b> the regexp to determine if a pattern represents a parameter, such as <code>{parameterName}</code> in some frameworks. For more on this, click </li>		<li> <b>parameter-regex-pattern</b> the regexp to determine if a pattern represents a parameter, such as <code>{parameterName}</code> in some frameworks. For more on this, click the [[Parameter Regexp \| Parameter Regex]] page.</li>
	</ul>		</ul>
	<li> <b>dirset</b>: is an Ant like directive to include or exclude directories or files from the kit creation.</li>		<li> <b>dirset</b>: is an Ant like directive to include or exclude directories or files from the kit creation.</li>
	</li>		</li>
	</ul>		</ul>

Olibouban: /* Explanation */

2017-04-20T22:39:31Z

Explanation

← Older revision		Revision as of 22:39, 20 April 2017
Line 125:		Line 125:
	<li> <b>base-file-encoding</b> the encoding of the files to translate</li>		<li> <b>base-file-encoding</b> the encoding of the files to translate</li>
	<li> <b>localized-file-encoding</b> the encoding of the translated files</li>		<li> <b>localized-file-encoding</b> the encoding of the translated files</li>
	<li> <b>parameter-regex-pattern</b> the regexp to determine if		<li> <b>parameter-regex-pattern</b> the regexp to determine if a pattern represents a parameter, such as <code>{parameterName}</code> in some frameworks. For more on this, click </li>
	</ul>		</ul>
	<li> <b>dirset</b>: is an Ant like directive to include or exclude directories or files from the kit creation.</li>		<li> <b>dirset</b>: is an Ant like directive to include or exclude directories or files from the kit creation.</li>
	</li>		</li>
	</ul>		</ul>

Olibouban: /* Explanation */

2017-04-20T22:37:59Z

Explanation

← Older revision		Revision as of 22:37, 20 April 2017
Line 115:		Line 115:
	<li> <b>v</b> is for variant. </li>		<li> <b>v</b> is for variant. </li>
	</ul>		</ul>
	For instance, the file name pattern <code>*_l_c</code> indicates you expect a file sent as		For instance, the file name pattern <code>*_l_c</code> indicates you expect a file sent as <b>resources.properties</b> to be translated in French to <b>resources_fr_FR.properties</b>. </li>
	<b>resources.properties</b> to be translated in French to <b>resources_fr_FR.properties</b>. </li>
	<li> <b>use-pattern-on-dflt-locale</b> set to "1" indicates you will use source files such as		<li> <b>use-pattern-on-dflt-locale</b> set to "1" indicates you will use source files such as
	<b>resources_en_US.properties</b> to be sent for transation. If set to "0", you expect files such		<b>resources_en_US.properties</b> to be sent for transation. If set to "0", you expect files such
Line 123:		Line 122:
	<li> <b>file-location-pattern</b> is used when directories (not file names) are suffixed based		<li> <b>file-location-pattern</b> is used when directories (not file names) are suffixed based
	on a pattern. </li>		on a pattern. </li>
			<li> <b>use-location-pattern-on-dflt-locale</b> in case the directory where the files to be translated are located follows some locale naming convention.</li>
			<li> <b>base-file-encoding</b> the encoding of the files to translate</li>
			<li> <b>localized-file-encoding</b> the encoding of the translated files</li>
			<li> <b>parameter-regex-pattern</b> the regexp to determine if
	</ul>		</ul>
	<li> <b>dirset</b>: is an Ant like directive to include or exclude directories or files from the kit creation.</li>		<li> <b>dirset</b>: is an Ant like directive to include or exclude directories or files from the kit creation.</li>
	</li>		</li>
	</ul>		</ul>

Olibouban: /* Explanation */

2017-04-20T22:15:56Z

Explanation

← Older revision		Revision as of 22:15, 20 April 2017
Line 107:		Line 107:
	<li> <b>default-locale</b>: the locale of the files to be translated</li>		<li> <b>default-locale</b>: the locale of the files to be translated</li>
	<li> <b>resource-extensions</b>: The list of resource extension types to support for this project</li>		<li> <b>resource-extensions</b>: The list of resource extension types to support for this project</li>
	<li> <b>resource-extension</b>: one of the extension type to handle in this project~~</li>.~~		<li> <b>resource-extension</b>: one of the extension type to handle in this project
	<ul> <li> <b>extension</b> one of the supported resource file type, such as properties or resx. </li>		<ul> <li> <b>extension</b> one of the supported resource file type, such as properties or resx. </li>
	<li> <b>file-name-pattern</b> how the locale is added to the file name if the file name reflects the locale. It may not, in which case this element is empty		<li> <b>file-name-pattern</b> how the locale is added to the file name if the file name reflects the locale. It may not, in which case this element is empty
Line 124:		Line 124:
	on a pattern. </li>		on a pattern. </li>
	</ul>		</ul>
	<li> <b>dirset</b>: is an Ant like directive to include or exclude directories or files from the kit creation.		<li> <b>dirset</b>: is an Ant like directive to include or exclude directories or files from the kit creation.</li>
			</li>
	</ul>		</ul>

Olibouban: /* Explanation */

2017-04-20T22:14:57Z

Explanation

← Older revision		Revision as of 22:14, 20 April 2017
Line 106:		Line 106:
	</UL>		</UL>
	<li> <b>default-locale</b>: the locale of the files to be translated</li>		<li> <b>default-locale</b>: the locale of the files to be translated</li>

	<li> <b>resource-extensions</b>: The list of resource extension types to support for this project</li>		<li> <b>resource-extensions</b>: The list of resource extension types to support for this project</li>
	<li> <b>resource-extension</b>: one of the extension type to handle in this project</li>.		<li> <b>resource-extension</b>: one of the extension type to handle in this project</li>.
	<ul>		<ul> <li> <b>extension</b> one of the supported resource file type, such as properties or resx. </li>
	<li> <b>extension</b> one of the supported resource file type, such as properties or resx. </li>
	<li> <b>file-name-pattern</b> how the locale is added to the file name if the file name reflects the locale. It may not, in which case this element is empty		<li> <b>file-name-pattern</b> how the locale is added to the file name if the file name reflects the locale. It may not, in which case this element is empty
	<ul>		<ul>

Olibouban: /* Explanation */

2017-04-20T22:14:26Z

Explanation

← Older revision		Revision as of 22:14, 20 April 2017
Line 119:		Line 119:
	For instance, the file name pattern <code>*_l_c</code> indicates you expect a file sent as		For instance, the file name pattern <code>*_l_c</code> indicates you expect a file sent as
	<b>resources.properties</b> to be translated in French to <b>resources_fr_FR.properties</b>. </li>		<b>resources.properties</b> to be translated in French to <b>resources_fr_FR.properties</b>. </li>

	<li> <b>use-pattern-on-dflt-locale</b> set to "1" indicates you will use source files such as		<li> <b>use-pattern-on-dflt-locale</b> set to "1" indicates you will use source files such as
	<b>resources_en_US.properties</b> to be sent for transation. If set to "0", you expect files such		<b>resources_en_US.properties</b> to be sent for transation. If set to "0", you expect files such

Olibouban: /* Resource Manager Project Creation */

2017-04-20T21:58:14Z

Resource Manager Project Creation

← Older revision		Revision as of 21:58, 20 April 2017
Line 13:		Line 13:
	<code>$LRM_CMD --report --import-issues --project-name project_name <b>-f /tmp</b></code>		<code>$LRM_CMD --report --import-issues --project-name project_name <b>-f /tmp</b></code>

	== Resource Manager Project Creation ==		== Resource Manager Project Creation Commands==
	<b>Note</b>: the following commands are based on an alias for <code>lrm</code> on Linux along those lines:		<b>Note</b>: the following commands are based on an alias for <code>lrm</code> on Linux along those lines:

	alias lrm='java -jar /var/lib/jenkins/lingoport/lrm-server-3.1/lrm-cli.jar'		alias lrm='java -jar /var/lib/jenkins/lingoport/lrm-server-3.1/lrm-cli.jar'

			A project must be created under a licensed group.

	To create a project in LRM, edit a project definition file and run the LRM <code>--create-project</code> command.		To create a project in LRM, edit a project definition file and run the LRM <code>--create-project</code> command.
Line 22:		Line 24:

	To configure the LRM project, type the following command:		To configure the LRM project, type the following command:
	<code>lrm --create-project -f project_definition.xml</code>		<code>lrm --create-project --group-name group_name -f project_definition.xml</code>

	At any point during the process, type for following to check the project definition:		At any point during the process, type for following to check the project definition:
	<code>lrm --~~prep_config~~ --~~dry~~-~~run~~ --project-name project_name </code>		<code>lrm --report --project-inspect --group-name group_name --project-name project_name </code>
	It will create ~~one file~~ per locale ~~under~~ the ~~<code>~~reports~~/project_name</code> directory~~.		It will create a report per locale and echo on the Console the locations of the reports.

	To get a starting <project definition>.xml file for an existing project in the server database, type:		To get a starting <project definition>.xml file for an existing project in the server database, type:
	<code>lrm --export-project --project-name project_name</code>		<code>lrm --export-project --group-name group_name --project-name project_name</code>
	This may come in handy when you want to modify an existing configuration. ~~The resulting xml file is named <TODO><b>SetupKitRootConfig.xml</b> and is located under <b>reports\project_name</b>~~		This may come in handy when you want to modify an existing configuration.

	To update a configuration, download and modify the corresponding xml file and type:		To update a configuration, download and modify the corresponding xml file and type:
	<code> ~~%LRM_CMD%~~ --update-project project_definition.xml</code>		<code> lrm --group-name group_name --update-project -f project_definition.xml</code>

	To see what projects are configured in the Resource Manager, type:		To see what projects are configured in the Resource Manager, type:
	<code>lrm --list-projects</code>		<code>lrm --group-name group_name --list-projects</code>

	~~Once a kit root is configured, kits can be handled by the Resource Manager commands. Most of the daily work with resource files can start now.~~

	== Resource Manager Project Definition ==		== Resource Manager Project Definition ==