Translations - Versijų istorija

Tilalilalou: /* On server side (PHP) */

2013-05-21T21:36:02Z

On server side (PHP)

← Ankstesnė versija		23:36, 21 gegužės 2013 versija
124 eilutė:		124 eilutė:
	<pre>		<pre>
	// This will display a translatable red message to the player that just do some wrong action:		// This will display a translatable red message to the player that just do some wrong action:
	throw new ~~feException~~( self::_('You must choose 3 cards')~~, true~~);		throw new BgaUserException( self::_('You must choose 3 cards') );

	// ... notice the use of ~~"true" parameter~~ that ~~signal~~ that this exception is "expected". In theory, all exception that are ~~excepted~~ should be translated.		// ... notice the use of BgaUserException that signals that this exception is "expected". In theory, all exception that are expected should be translated.
	</pre>		</pre>

139 eilutė:		139 eilutė:
	<pre>		<pre>
	// In material.inc.php, $this->energies[n]['nametr'] has been created with the self::_() method. This we can do this:		// In material.inc.php, $this->energies[n]['nametr'] has been created with the self::_() method. This we can do this:
	throw new ~~feException~~( self::_("To execute this action you need more: ").' '.$this->energies[$resource_id]['nametr']~~, true~~ );		throw new BgaUserException( self::_("To execute this action you need more: ").' '.$this->energies[$resource_id]['nametr'] );
	</pre>		</pre>

Een: /* On client side (Javascript) */

2013-05-10T19:54:03Z

On client side (Javascript)

← Ankstesnė versija		21:54, 10 gegužės 2013 versija
69 eilutė:		69 eilutė:
	</pre>		</pre>

	~~Note~~: ~~what is also possible~~ to ~~do is~~		'''WARNING:''' in Javascript strings to translate, you should never use '\n', '\t' or such, as it will break the translation bundle and result in all the Javascript translation to fail. In any case, the strings will result in HTML code, and such character codes won't have any impact on the HTML rendering. You should use HTML markup instead.

	== On server side (PHP) ==		== On server side (PHP) ==

Sourisdudesert: /* How to not make translators crazy ;) */

2013-03-06T14:56:14Z

How to not make translators crazy ;)

← Ankstesnė versija		16:56, 6 kovo 2013 versija
51 eilutė:		51 eilutė:
	* When translators are going to translate your game, the most difficult task for them is to get the context of the string to be translated. The more the string is a short insignificant string, the more difficult is the task for them. As a rule of thumb, try to avoid insignificant short strings.		* When translators are going to translate your game, the most difficult task for them is to get the context of the string to be translated. The more the string is a short insignificant string, the more difficult is the task for them. As a rule of thumb, try to avoid insignificant short strings.
	* The BGA translation policy is to be flexible on grammar... We prefer to write "player gets 1 coin(s)" than write two versions of the same string for plural and singular - it reduces the number of strings to translate.		* The BGA translation policy is to be flexible on grammar... We prefer to write "player gets 1 coin(s)" than write two versions of the same string for plural and singular - it reduces the number of strings to translate.
			* Instead of writing nice strings like "With the effect of ZZZ, player XXX gets a new YYY", which is very difficult to translate, write strings like "ZZZ: XXX gets YYY".

	== On client side (Javascript) ==		== On client side (Javascript) ==

Sourisdudesert: /* How to not make translators crazy ;) */

2013-01-30T14:11:52Z

How to not make translators crazy ;)

← Ankstesnė versija		16:11, 30 sausio 2013 versija
50 eilutė:		50 eilutė:
	(or the equivalent "dojo.string.substitute" in Javascript)		(or the equivalent "dojo.string.substitute" in Javascript)
	* When translators are going to translate your game, the most difficult task for them is to get the context of the string to be translated. The more the string is a short insignificant string, the more difficult is the task for them. As a rule of thumb, try to avoid insignificant short strings.		* When translators are going to translate your game, the most difficult task for them is to get the context of the string to be translated. The more the string is a short insignificant string, the more difficult is the task for them. As a rule of thumb, try to avoid insignificant short strings.
			* The BGA translation policy is to be flexible on grammar... We prefer to write "player gets 1 coin(s)" than write two versions of the same string for plural and singular - it reduces the number of strings to translate.

	== On client side (Javascript) ==		== On client side (Javascript) ==

Sourisdudesert: /* How to not make translators crazy ;) */

2013-01-30T14:09:03Z

How to not make translators crazy ;)

← Ankstesnė versija		16:09, 30 sausio 2013 versija
49 eilutė:		49 eilutė:
	<pre>sprintf( _("First part of the string, %s second part of the string"), $argument )</pre>		<pre>sprintf( _("First part of the string, %s second part of the string"), $argument )</pre>
	(or the equivalent "dojo.string.substitute" in Javascript)		(or the equivalent "dojo.string.substitute" in Javascript)
	* When translators are going to translate your game, the most difficult task for them is to get the context of the string to be translated. The more the string is a short insignificant string, the more difficult is the task for them. As a rule of thumb, try to avoid insignificant short ~~string~~.		* When translators are going to translate your game, the most difficult task for them is to get the context of the string to be translated. The more the string is a short insignificant string, the more difficult is the task for them. As a rule of thumb, try to avoid insignificant short strings.

	== On client side (Javascript) ==		== On client side (Javascript) ==

