X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-test.git;a=blobdiff_plain;f=yarrg%2Fweb%2Fdocs;h=010fd456966164a95a054278ca1267aa94ec947d;hp=6edf934b4fb783ff6e499fea666bce836cfa49be;hb=ae926461ebeb67c806caa7be5d85d18a02a08177;hpb=29010a75143814a91b4f5200454bea879280e7c1
diff --git a/yarrg/web/docs b/yarrg/web/docs
index 6edf934..010fd45 100755
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -33,21 +33,7 @@
%doc>
-
-
+<& docshead &>
Looking up data in YARRG
YARRG (Yet Another Revenue Research Gatherer) is a third-party tool
@@ -65,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.
+
+
+If this page is all too complicated for you, you may prefer to read
+the introduction instead.
+
Bookmarkable URLs
Mostly, you can bookmark the specific pages and queries. Select the
@@ -74,8 +65,8 @@ URL.
-(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.)
Dynamic confirmation of meaning of text entry boxes
@@ -83,7 +74,7 @@ to fit in a URL.)
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".
Trades for route
@@ -101,7 +92,7 @@ archipelago, you must enter the archipelago name twice.
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.
@@ -187,6 +178,20 @@ You can enter the value in the box either as a percentage, or as a
fraction 1/
divisor, eg 1/2000 is the same as 0.05%; in each
case it is taken as the loss for each league of the voyage.
+
+
+If you select
Also be cautious about stalls' poe reserves,
+YARRG will calculate a minimum amount of poe that each stall has on
+hand (by looking at all the offers that stall is making), and never
+plan for you to sell goods at that stall for more than the available
+poe.
+
+
+
+Goods planned to be bought at the stall (which might boost the stall's
+poe reserves) are not considered, to avoid having to calculate the
+stall's cash reserves at various different times.
+
If you don't specify the amount of capital you have available to