From b512153d732e098a02d7a8adc001f016bb3894b4 Mon Sep 17 00:00:00 2001
From: ThiloVoigt555 <eiskalt555@web.de>
Date: Mon, 13 Oct 2014 17:30:28 +0200
Subject: [PATCH] Add TRANSLATORS comments

This will better help the translators as they complete the difficult task
of taking one language and finding commonality in another.

Closes #165
Closes #161
---
 doc/translation.txt        | 4 ++--
 script/engine.js           | 2 ++
 script/events/setpieces.js | 6 ++++++
 script/outside.js          | 2 +-
 4 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/doc/translation.txt b/doc/translation.txt
index d551710..efab946 100644
--- a/doc/translation.txt
+++ b/doc/translation.txt
@@ -56,7 +56,7 @@ windows:
   poedit
 
 - ubuntu:
-	pybabel extract -F babel.cfg script > lang/adarkroom.pot
+	pybabel extract -F babel.cfg -c "TRANSLATORS" script > lang/adarkroom.pot
   windows:
 	use poedit
 	Use menu "Cataloge"-> "New Catalog from POT file..."
@@ -101,7 +101,7 @@ To update from source without pot file need:
   *.js
 
   Parser command:
-  xgettext --language=JavaScript --force-po -o %o %C %K %F
+  xgettext --language=JavaScript --force-po --add-comments=TRANSLATORS -o %o %C %K %F
 
   Item in Keyword List:
   -k%k
diff --git a/script/engine.js b/script/engine.js
index 470be7b..e87b0e1 100644
--- a/script/engine.js
+++ b/script/engine.js
@@ -20,6 +20,7 @@
 			'boxer': {
 				name: _('boxer'),
 				desc: _('punches do more damage'),
+				/// TRANSLATORS : means with more force.
 				notify: _('learned to throw punches with purpose')
 			},
 			'martial artist': {
@@ -28,6 +29,7 @@
 				notify: _('learned to fight quite effectively without weapons')
 			},
 			'unarmed master': {
+				/// TRANSLATORS : master of unarmed combat
 				name: _('unarmed master'),
 				desc: _('punch twice as fast, and with even more force'),
 				notify: _('learned to strike faster without weapons')
diff --git a/script/events/setpieces.js b/script/events/setpieces.js
index b6d79d5..066cfa8 100644
--- a/script/events/setpieces.js
+++ b/script/events/setpieces.js
@@ -198,6 +198,7 @@ Events.Setpieces = {
 				text: [
 					_('the body of a wanderer lies in a small cavern.'),
 					_("rot's been to work on it, and some of the pieces are missing."),
+                    /// TRANSLATORS : 'it' is a rotting wanderer's body
 					_("can't tell what left it here.")
 				],
 				loot: {
@@ -1672,6 +1673,7 @@ Events.Setpieces = {
 			'c4': {
 				text: [
 					_('looks like a camp of sorts up ahead.'),
+                    /// TRANSLATORS : chainlink is a type of metal fence.
 					_('rusted chainlink is pulled across an alleyway.'),
 					_('fires burn in the courtyard beyond.')
 				],
@@ -1723,6 +1725,7 @@ Events.Setpieces = {
 			
 			'c7': {
 				text: [
+                    /// TRANSLATORS : squatters occupy abandoned dwellings they don't own.
 					_('more squatters are crowding around now.'),
 					_('someone throws a stone.')
 				],
@@ -2396,6 +2399,7 @@ Events.Setpieces = {
 			
 			'end3': {
 				text: [
+                    /// TRANSLATORS : a platform in the subway
 					_('the tunnel opens up at another platform.'),
 					_('the walls are scorched from an old battle.'),
 					_('bodies and supplies from both sides litter the ground.')
@@ -2837,6 +2841,7 @@ Events.Setpieces = {
 			
 			'end14': {
 				text: [
+                    /// TRANSLATORS : warped means extremely disfigured.
 					_('the warped man lies dead.'),
 					_('the operating theatre has a lot of curious equipment.')
 				],
@@ -3523,6 +3528,7 @@ Events.Setpieces = {
 					_('a destroyed village lies in the dust.'),
 					_('charred bodies litter the ground.')
 				],
+                /// TRANSLATORS : tang = strong metallic smell, wanderer afterburner = ship's engines
 				notification: _('the metallic tang of wanderer afterburner hangs in the air.'),
 				buttons: {
 					'enter': {
diff --git a/script/outside.js b/script/outside.js
index 0febb72..d49077a 100644
--- a/script/outside.js
+++ b/script/outside.js
@@ -415,7 +415,7 @@ var Outside = {
 				Outside.updateVillageRow(k, $SM.get('game.buildings["'+k+'"]'), village);
 			}
 		}
-		
+		/// TRANSLATORS : pop is short for population.
 		population.text(_('pop ') + $SM.get('game.population') + '/' + this.getMaxPopulation());
 		
 		var hasPeeps;