Sourisdudesert: /* WARNING: how to make sure your strings will be translated */

2013-01-30T14:08:44Z

WARNING: how to make sure your strings will be translated

← Ankstesnė versija		16:08, 30 sausio 2013 versija
38 eilutė:		38 eilutė:
	$not_translated = self::_( $my_string ); // The original string is not bordered by a translator marker => no translation		$not_translated = self::_( $my_string ); // The original string is not bordered by a translator marker => no translation
	$not_translated = self::_( sprintf( "my string with a %s argument", $argument ) ); // Same thing		$not_translated = self::_( sprintf( "my string with a %s argument", $argument ) ); // Same thing
			</pre>

			== How to not make translators crazy ;) ==

	</pre>		* When you need the same string twice, try to reuse exactly the same string (with the same case) to minimize the number of strings.
			* Do not mark as translatable a game element that does not have to be translated (ex: if the name of a monster on a card is "Zzzzz", maybe there's no need to translate it).
			* Words does not come in the same order in each language. Thus, when you have to translate a string with an argument, do not write something like:
			<pre>_("First part of the string, ").$argument.' '._("second part of the string")</pre>
			Write instead:
			<pre>sprintf( _("First part of the string, %s second part of the string"), $argument )</pre>
			(or the equivalent "dojo.string.substitute" in Javascript)
			* When translators are going to translate your game, the most difficult task for them is to get the context of the string to be translated. The more the string is a short insignificant string, the more difficult is the task for them. As a rule of thumb, try to avoid insignificant short string.

	== On client side (Javascript) ==		== On client side (Javascript) ==

Sourisdudesert: /* Focus on translating notifications */

2013-01-30T14:00:36Z

Focus on translating notifications

← Ankstesnė versija		16:00, 30 sausio 2013 versija
21 eilutė:		21 eilutė:

	However, there is one difference on BGA: notifications. The server is sending notifications to players, and most of the time the notifications are the same for every players, no matter what language each player is using. This is why notifications are translated on client side in the proper language, even if the strings are defined on server side.		However, there is one difference on BGA: notifications. The server is sending notifications to players, and most of the time the notifications are the same for every players, no matter what language each player is using. This is why notifications are translated on client side in the proper language, even if the strings are defined on server side.

			== WARNING: how to make sure your strings will be translated ==

			For each game, our translation tool is doing a full scan of the code, looking for translator markers like "_()" or "clientranslate()"... (see below the list of translation markers).

			If your original string is not "physically" inside one of this marker, it won't be translated.

			<pre>
			// Examples: the following strings will be translated:
			var mystring_translated = _("my string"); // JS
			$mystring_translated = self::_("my string"); // PHP
			$mystring_translated = sprintf( _("my string with an %s argument"), $argument ); // PHP

			// Examples: the following strings WILL NOT be translated:
			$my_string = "my string";
			$not_translated = self::_( $my_string ); // The original string is not bordered by a translator marker => no translation
			$not_translated = self::_( sprintf( "my string with a %s argument", $argument ) ); // Same thing


			</pre>

	== On client side (Javascript) ==		== On client side (Javascript) ==

Sourisdudesert: /* On server side (PHP) */

2013-01-15T17:07:34Z

On server side (PHP)

@@ 68 eilutė: / 68 eilutė: @@
       // A game log string with no argument:
       self::notifyAllPlayers( 'pickLibraryCards', clienttranslate("Everyone draw cards from his library"), array() );
 </pre>

Sourisdudesert: /* On server side (PHP) */

2013-01-15T17:04:47Z

On server side (PHP)

← Ankstesnė versija		19:04, 15 sausio 2013 versija
85 eilutė:		85 eilutė:

	* In "yourgame.view.php", when creating the labels for the game interface used in your template (.tpl) file.		* In "yourgame.view.php", when creating the labels for the game interface used in your template (.tpl) file.

			<pre>
			$this->tpl['CARDS_FOR_YEAR_2'] = self::_("Your cards for year II");
			</pre>

	* Eventually, in your material.inc.php, if for example you need to use some string elements in your exceptions.		* Eventually, in your material.inc.php, if for example you need to use some string elements in your exceptions.

Sourisdudesert: /* On server side (PHP) */

2013-01-15T17:03:59Z

On server side (PHP)

@@ 50 eilutė: / 50 eilutė: @@
 In general, you use clienttranslate:
 * On your states.inc.php, for field "description" and "descriptionmyturn".
 * On "material.inc.php", when defining texts for game material that must be displayed on client side.
 * When sending a notification with "notifyAllPlayers" or "notifyPlayer", for the game log string and all game log arguments that need a translation.
 '''self::_( "my string to translate" ):'''
@@ 59 eilutė: / 76 eilutė: @@
 Most of the time, you don't need to translate strings on server side, except on the following 3 situations:
 * When throwing an exception because the player did a forbidden move.
 * In "yourgame.view.php", when creating the labels for the game interface used in your template (.tpl) file.
 * Eventually, in your material.inc.php, if for example you need to use some string elements in your exceptions.
 * Eventually, in your "getAllDatas" PHP method, as the data return by this method is used only by current user.