chiark / gitweb /
Reorganise docs to include new howto material in intro etc.
[ypp-sc-tools.db-live.git] / yarrg / web / docs
index e1269706dbba7e38a98cb84069140c6bf827293f..6511b7e7114318e6d45e1b13cf6acee392dfe854 100755 (executable)
 
 
 </%doc>
-<html lang="en"><head><title>Website documentation - YARRG</title>
-</head><body>
-
-<a href="lookup">YARRG</a> -
- Yet Another Revenue Research Gatherer
-|
-<a href="devel">development</a>
-|
-<a href="intro">introduction</a>
-|
-<b>documentation</b>
-
+<& docshead &>
 <h1>Looking up data in YARRG</h1>
 
 YARRG (Yet Another Revenue Research Gatherer) is a third-party tool
@@ -62,6 +51,11 @@ Hopefully you will be able to work it without too much help, but this
 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
@@ -89,7 +83,7 @@ potentially profitable trades.  If the route is suitable for the trade
 route optimiser, it will generate a complete voyage plan, telling you
 which goods to buy and sell where at which stalls and prices.
 
-<p>
+<p><a name="arbitrage"></a>
 
 If you specify only one island or one archipelago, the site shows only
 arbitrage trades.  If you want single-hop trades within an
@@ -174,14 +168,14 @@ possible to do both.
 
 <p>
 
-As a guide: you may expect to lose between 0.1% and 1% per league.
-0.1% would correspond, for example, to losing one fight to brigands
-every ten 10-league voyages.
+As a guide: you may expect to lose between 0.01% and 1% per league.
+For example 0.1% would correspond to losing one fight to brigands (who
+take 10% if they win) for every 100 leagues sailed.
 
 <p>
 
 You can enter the value in the box either as a percentage, or as a
-fraction 1/<em>divisor</em>, eg 1/200 is the same as 0.5%; in each
+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="capital">Available capital</a></h3>
@@ -202,4 +196,5 @@ 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!
 
+</div>
 <& footer &>