</%doc>
-<html lang="en"><head><title>Website documentation - YARRG</title>
-<link rel="stylesheet" type="text/css" href="style.css">
-</head><body>
-
-<div class="navoptbar">
-<a href="lookup">YARRG</a> -
- Yet Another Revenue Research Gatherer
-|
-<a href="intro">introduction</a>
-|
-<b>documentation</b>
-|
-<a href="devel">development</a>
-</div>
-<div class="docs">
-
+<& docshead &>
<h1>Looking up data in YARRG</h1>
YARRG (Yet Another Revenue Research Gatherer) is a third-party tool
documentation page contains information about the database website
which you may not be able to divine from the online user interface.
+<p>
+
+If this page is all too complicated for you, you may prefer to read
+<a href="intro">the introduction</a> instead.
+
<h2>Bookmarkable URLs</h2>
Mostly, you can bookmark the specific pages and queries. Select the
<p>
-(An exception to this is if you select the `Update' option from the
-`Trades for route' lookup; the list of (de)selected stalls is too long
+(An exception to this is if you select the "Update" option from the
+"Trades for route" lookup; the list of (de)selected stalls is too long
to fit in a URL.)
<h2>Dynamic confirmation of meaning of text entry boxes</h2>
If you have Javascript enabled, the various text entry boxes will be
annotated with a brief explanation of the system's interpretation of
your current entry string. To get the actual results updated, you
-must still hit `Go' or `Update'.
+must still hit "Go" or "Update".
<h2>Trades for route</h2>
<p>
After getting the results, you can untick various trades individually,
-and select `Update' to get a new plan. The unticked trades will be
+and select "Update" to get a new plan. The unticked trades will be
excluded from the voyage plan (if any) and also from the totals.
<h3><a name="capacity">Vessel capacity</a></h3>
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
+<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 &>