Mind map updated and HTML export added

[shipsimu.git] / docs / Ship-Simu Ship-Simulator.mm

diff --git a/docs/Ship-Simu Ship-Simulator.mm b/docs/Ship-Simu Ship-Simulator.mm
index c69bc99ba51456e4bff2ef365f9dce3219fe52a5..a26a6551ac62c94f9802e40d1b0a8405a9abf306 100644 (file)
--- a/docs/Ship-Simu Ship-Simulator.mm
+++ b/docs/Ship-Simu Ship-Simulator.mm
@@ -2,7 +2,7 @@
 <node TEXT="Ship-Simu Ship-Simulation">
 <font NAME="SansSerif" SIZE="18"/>
 <node TEXT="Browser-Game" POSITION="right">
-<font NAME="SansSerif" BOLD="true" SIZE="14"/>
+<font NAME="SansSerif" BOLD="true" SIZE="16"/>
 <icon BUILTIN="messagebox_warning"/>
 <node TEXT="Tick-based simulation">
 <node TEXT="Cronological job (cron)">
@@ -60,7 +60,7 @@
 <node TEXT="The news source can be choosen from different">
 <node TEXT="Previously typed and stored in database"/>
 <node TEXT="Local XML files">
-<node TEXT="Hint: Created by external generator">
+<node TEXT="Hint: Created by external generators">
 <font NAME="SansSerif" SIZE="12"/>
 </node>
 </node>
@@ -79,10 +79,47 @@
 </node>
 </node>
 </node>
+<node TEXT="One object for all news should be fine">
+<node TEXT="Do not use one object per news entry!">
+<icon BUILTIN="clanbomber"/>
+<icon BUILTIN="stop"/>
 </node>
+<node TEXT="The object receives a &quot;Requestable&quot; object">
+<node TEXT="Obtain page number and sent comment data from it"/>
 </node>
-<node TEXT="How does a shipping company work?" POSITION="left">
+</node>
+</node>
+<node TEXT="Strict coding guidelines for better PHP code">
 <font NAME="SansSerif" BOLD="true" SIZE="14"/>
+<icon BUILTIN="xmag"/>
+<node TEXT="General code structure">
+<font NAME="SansSerif" BOLD="true" SIZE="12"/>
+<icon BUILTIN="messagebox_warning"/>
+<node TEXT="Fully object-oriented"/>
+<node TEXT="Use of different but practical design patterns"/>
+</node>
+<node TEXT="Documentation">
+<font NAME="SansSerif" BOLD="true" SIZE="12"/>
+<node TEXT="In-line documentation">
+<node TEXT="Script header with full copyright and license as requested by GNU GPL 3"/>
+<node TEXT="Method headers with Doxygen compatible tags"/>
+<node TEXT="Comments above single lines for better understanding what is happening"/>
+</node>
+<node TEXT="Files in directory &quot;docs&quot;">
+<node TEXT="COPYING*"/>
+<node TEXT="Conception"/>
+<node TEXT="NEWS"/>
+<node TEXT="README"/>
+<node TEXT="ArgoUML diagram"/>
+<node TEXT="FreeMind document"/>
+<node TEXT="THANKS"/>
+<node TEXT="min-map_yyyymmdd-hhmm.html"/>
+</node>
+</node>
+</node>
+</node>
+<node TEXT="How does a shipping company work?" POSITION="left">
+<font NAME="SansSerif" BOLD="true" SIZE="16"/>
 <icon BUILTIN="messagebox_warning"/>
 <node TEXT="Start as a founder by selecting a harbor">
 <cloud/>
@@ -157,7 +194,7 @@
 </node>
 </node>
 <node TEXT="Multi-Player Mode" POSITION="right">
-<font NAME="SansSerif" BOLD="true" SIZE="14"/>
+<font NAME="SansSerif" BOLD="true" SIZE="16"/>
 <icon BUILTIN="messagebox_warning"/>
 <node TEXT="Networked over hubs"/>
 <node TEXT="Big map which holds all harbors">
@@ -174,9 +211,9 @@
 <node TEXT="OpenAL (3D sound)"/>
 </node>
 <node TEXT="&quot;Faked&quot; Single-Player" POSITION="right">
-<node TEXT="Local installed version"/>
+<node TEXT="Locally installed version"/>
 <node TEXT="Does not connect to other hubs"/>
-<node TEXT="Save games should be incompatible with MP mode">
+<node TEXT="&quot;Save games&quot; should be incompatible with MP mode">
 <node TEXT="Avoids cheating"/>
 </node>
 </node>
@@ -217,8 +254,15 @@
 <node TEXT="Optional Pillory" POSITION="left">
 <node TEXT="To make e.g. nazi activity public"/>
 <node TEXT="Shall keep bad players away"/>
-<node TEXT="Requires some &quot;game-moderator&quot; access level"/>
-<node TEXT="Players, companies et cetera should be lockable"/>
+<node TEXT="Requires some &quot;game-moderator&quot; access level to manage">
+<node TEXT="The moderator shall have an extra flag e.g. &quot;pillory_accessable&quot;"/>
+</node>
+<node TEXT="Players, companies et cetera should be lockable">
+<node TEXT="The moderator can choose wether to lock with pillory entry or just locking down"/>
+</node>
+</node>
+<node LINK="http://www.ship-simu.org" TEXT="http://www.ship-simu.org" POSITION="right">
+<icon BUILTIN="attach"/>
 </node>
 </node>
 </map>