home *** CD-ROM | disk | FTP | other *** search
/ Hot Shareware 35 / hot35.iso / ficheros / VCHESS / MAILPGN.ZIP / MAILPGN.TXT < prev   
Text File  |  1998-05-09  |  12KB  |  285 lines
  1.  
  2.                   MAIL PGN GAMES EXTRACTOR
  3.                   -------------------------
  4.  
  5.  
  6. Hello, I'm Paolo Buratti and I've done this program for all friends of 
  7. chess.net and ICC (and other chess site, too).
  8. (MailPgn is a full free pubblic domain program.)
  9. I enabled my AUTOMAIL e PGN variables, this means that I everyday receive via 
  10. email many chess games ( they are only email messages that I receive :-[  
  11. Before MailPgn, I extracted out everyday from email my chess game with 
  12. long and annoying  copy & paste operations. A good day I had an idea: to do a
  13. program that does for me that annoying job. 
  14.  
  15. MailPgn is a chess games extractor from email messages for Windows3.1+win32s or 
  16. Windows95. It reads directly from
  17. in-box file all messages and recognizes those of chess nature, then it writes
  18. them in a sole ascii file. This is usefull to render more fast and simple the
  19. import operations in chess programs like chess-base or task-base.
  20.  
  21.  
  22.  
  23.                MARK REMARKS AND NOTES ABOUT MAILPGN
  24.               ---------------------------------------
  25. Using MailPgn is very simple, however here above it follows any marks about:
  26.  
  27.         A) INSTALLATION
  28.         B) LOCATE IN-BOX FILE
  29.         C) MENU COMMANDS
  30.         D) PREFERENCES SETTINGS
  31.           E) TECHNICAL NOTES
  32.           F) IN KIND PAYMENTS
  33.  
  34. A) INSTALLATION *********************************************************
  35.  
  36. MailPgn is a very little program for this reason I've not done any huge
  37.  extra large installation program.
  38.  
  39. To install MailPgn:
  40.  
  41.     1) Create a new directory named: "MailPgn" 
  42.     2) Copy in, the files: MailPgn.exe and MailPgn.txt
  43.     3) Smile: you are already on good point :-) 
  44.     *4) From Windows 3.1 environment:
  45.        A) Open program group where you wish place MailPgn
  46.        B) Select File Menu -> New -> Single program
  47.        C) Write in description box: Mail Pgn Games Extractor
  48.        D) Browse to search MailPgn directory
  49.        E) Select MailPgn.exe file
  50.        F) Click on OK
  51.        G) Now, we'll name you Einstein :-]
  52.     *4) From Windows 95 environment
  53.        A) Open program group where you wish place MailPgn
  54.        B) Click left mouse button in window program group without hit any icon
  55.        C) Press right mouse button and select new-> link file
  56.        D) Browse to search MailPgn directory
  57.        E) Select MailPgn.exe file
  58.        F) Select Next (or OK) 
  59.        G) Write in description box: Mail Pgn Games Extractor
  60.        H) Now, we'll name you Einstein :-]
  61.  
  62. B) LOCATE IN-BOX FILE ******************************************************
  63.  
  64. You could have any trouble to find in-box file :-(
  65. Before pressing Browse button (in set up preferences window), select right kind
  66. email program.
  67. I'm italian and my version of Windows 95 is italian too. However indicatively
  68. these are the directories where should be in-box file for specific programs:
  69.  
  70. --- EUDORA MAIL PROGRAM ----
  71.  
  72. C:\EUDORA                    <- DIRECTORY
  73.  
  74. IN       MBX        37.521  07/05/98  13.49 IN.MBX      <- THIS IS IT
  75. IN       TOC         8.234  07/05/98  13.48 IN.TOC      <- NOT THIS
  76. OUT      MBX         1.783  06/04/98  22.25 OUT.MBX
  77. TRASH    MBX         4.055  10/01/98  21.06 TRASH.MBX
  78.          3 file         45.789 byte
  79.          0 dir       157.626.368 byte disponibili
  80.  
  81. --- MICROSOFT OUTLOOK EXPRESS
  82.  
  83. C:\Programmi\Outlook Express\Default User\Mail    <- DIRECTORY
  84.  
  85. POSTAI~2 IDX         1.200  02/05/98  22.37 Posta in uscita.idx
  86. POSTAI~2 MBX         5.060  02/05/98  22.37 Posta in uscita.mbx
  87. POSTAI~3 IDX         1.200  02/05/98  22.37 Posta inviata.idx
  88. POSTAI~3 MBX         5.060  02/05/98  22.37 Posta inviata.mbx
  89. POSTAE~1 IDX        13.900  07/05/98  15.27 Posta eliminata.idx
  90. POSTAE~1 MBX     3.039.020  07/05/98  15.27 Posta eliminata.mbx
  91. BOZZE    MBX       270.080  05/05/98  19.31 Bozze.mbx
  92. BOZZE    IDX        19.168  07/05/98  15.44 Bozze.idx
  93. POSTAI~1 MBX       264.948  07/05/98  15.59 Posta in arrivo.mbx  <- THIS IS IT
  94. POSTAI~1 IDX        17.660  07/05/98  15.59 Posta in arrivo.idx  <- NOT THIS
  95.         14 file      3.643.161 byte
  96.          2 dir     1.438.515.200 byte disponibili
  97.  
  98. NOTE: "Posta in arrivo" means: "In box mail"
  99.  
  100. ---- NETSCAPE MESSANGER
  101.  
  102. C:\Programmi\Netscape\Users\md6283\Mail    <- DIRECTORY (NOTE: md6283 is my
  103.                                                    user-id)
  104.  
  105. INBOX               37.265  07/05/98  14.44 Inbox        <- THIS IS IT
  106. INBOX    SNM         7.856  07/05/98  14.45 Inbox.snm   <- NOT THIS
  107. DRAFTS                   0  05/04/98  23.45 Drafts
  108. DRAFTS   SNM         2.568  05/04/98  23.45 Drafts.snm
  109. TRASH                    0  05/04/98  23.45 Trash
  110. TRASH    SNM         2.568  05/04/98  23.45 Trash.snm
  111. SENT                 4.343  08/04/98  21.54 Sent
  112. SENT     SNM         6.048  19/04/98  23.23 Sent.snm
  113. UNSENT~1                 0  05/04/98  23.45 Unsent Messages
  114. UNSENT~1 SNM         2.576  05/04/98  23.45 Unsent Messages.snm
  115. POPSTATE DAT           169  07/05/98  14.44 popstate.dat
  116.         11 file         63.393 byte
  117.          2 dir     1.438.515.200 byte disponibili
  118.  
  119. C) MENU COMMANDS *********************************************************
  120.  
  121. Set Preferences
  122. -----------------
  123.  
  124. It allows to set any value like full-path of in-box file, destination pgn 
  125. file name, flag PGN only, mask search for subject field ect (See below).
  126.  
  127. Load & Save Preferences
  128. -------------------------
  129.  
  130. Load & Save prefrences are not necessary if you use only one email program.
  131. Default preferences file (named MailPgn.prf) will be loaded and saved,
  132. automatically everytime MailPgn will start and end a job session.
  133. You could use Load & Save preferences if you use differents email programs or
  134. different settings for scanning in-box file.
  135.  
  136. Start Game Extraction
  137. ------------------------
  138.  
  139. This command start scanning of you in-box email file. If you have not set any
  140. preferences (in past), you will be prompted for set preferences.
  141. The chess games founded will be written in destination file set in preferences.
  142. MailPgn will write a game report list,too. 
  143. Game report list doesn't contain chess games but it holds 
  144. only statistical references of every game played. For example:
  145.  
  146. "PaulaJones(4646) - Clinton(6969)  lightning  0-1"
  147.  
  148. (Very high rate...)
  149. In bottom there will be also a summary of your 
  150. won/drawn/lost/adjourned/aborted games and kind played games (Blitz, Wild ect).
  151. Game report list file will have same name of destination chess games file but 
  152. it will have ".lst" extension.
  153.  
  154. D) PREFERENCES SETTINGS ****************************************************
  155.  
  156. Preferences window is divided into five frames. 
  157.  
  158. 1)  "In-box source" frame
  159.  
  160. Explainations about select in-box file are above in this same document.
  161.  
  162. Note: Microsoft and Eudora in-box file have an ".MBX" extension, while
  163. Netscape has NONE extension. Before browsing set right email program kind.
  164.  
  165. 2) "PGN Destination File" frame
  166.  
  167. The chess games extracted from MailPgn will be written in ascii-pgn-file chosen
  168. by you.
  169.  
  170. If you set "Create" open mode, the games of last scanning will be overwritten 
  171. on old games. If you set "Append", the new games will be added on old games, 
  172. in bottom file. Games report list file will use same open mode.
  173.  
  174. If you set "Remove too new PGN token", MailPgn will remove too recent pgn token,
  175. from chess games, before writting in ascii file. PGN format has had very changes 
  176. and improvments in last years. Many chess programs like file chess program or
  177. PGN reader, or converter utility (like CBASCII) could not recognize newest PGN
  178. token and break the run with a syntax error. For example chess.net uses 
  179. [TimeControl] and [Mode] token that CBASCII for MSDOS don't accept (It stops with 
  180. message: "'[' spurios character founded in game ..." ). If you have these
  181. troubles you switch on "Remove too new PGN token" and MailPagn will remove
  182. all latest token, let them only standard PGN tokens like these: [Event ;
  183. [Site ; [Date ; [Round ; [White ; [Black ; [Result ; [Eco ; [WhiteElo ;
  184. [BlackElo ; [Annotator ; [FEN .
  185.  
  186.  
  187. 3) "Scan only email messages" frame
  188.  
  189. MailPgn will scan only email messages that hold in subject field the string
  190. specified by you in editor box. If this editor is empty, MailPgn will scan 
  191. every email messages.
  192.  
  193. Tip: If you would like extract only adjourned game you could set string 
  194. "adjourned", if you wish extract only your game vs Babaloo (an handle name) 
  195. set string "Babaloo" ect.
  196.  
  197. If you flag "Only pgn format", the chess games are not in PGN format will be
  198. ignored
  199.  
  200. Warning: if you use a null string for search mask in subject field, and don't
  201. switch on "with pgn chess format" it could be probably that MailPgn inserts
  202. in destination file a little of trash. If in an email message there are strings
  203. like "1/2-1/2", "wild" ect. MailPgn recognizes this message like a chess game.
  204. This happens only when "only pgn format" is disabled.
  205.  
  206.  
  207. 4) "My Nickname (handle)" frame
  208.  
  209. If you wish have a statistical game report list (to save in an ascii file) you
  210. must write your battle-name, ie the  handle (nickname, alias ect).
  211. If MailPgn knows your handle, it could calculate your total score in last scanned
  212. games. (Win/Lost/Drawn ect)
  213.  
  214. 5) "Execute Program" frame
  215.  
  216. If you wish analyse immediatly the chess games just scanned, you could set
  217. the execution of a convert/import program after scanning. For example you
  218. could like convert PGN chess games in Chess Base format whereby CBASCII or
  219. starting a reader PGN program to watch your chess games.
  220.  
  221. Tips: If your translate procedure is enough complex you could create a batch file
  222. with extension .BAT to execute more programs. 
  223. Note: If you work in Windows 95 environment, last line of BAT file 
  224. should be "EXIT" (Otherwise it'll wait you close the window)
  225.  
  226. If you insert in command line editor the characters couple "%s", MailPgn
  227. before running the executable program will substitute "%s" with active PGN 
  228. destination file name.
  229.  
  230. If you switch on "and exit from Mailpgn" box, MailPgn, after be launched
  231. applicative, will terminate.
  232.  
  233. Note: if applicative is a MS-DOS program and you are in Window95 environment
  234. it's possible you need select right icon on menu row (at bottom desktop) to
  235. watch newer program.
  236.  
  237. Note: If checkbox "Execute program (after scannign)" is not flagged, MailPgn
  238. will ignore Execute name and command line fields.
  239.  
  240.  
  241. E) TECHNICAL NOTES *******************************************************
  242.  
  243. I) MailPgn will not parse email messages with content-type different by
  244.    text/plain. It will ignore messages in html format and/or 
  245.    multipart/form-data.
  246.  
  247. II) At beginning I thought to allow to MailPgn to extract and remove scanned 
  248.     games from in-box mail. But I've had
  249.     many troubles with Microsoft Outlook Express. Now MailPgn doesn't write or
  250.     modify anything in in-box file. 
  251.     This means two news one good and one bad:
  252.    
  253.     Good News: You will not have to fear that MailPgn could damage your email 
  254.                messages, because it will read them simply.
  255.     Bad news:  You shall erase manually email messages just scanned.
  256.  
  257. III) MailPgn is able to scan chess games in not PGN format, too. However it could
  258.      have any trouble to recognize player names. Actually it (if not pgn format)
  259.      search for "vs." string, if it founds it, will extract white player at
  260.      left, and black player at right.
  261.  
  262. IV) If after a scansion there are "not recognized email headers" (different
  263.     by zero number) it's probably that kind email program chosen by you are 
  264.     wrong. You should change it.
  265.  
  266.  
  267. F) IN KIND PAYMENTS *******************************************************
  268.  
  269. I play chess everyday on chess.net or ICC with handle "Paolone". If you have
  270. appreciated my program, please let me win some games in future.
  271.  
  272. If you are a beautiful girl there will be another method to repay me  :-}
  273.  
  274. P.S.
  275.  
  276. Last News: My mother language is not english. 
  277. I suppose you are very surprised about this news. However if a very WASP 
  278.  mom-english language person wishes rewrite this document in a good english 
  279. I'll be happy, but please: don't erase my important name :-(
  280.  
  281.       Bye Bye, nice things
  282.  
  283.           Paolo
  284.  
  285.