Add [?] links to help for advanced strings

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

diff --git a/yarrg/web/docs b/yarrg/web/docs
index 48a0062f70c6953d8744e5981ce5807875966a9d..6f754bff46e258472de8c5d413723ab7fa8eb117 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -101,7 +101,7 @@ After getting the results, you can untick various trades individually,
 and select `Update' to get a new plan.  The unticked trades will be
 excluded from the voyage plan (if any) and also from the totals.
 
 and select `Update' to get a new plan.  The unticked trades will be
 excluded from the voyage plan (if any) and also from the totals.
 

-<h3>Vessel capacity</h3>
+<h3><a name="capacity">Vessel capacity</a></h3>

 
 If you don't specify a vessel or a vessel capacity, the trading plan
 will not take into account the fact that your voyage will be on a ship
 
 If you don't specify a vessel or a vessel capacity, the trading plan
 will not take into account the fact that your voyage will be on a ship


@@ -115,9 +115,9 @@ like:
 <dl>
 <dt>sloop
 <dd>The capacity of a sloop, leaving no allowance for rum and shot
 <dl>
 <dt>sloop
 <dd>The capacity of a sloop, leaving no allowance for rum and shot

-<dt>sloop - 1%
-<dd>The capacity of a sloop minus 1%
-<dt>20t 13kl
+<dt>wb - 1%
+<dd>The capacity of a war brig minus 1%
+<dt>13t 20kl

 <dd>13 tonnes (13,000kg), 20 kilolitres (20,000l)
 <dt>sloop - 100l 100kg
 <dd>The capacity of a sloop minus 100l, minus 100kg
 <dd>13 tonnes (13,000kg), 20 kilolitres (20,000l)
 <dt>sloop - 100l 100kg
 <dd>The capacity of a sloop minus 100l, minus 100kg


@@ -139,7 +139,7 @@ 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.
 
 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>
+<h3><a name="losses">Expected losses</a></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
 
 In theory if you were guaranteed to have a trouble-free voyage it
 would be worth trading goods at very low margins.  However, in


@@ -157,14 +157,15 @@ to do.
 
 <p>
 
 
 <p>
 

-Trades whose margin is less than the expected loss are never selected.
-For example, if you select 1% loss per league, and plan a voyage of 5
-leagues, then any trade with a margin of less than 5.15% would be
-completely excluded (5.15% not 5% because the loss works like compound
-interest).  Theoretically very profitable trades which are close to
-the expected break-even point because of the distance can also be
-rejected by the optimiser in favour of shorter distance trades with
-theoretically smaller margins.
+Trades whose margin is less than the expected loss are never included
+in the suggested plan.  For example, if you select 1% loss per league,
+and plan a voyage of 5 leagues, then any trade with a margin of less
+than 5.15% would be completely excluded (5.15% not 5% because the loss
+works like compound interest).  Theoretically very profitable trades
+which are close to the expected break-even point because of the
+distance can also be rejected by the optimiser in favour of shorter
+distance trades with theoretically smaller margins, if it's not
+possible to do both.

 
 <p>
 
 
 <p>