Merge branch 'stable-5.x'

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

diff --git a/yarrg/web/docs b/yarrg/web/docs
index 66ddf41acea42b5e573deb89b5b5d21536f67d1c..2be018e810270b3b14cb3feb7ccb5db2c439031b 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -178,6 +178,20 @@ 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="poelimit">Caution about stalls' poe reserves</a></h3>
+
+If you select <b>Also be cautious about stalls' poe reserves</b>,
+YARRG will calculate a minimum amount of poe that each stall has on
+hand (by looking at all the offers that stall is making), and never
+plan for you to sell goods at that stall for more than the available
+poe.
+
+<p>
+
+Goods planned to be bought at the stall (which might boost the stall's
+poe reserves) are not considered, to avoid having to calculate the
+stall's cash reserves at various different times.
+
 <h3><a name="capital">Available capital</a></h3>
 
 If you don't specify the amount of capital you have available to
@@ -199,23 +213,36 @@ fact be possible.  In practice this is unlikely to be a problem!
 <h3><a name="posinclass">Locating commodities in the YPP client UI</a></h3>
 
 In the Voyage Trading Plan, YARRG indicates after the commodity name
-where in the YPP commodity UI each commodity can be found.  This is
-done by showing one of the following indications in the table:
-<blockquote>
- TT,  T,  M,  B,  BB
-</blockquote>
-indicating whether the commodity is in the top, 2nd, middle,
-2nd-to-last or bottom fifth of the list of commodities of the same
-class, respectively.  For example,
+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 $getclasses= $dbh->prepare(
+%        "SELECT commodclass FROM commodclasses ORDER BY commodclass");
+%     $getclasses->execute();
+<%
+    join '; ', map { $_->[0] =~ m/^./ or die; "<strong>$&</strong>$'" }
+        @{ $getclasses->fetchall_arrayref() }
+%>.
+<p>
+
+Then, if applicable, follows a number from <strong>0</strong> to
+<strong>9</strong> indicating roughly where the commodity is in the
+list of commodities of the same class.  The number indicates which
+tenth of the list is: <strong>0</strong> for the first (top) tenth,
+<strong>1</strong> for the 2nd, and so on, up to <strong>9</strong>
+for the final tenth.
+
+<p>
+For example,
 <blockquote>
 <table><tr>
 <td>Fine pink cloth&nbsp;&nbsp;
 <td><div class=mouseover
- title="Fine pink cloth is under Cloth, commodity 14 of 55">T</div>
+ title="Fine pink cloth is under Cloth, commodity 14 of 55">C 2</div>
 </table>
 </blockquote>
 indicates that Fine pink cloth can be found under Cloth,
-between 20% and 40% of the way down through the types of Cloth.
+between 20% and 30% of the way down through the types of Cloth.
 If you mouseover that in a suitably equipped browser you should see the
 text:
 <blockquote>
@@ -223,10 +250,15 @@ Fine pink cloth is under Cloth, commodity 14 of 55
 </blockquote>
 <p>
 
-Note that not all commodities are categorised, and that the exact
-location of the commodity may vary because the system only considers
-the list of all possible commodities, not the list of actual offers at
-the island in question.
+The position indicator digit isn't shown for very small
+categories.
+
+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 &>