Vessel names for capacity seem to work

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

diff --git a/yarrg/web/docs b/yarrg/web/docs
old mode 100644 (file)
new mode 100755 (executable)
index 2abe504..24d9f16
--- 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,13 +110,29 @@ 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.
-
-<h3>Estimated loss per league</h3>
+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>
 
 In theory if you were guaranteed to have a trouble-free voyage it
 would be worth trading goods at very low margins.  However, in
@@ -150,6 +168,7 @@ every ten 10-league voyages.
 <p>
 
 You can enter the value in the box either as a percentage, or as a
-fraction 1/<em>divisor</em>, eg 1/200 is the same as 0.5%.
+fraction 1/<em>divisor</em>, eg 1/200 is the same as 0.5%; in each
+case it is taken as the loss for each league of the voyage.
 
 <& footer &>