Put definitions of TT etc. (for posinclass) in docs

diff --git a/yarrg/web/docs b/yarrg/web/docs
index 8c48814f59faddfb74be9b4b1e6cec516b1f756c..66ddf41acea42b5e573deb89b5b5d21536f67d1c 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -196,5 +196,37 @@ 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 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.
+
 </div>
 <& footer &>

diff --git a/yarrg/web/routetrade b/yarrg/web/routetrade
index 41340201bfc8f4d7ab99d2e87a65046d6178b784..08bad334569ea32178ec8e6e7d3345bf4d8060e5 100644 (file)
--- a/yarrg/web/routetrade
+++ b/yarrg/web/routetrade
@@ -638,14 +638,18 @@ Generated by YARRG at <strong><%
 %
 % foreach my $i (0..$#islandids) {
 <% $tbody->(1) %>
-<tr><td colspan=5>
+<tr>
 %      $iquery->execute($islandids[$i]);
 %      my ($islandname) = $iquery->fetchrow_array();
 %      if (!$i) {
+<td colspan=2>
 <strong>Start at <% $islandname |h %></strong>
+<td><a href="docs#posinclass">[?]</a>
+<td colspan=2>
 %      } else {
 %              my $this_dist= $distance->($islandids[$i-1],$islandids[$i]);
 %              $total_dist += $this_dist;
+<td colspan=5>
 <%perl>
                my $total_value= 0;
                foreach my $sf (@subflows) {
@@ -699,19 +703,12 @@ END
                                my $maxpic= $classinfo->{'maxposinclass'};
                                my $inpic= $f->{'posinclass'};
                                my @tmbs= qw(TT T M B BB);
-                               my @tmbds= (    'in Top fifth of list',
-                                               'in 2nd fifth of the list',
-                                               'in Middle fifth of the list',
-                                               'in 2nd-bottom fifth of list',
-                                               'in Bottom fifth of the list');
                                my $tmbi= ($inpic+0.5)*$#tmbs/$maxpic;
                                my $desc= (sprintf "%s is under %s,".
-                                       " commodity %d of %d;".
-                                       " i.e. %s or %s",
+                                       " commodity %d of %d",
                                        $f->{'commodname'},
                                        $classinfo->{'commodclass'},
-                                       $inpic, $maxpic,
-                                       $tmbs[$tmbi], $tmbds[$tmbi]);
+                                       $inpic, $maxpic);
                                $$todo->{'posinclass'}=
  "<div class=mouseover title=\"$desc\">$tmbs[$tmbi]</div>";
                        }