wip sort out Midnights

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

diff --git a/yarrg/web/docs b/yarrg/web/docs
index 2be018e810270b3b14cb3feb7ccb5db2c439031b..82b2adde2f2fc7e4133dbf2b26f97b53745f7d26 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -178,6 +178,37 @@ You can enter the value in the box either as a percentage, or as a
 fraction 1/<em>divisor</em>, eg 1/2000 is the same as 0.05%; in each
 case it is taken as the loss for each league of the voyage.
 
+<h3><a name="minprofit">Minimum trade value</a></h3>
+
+Often there are many low-volume, low-value trades.  It can be rather
+labour-intensive to buy and sell a dozen different commodities, half
+of which are only making a few poe each.
+
+<p>
+
+The "minimum trade value" specifies a minimum profit that you would
+like to get from each (commodity, collect island, deliver island)
+triplet.  Trades which don't meet this minimum will start out unticked in
+the "Relevant trades" table and will not be included in the voyage
+trading plan.
+
+<p>
+
+If you want to change your threshold, you have to select "Apply",
+which will automatically tick and untick all of the tickboxes for in
+"Relevant trades", as appropriate.  This will undo any customisation
+of the set of trades you have already done by manually ticking and
+unticking individual trades.
+
+<p>
+
+The value is an absolute poe amount, typically 5 or 10, representing
+the minimum profit to make it worthwhile (from a time and effort point
+of view) clicking in the YPP client to collect and deliver a
+commodity.  Setting a higher threshold will make each island visit
+faster, by excluding trivial transactions, and so reduce the chance
+that market conditions change adversely during your voyage.
+
 <h3><a name="poelimit">Caution about stalls' poe reserves</a></h3>
 
 If you select <b>Also be cautious about stalls' poe reserves</b>,
@@ -215,7 +246,7 @@ fact be possible.  In practice this is unlikely to be a problem!
 In the Voyage Trading Plan, YARRG indicates after the commodity name
 where in the YPP commodity UI each commodity can be found.  First
 comes the initial letter of the category:
-%     my $dbh= dbw_connect('Midnight');
+%     my $dbh= dbw_connect('Cerulean');
 %     my $getclasses= $dbh->prepare(
 %        "SELECT commodclass FROM commodclasses ORDER BY commodclass");
 %     $getclasses->execute();
@@ -257,8 +288,5 @@ The exact location of the commodity in the actual game
 client may vary because YARRG only considers the list of all possible
 commodities, not the list of actual offers at the island in question.
 
-Also, not all commodities are always completely categorised or
-ordered; we are working to add the additional data
-
 </div>
 <& footer &>