Better caveats re posinclass

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

diff --git a/yarrg/web/docs b/yarrg/web/docs
index 8c48814f59faddfb74be9b4b1e6cec516b1f756c..27ee3d5aae737ac5d1125b9b15c066a24cc2db28 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -196,5 +196,42 @@ them for 20 PoE each, and then buy 2000 beans at B for 10 PoE each and
 sail them to C to sell for 20 PoE each even if such a trade would in
 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,
+<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>
+</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.
+If you mouseover that in a suitably equipped browser you should see the
+text:
+<blockquote>
+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.
+
+<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.
+
 </div>
 <& footer &>