Leave PCTB server text in #upload-1#.html

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

diff --git a/pctb/README b/pctb/README
index e2452ddec32dd8a85a93f04a0390588c2e301ebf..e9f4f097b06adb1e6fe73a9c4a5a5b34766170a7 100644 (file)
--- a/pctb/README
+++ b/pctb/README
@@ -75,17 +75,24 @@ 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-char*#.txt  #local-char*#.txt
+   #master-pixmap#.txt #local-pixmap#.txt

 
 

-   Character set dictionary.  For the semantics of the contents of this
-   file see README.charset.  There is not currently any accurate
+   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 +100,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


@@ -118,6 +131,7 @@ This program has quite a few dependencies:
  - pnm command line utilities for image manipulation   netpbm
  - X11 libraries, including dev files for building     libx11-dev
  - XTEST library, including dev files for building     libxtst-dev
  - pnm command line utilities for image manipulation   netpbm
  - X11 libraries, including dev files for building     libx11-dev
  - XTEST library, including dev files for building     libxtst-dev

+ - Perl-compatible regexp library, including dev files  libpcre3-dev

  - Tk interpreter /usr/bin/wish                                tk8.4
  - Perl module XML::Parser                             libxml-parser-perl
  - Perl module JSON::Parser                            libjson-perl
  - Tk interpreter /usr/bin/wish                                tk8.4
  - Perl module XML::Parser                             libxml-parser-perl
  - Perl module JSON::Parser                            libjson-perl