Vessel names for capacity seem to work

[ypp-sc-tools.db-test.git] / yarrg / web / docs

diff --git a/yarrg/web/docs b/yarrg/web/docs
index cbb1c0dd2a30dea8055aef2fae6d78c4b27d7954..24d9f165817fe95de8333067fb1027ac35d9bbfa 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -110,11 +110,27 @@ which trades excessively cumbersome goods (eg. hemp, wood, iron).
 
 <p>
 
-So you should specify your vessel capacity.  Currently you must
-specify the actual mass and volume, as two numbers each with units.
-The system understands the units t (tonnes), kg, l and kl
-(kilolitres).  There should be a space between the two limits, and no
-space before the unit.
+So you should specify your vessel capacity.  You can enter things
+like:
+<dl>
+<dt>sloop
+<dd>The capacity of a sloop, exactly
+<dt>20t 13kl
+<dd>20 tonnes (20,000kg), 13 kilolitres (13,000l)
+<dt>sloop - 100l 100kg
+<dd>The capacity of a sloop minus 100l, minus 100kg
+<dt>2t plus 500kg minus 200kg
+<dd>2300kg, with no limit on volume
+</dl>
+
+Formally, the capacity is a list of terms, all but the first preceded
+by one of <kbd>-</kbd>, <kbd>minus</kbd>, <kbd>+</kbd>,
+<kbd>plus</kbd>.  Each term may specify a mass and/or a volume
+(separated by a space), as a number followed (without an intervening
+space) by a unit (<kbd>t</kbd>, <kbd>kg</kbd>, <kbd>kl</kbd> or
+<kbd>l</kbd>).  The first term may be a ship name or abbrevation
+instead.  If the first term specifies only one of mass or volume, all
+the subsequent terms may only adjust that same value.
 
 <h3>Expected losses</h3>