Commodity location in deciles

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

diff --git a/yarrg/web/docs b/yarrg/web/docs
index 27ee3d5aae737ac5d1125b9b15c066a24cc2db28..0f6249199c07344c4b17a919c4387ce4187cd0ab 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -199,23 +199,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,15 +236,15 @@ Fine pink cloth is under Cloth, commodity 14 of 55
 </blockquote>
 <p>
 
-Note 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.
 
-<p>
 Also, not all commodities are always completely categorised or
-ordered; we are working to add the additional data.  Uncategorised or
-unordered commodities don't have a position indicator (TT, T etc.)
-next to them.
+ordered; we are working to add the additional data
 
 </div>
 <& footer &>