Allow initials-based abbrevations for ship names

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

diff --git a/yarrg/web/docs b/yarrg/web/docs
index 1c1ce69805fcaddcb15099b842b47746b656f585..fc1bd0f712a154c2f325b502951f382b38a3a4c4 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -39,6 +39,8 @@
 <a href="lookup">YARRG</a> -
  Yet Another Revenue Research Gatherer
 |
+<a href="devel">development</a>
+|
 <a href="intro">introduction</a>
 |
 <b>documentation</b>
@@ -56,9 +58,9 @@ from YARRG.  It offers a variety of enquiry options.
 
 <p>
 
-This website documentation page contains information about the
-database website which you may not be able to divine from the online
-user interface.
+Hopefully you will be able to work it without too much help, but this
+documentation page contains information about the database website
+which you may not be able to divine from the online user interface.
 
 <h2>Bookmarkable URLs</h2>
 
@@ -108,11 +110,34 @@ 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, leaving no allowance for rum and shot
+<dt>wb - 1%
+<dd>The capacity of a war brig minus 1%
+<dt>20t 13kl
+<dd>13 tonnes (13,000kg), 20 kilolitres (20,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>
+Evaluation is strictly from left to right.
+
+<p>
+
+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>).  Alternatively each term except the first may specify a
+percentage, which is applied as a percentage change to the answer from
+all the preceding terms.  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>