From d75c1cb4b2a001fbe9229a5da1b315edaa633fea Mon Sep 17 00:00:00 2001
From: =?utf8?q?Roland=20H=C3=A4der?= <roland@mxchange.org>
Date: Wed, 16 Sep 2009 21:56:36 +0000
Subject: [PATCH] Heavily extened and commented

---
 .../templates/de/game/ship/base_ship.xml      | 49 +++++++++++++++----
 1 file changed, 40 insertions(+), 9 deletions(-)

diff --git a/application/ship-simu/templates/de/game/ship/base_ship.xml b/application/ship-simu/templates/de/game/ship/base_ship.xml
index e4fe7ac..477c982 100644
--- a/application/ship-simu/templates/de/game/ship/base_ship.xml
+++ b/application/ship-simu/templates/de/game/ship/base_ship.xml
@@ -22,46 +22,77 @@ You should have received a copy of the GNU General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>
 //-->
 <ship>
+	<!-- Some general data about this ship. Some may not be required for the
+	     simulation at the moment. //-->
 	<general-data>
 		<id>{?id?}</id>
 		<name><![CDATA[{?name?}]]></name>
 		<type>{?type?}</type>
-		<total-propellers>{?propellers?}</total-propellers>
-		<total-weight>{?weight?}</totaal-weight>
-		<total-displacement>{?displacement?}</totaal-displacement>
+		<ship-propeller>{?propeller?}</ship-propeller>
+		<total-weight>{?weight?}</total-weight>
+		<total-displacement>{?displacement?}</total-displacement>
+		<!-- Some data about the construction phase, like company, contract. //-->
 		<construction>
+			<!-- The construction company of this ship. //-->
 			<construction-company>{?construction_id?}</construction-company>
+			<!-- The signed construction contract for this ship. //-->
+			<construction-contract>{?construction_contract_id?}</construction-contract>
+			<!-- When the construction has started. //-->
 			<construction-started>{?construction_started?}</construction-started>
+			<!-- And when the ship was constructed. //-->
 			<construction-finished>{?construction_finished?</construction-finished>
 		</construction>
 	</general-data>
+	<!-- A list of shipping companies who owned this ship. //-->
 	<shipping-company-list>
+		<!-- A single company who owned this ship for a tme span. //-->
 		<shipping-company>
 			<id>{?company_id?}</id>
-			<holder>.
+			<!-- A time span when the company owned this ship. //-->
+			<holder-timespan>
 				<started>{?holder_started?}</started>
 				<ended>{?holder_ended?}</ended>
-			</hoolder>
+			</hoolder-timespan>
+			<!-- A contract signed for changing ownership. //-->
 			<contract id="{?contract_id?}" />
 		</shipping-company>
 	</shipping-company-list>
+	<!-- A list of structures to build this ship. If you need more than of a
+	     structure type just specify the neccessary amount. //-->
 	<ship-structure-list>
-		<ship-structure>
+		<!-- A single ship structure. This can be anything from the wheel house
+		     to theatre or little ships, decks and cabins. //-->
+		<ship-structure extends="{?structure_template?}">
 			<id>{?structure_id?}</id>
+			<amount>{?structure_amount?}</amount>
 			<type>{?structure_type?}</type>
 		</ship-structure>
 	</ship-structure-list>
-	<engine>
+	<!-- All ships require an engine, even when or 'engine' is a sail, to move
+	     around. //-->
+	<engine extends="{?engine_template?}">
 		<id>{?engine_id?{</id>
 		<type>{?engine_type?}</type>
 	</engine>
+	<!-- A ship may require one or more of these system to operate. //-->
 	<ship-systems>
-		<electrical-system>
-		</electrical-system>
+		<!-- The electric system of latest ship has becom the most important
+		     on a ship. It poeeres all other systems and provides electrical
+		     power to all kind of commercials and cabins including interior and
+		     exterior lights. So you should be adviced to provide emergency
+		     systems and redudancy for this system. //-->
+		<electric-system>
+		</electric-system>
+		<!-- On latest ships you require to have a hydric system to operate
+		     heavy bulkheads which seperates sections on low-level decks. On
+		     passenger ships the hydraulic system have to operate front and/or
+		     rear doors to let drive vehicles in. //-->
 		<hydraulic-system>
 		</hydraulic-system>
+		<!-- Nearly all ships will have a navigation system. //-->
 		<navigation-system>
 		</navigation-system>
+		<!-- A guidance system, //-->
 		<guidance-system>
 		</guidance-system>
 	</ship-systems>
-- 
2.39.2