Huge rewrite of all base templates, added base_ship.xml (unfinished)

[shipsimu.git] / application / ship-simu / templates / de / game / building / base_building.xml

diff --git a/application/ship-simu/templates/de/game/building/base_building.xml b/application/ship-simu/templates/de/game/building/base_building.xml
index 5abfa67e0d0e774ff89b591099519d90bdd74959..c9815d249dbf7055ac049f8251f42db41f384eb1 100644 (file)
--- a/application/ship-simu/templates/de/game/building/base_building.xml
+++ b/application/ship-simu/templates/de/game/building/base_building.xml
@@ -38,7 +38,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>
                        <![CDATA[{?description?}]]>
                </description>
                <!-- General data, like short name, type, level and many more. //-->
-               <general-data id="{?id?}" name="{?name?}" type="{?type?}" level="{?level?}">
+               <general-data>
+                       <id>{?id?}</id>
+                       <name>{?name?}</name>
+                       <type>{?type?}</type>
+                       <level>{?level?}</level>
                        <!-- The owner of this building. //-->
                        <owner id="{?owner_id?}" type="{?owner_type?}" owned-start="{?owner_start_timestamp?}" owned-end="{?owner_end_timestamp?}" />
                        <!-- The occupant of this building. //-->
@@ -70,18 +74,32 @@ along with this program. If not, see <http://www.gnu.org/licenses/>
                <land-price currency="{?land_currency?}" />
                <!-- Construction costs may be empty when this building is bougth from
                     an other user e.g. a broker //-->
-               <construction-costs currency="{?construction_currency?}">
+               <construction-costs>
+                       <currency>{?construction_currency?}</currency>
                        <construction-company extends="{?construction_template?}">
-                               <company id="{?construct_id?}">
+                               <!-- The construction company. //-->
+                               <company>
+                                       <id>{?construct_id?}</id>
+                                       <!-- A construction of a building requires personel. We
+                                            summary their salery here for simplicy. //-->
                                        <personel-costs currency="{?personel_currency?}" />
-                                       <resources extends="{?resources_template?}">
-                                               <resource id="{?resource_id?}">
+                                       <!-- A lot resources like steel and concrete are required
+                                            for new high buildings. Some older or futuristic may
+                                            require different resources. //-->
+                                       <resource-list extends="{?resources_template?}">
+                                               <!-- A single resource and its amount to construct this
+                                                    building. //-->
+                                               <resource>
+                                                       <id>{?resource_id?}</id>
+                                                       <amount>{?resource_amount?}</amount>
+                                                       <!-- The merchant dealing with this resource. //-->
                                                        <resource-merchant extends="{?merchant_template?}">
                                                                <merchant id="{?merchant_id?}" />
                                                        </resource-merchant>
                                                </resource>
-                                       </resources>
+                                       </resource-list>
                                </company>
+                               <!-- The construction contract for constructing this building. //-->
                                <construction-contract extends="{?contract_template?}">
                                        <construction-contract id="{?construct_contract_id?}" />
                                </construction-contract>
@@ -91,22 +109,35 @@ along with this program. If not, see <http://www.gnu.org/licenses/>
                     it like house cleaning. simplified repair costs and in some way
                     taxes. //-->
                <running-costs>
+                       <!-- Taxes for the occupied lot. //-->
                        <taxes currency="{?taxes_currency?}" />
-                       <maintenance currency="{?maintenance_currency?}">
+                       <!-- A building has mostly maintenance costs. //-->
+                       <maintenance>
+                               <!-- Almost all buildings needs to be cleaned. //-->
                                <cleaning-costs>
+                                       <currency>{?cleaning_currency?}</currency>
+                                       <!-- The cleaning company. //-->
+                                       <cleaning-company id="{?cleaning_id?}" />
+                                       <!-- The contract for cleaning this building. //-->
                                        <cleaning-contract contract_id="{?cleaning_contract_id?}" />
                                </cleaning-costs>
                                <repair-costs>
+                                       <currency>{?repair_currency?}</currency>
                                        <repair contract_id="{?repair_contract_id?}" />
                                </repair-costs>
                        </maintenance>
                </running-costs>
                <!-- For constructing a building you sometimes need to take mortgage to
                     fund the construction costs. //-->
-               <mortgage currency="{?mortgage_currency?}">
+               <mortgage>
+                       <currency>{?mortgage_currency?}</currency>
+                       <!-- The bank paying the mortage, if not provided, the following
+                            mortage broker must be provided. //-->
                        <bank id="{?bank_id?}" />
+                       <!-- A mortage broker who has payed the mortage. //-->
                        <mortgage-broker id="{?broker_id?}" />
-                       <agreement id="{?mortage_id?}">
+                       <!-- The contract behind the mortage. //-->
+                       <contract id="{?mortage_id?}" />
                </mortgage>
        </costs>
        <!-- We also have technology denpencies for a building. These must be