Heavily extened and commented
[shipsimu.git] / application / ship-simu / templates / de / game / ship / base_ship.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!--
3 A general ship template.
4
5 @author         Roland Haeder <webmaster@ship-simu.org>
6 @version        0.0.0
7 @copyright      Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
8 @license        GNU GPL 3.0 or any newer version
9 @link           http://www.ship-simu.org
10
11 This program is free software: you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation, either version 3 of the License, or
14 (at your option) any later version.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 GNU General Public License for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>
23 //-->
24 <ship>
25         <!-- Some general data about this ship. Some may not be required for the
26              simulation at the moment. //-->
27         <general-data>
28                 <id>{?id?}</id>
29                 <name><![CDATA[{?name?}]]></name>
30                 <type>{?type?}</type>
31                 <ship-propeller>{?propeller?}</ship-propeller>
32                 <total-weight>{?weight?}</total-weight>
33                 <total-displacement>{?displacement?}</total-displacement>
34                 <!-- Some data about the construction phase, like company, contract. //-->
35                 <construction>
36                         <!-- The construction company of this ship. //-->
37                         <construction-company>{?construction_id?}</construction-company>
38                         <!-- The signed construction contract for this ship. //-->
39                         <construction-contract>{?construction_contract_id?}</construction-contract>
40                         <!-- When the construction has started. //-->
41                         <construction-started>{?construction_started?}</construction-started>
42                         <!-- And when the ship was constructed. //-->
43                         <construction-finished>{?construction_finished?</construction-finished>
44                 </construction>
45         </general-data>
46         <!-- A list of shipping companies who owned this ship. //-->
47         <shipping-company-list>
48                 <!-- A single company who owned this ship for a tme span. //-->
49                 <shipping-company>
50                         <id>{?company_id?}</id>
51                         <!-- A time span when the company owned this ship. //-->
52                         <holder-timespan>
53                                 <started>{?holder_started?}</started>
54                                 <ended>{?holder_ended?}</ended>
55                         </hoolder-timespan>
56                         <!-- A contract signed for changing ownership. //-->
57                         <contract id="{?contract_id?}" />
58                 </shipping-company>
59         </shipping-company-list>
60         <!-- A list of structures to build this ship. If you need more than of a
61              structure type just specify the neccessary amount. //-->
62         <ship-structure-list>
63                 <!-- A single ship structure. This can be anything from the wheel house
64                      to theatre or little ships, decks and cabins. //-->
65                 <ship-structure extends="{?structure_template?}">
66                         <id>{?structure_id?}</id>
67                         <amount>{?structure_amount?}</amount>
68                         <type>{?structure_type?}</type>
69                 </ship-structure>
70         </ship-structure-list>
71         <!-- All ships require an engine, even when or 'engine' is a sail, to move
72              around. //-->
73         <engine extends="{?engine_template?}">
74                 <id>{?engine_id?{</id>
75                 <type>{?engine_type?}</type>
76         </engine>
77         <!-- A ship may require one or more of these system to operate. //-->
78         <ship-systems>
79                 <!-- The electric system of latest ship has becom the most important
80                      on a ship. It poeeres all other systems and provides electrical
81                      power to all kind of commercials and cabins including interior and
82                      exterior lights. So you should be adviced to provide emergency
83                      systems and redudancy for this system. //-->
84                 <electric-system>
85                 </electric-system>
86                 <!-- On latest ships you require to have a hydric system to operate
87                      heavy bulkheads which seperates sections on low-level decks. On
88                      passenger ships the hydraulic system have to operate front and/or
89                      rear doors to let drive vehicles in. //-->
90                 <hydraulic-system>
91                 </hydraulic-system>
92                 <!-- Nearly all ships will have a navigation system. //-->
93                 <navigation-system>
94                 </navigation-system>
95                 <!-- A guidance system, //-->
96                 <guidance-system>
97                 </guidance-system>
98         </ship-systems>
99 </ship>