can upload

[ypp-sc-tools.db-live.git] / pctb / README

diff --git a/pctb/README b/pctb/README
index 240ff7267400228cbb0916802eca123e862099f3..49f2c28e006375d8ddd7d6c86867c3e458af5af0 100644 (file)
--- a/pctb/README
+++ b/pctb/README
@@ -4,7 +4,7 @@ Overview
 This tool can:
   - screenscrape the commodities trading screen
   - produce the results as a tab separated values file
 This tool can:
   - screenscrape the commodities trading screen
   - produce the results as a tab separated values file

-  - **TODO** upload the results to PCTB
+  - upload the results to PCTB

 
 To run it, change to this directory, type `make', and then:
   ./ypp-commodities --tsv >commods.tsv
 
 To run it, change to this directory, type `make', and then:
   ./ypp-commodities --tsv >commods.tsv


@@ -75,17 +75,42 @@ The program reads and writes the following files:
    it.  Don't try `display vid:#pages#.pnm' as this will consume
    truly stupendous quantities of RAM - it wedged my laptop.
 
    it.  Don't try `display vid:#pages#.pnm' as this will consume
    truly stupendous quantities of RAM - it wedged my laptop.
 

- * charset-15.txt
+ * #master-newcommods#.txt #local-newcommods#.txt

 
 

-   Character set dictionary.  For the semantics of the contents of this
-   file see README.charset.  There is not currently any accurate
+   Dictionary of newly introduced commodities.  When a new commodity
+   appears in Puzzle Pirates, the PCTB server operators need to add it
+   to their database for us to be able to upload data about it.
+
+   It can sometimes take a few days to do this.  In the meantime, it
+   is possible to upload partial data - data just omitting that
+   commodity.  This is controlled by these files: they list
+   commodities which should be automatically ignored if the PCTB
+   server doesn't know about them.  The master file is downloaded and
+   updated automatically from my server.  You may create the local
+   file yourself.  The format is simple: one commodity per line.
+
+   Unrecognised commodities can also be due to OCR failure so
+   double-check what you're doing before overriding the uploader by
+   telling it to ignore an unrecognised commodity.
+
+ * #master-char*#.txt  #local-char*#.txt
+   #master-pixmap#.txt #local-pixmap#.txt
+
+   Character set and image dictionaries.  For the semantics of the
+   char* files README.charset.  There is not currently any accurate

    documentation of this dictionary format.
 
    documentation of this dictionary format.
 

-   If you delete this file you'll have to re-enter a lot of glyph data
-   (and probably get it wrong and make the program misrecognise
-   things).  If you want to undo any mistakes you may have made
-   answering OCR questions you can safely revert this to the version
-   I've supplied.
+   #master-*#.txt contain the centrally defined and approved data.
+   They are downloaded automatically from the SC PCTB server and
+   updated each run.  You can safely delete this file, if everything
+   is online, if you want to fetch a fresh copy.
+
+   #local-*#.txt are a local copy of your submissions, so that they
+   will be used by your client pending approval by me.  You can delete
+   this file if you think you may have made a mistake.
+
+   See README.privacy for details of the communications with the SC
+   server about the contents of these dictionaries.

 
  * #commodmap#.tsv
 
 
  * #commodmap#.tsv
 


@@ -93,6 +118,12 @@ The program reads and writes the following files:
    server.  This is fetched and updated automatically as necessary.
    It can safely be deleted as it will then be refetched.
 
    server.  This is fetched and updated automatically as necessary.
    It can safely be deleted as it will then be refetched.
 

+ * #upload-1#.html #upload-2#.html
+
+   We screenscrape the pages from the PCTB upload server.  The actual
+   HTML returned from the upload server is left in these dropping
+   files for debugging etc.
+

  * <file>.new
 
    When any of these tools overwrite one of the persistent dictionary
  * <file>.new
 
    When any of these tools overwrite one of the persistent dictionary