home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / dirs / cross_464.lzh / Cross / Cross.docE < prev    next >
Text File  |  1991-03-09  |  10KB  |  283 lines
  1. Crossword Puzzle Creator V3.3
  2. -----------------------------
  3.  
  4. Copyright © 1991 by Jürgen Weinelt
  5.                     Zur Kanzel 1
  6.                     D-8783 Hammelburg
  7.                     Germany
  8.  
  9. Crossword Puzzle Creator (CPC) V3.3 is Freeware.
  10.  
  11. Limited licence is granted for non-commercial distribution.
  12.  
  13. This distribution includes source code in Modula-2 (M2Amiga Compiler by
  14. A+L AG, Switzerland)). Please note though that the source is not as
  15. readable as I'd like it to be; this is because CPC was originally
  16. written in C-64 BASIC about 5 years ago.
  17.  
  18. Note: Use this program at your own risk, that is, if it breaks something,
  19.       don't bother me with your problems. I think this is a fair deal;
  20.       please remember you don't have to pay for this program.
  21.       I'd still like to know about major bugs...
  22.  
  23. Note: CPC accesses the printer via the PAR:-device, because it uses
  24.       the graphics mode of the printer to print the crossword puzzle.
  25.       CPC should work smoothly with any EPSON-compatible printer (although
  26.       it was tested with my Star NL10 only).
  27.       The crossword solution is printed through the PRT:-device.
  28.  
  29. Note: CPC needs lots of memory. There may be troubles on 512K-Amigas,
  30.       especially if there are several disk drives present. This MAY be a
  31.       compiler problem, since M2Amiga itself behaves strangely in low mem
  32.       situations, too (see the README on your compiler system disk for
  33.       details).
  34.  
  35. Note: CPC was created on my A1000 with 2.5MBytes, hard disk and Kick/WB 1.3.
  36.       If you find any bugs, please send me a detailed report, including a
  37.       description of your system configuration (hardware AND software!)
  38.  
  39. Note: I apologize for any mistakes I may have made in this text; as you
  40.       probably guessed from my address, English is not my native language...
  41.  
  42.  
  43.  
  44. How to start it
  45. ---------------
  46. CROSS [-xXSIZE] [-yYSIZE] [-d]
  47.          (1)       (2)     (3)
  48.  
  49. CPC accepts up to 3 parameters:
  50.  
  51.  (1) horiz. size; 5<=XSIZE<=39; Default: 19
  52.  
  53.  (2) vert. size;  5<=YSIZE<=35; Default: 19
  54.  
  55.  (3) Debug-mode for the message data file; will be explained later.
  56.  
  57. Parameters may be stated in any order. All parameters are optional.
  58.  
  59.  
  60.  
  61. Before calling CPC, you'll have to install (with ASSIGN) a logical device
  62. named "CROSS:"; this is where CPC is looking for its data files:
  63.  
  64.  (1) DATA               (directory)
  65.  
  66.  (2) DATA/msgtxt.data   (data file with multilingual program messages)
  67.  
  68.  (3) DATA/words01.crw   (word data file)   or
  69.      DATA/words02.crw   (word data file)
  70.  
  71.  (4) DATA/ (...) .crd   (crossword puzzle data files)
  72.  
  73. There are two word data files in this release:
  74.   words01.crw contains German words
  75.   words02.crw contains English words
  76.  
  77.  
  78.  
  79. Usage
  80. -----
  81. CPC is quite self-explaining. Just some important notes:
  82.  
  83.  - first of all CPC tries to read the message data file. Then you get
  84.    a list of all languages available (just German and English at the
  85.    moment), from which you can choose one (enter number, then press return).
  86.    A detailed description of the message data file follows later.
  87.  
  88.  - CPC is (almost) completely controlled by the gadgets on the right side
  89.    of the screen. The meaning of these gadgets should be obvious.
  90.  
  91.  - some notes on the "auto search mode" gadget:
  92.  
  93.     * there must be a word data file in memory.
  94.  
  95.     * at least one word must have been placed before you can use a.s.mode.
  96.       This word is a "seed", from which the puzzle "grows".
  97.  
  98.     * to turn a.s.mode off, just click the a.s.mode gadget again.
  99.       The current search will be finished, though.
  100.  
  101.     * you can load another word data file at any time, provided that the
  102.       a.s.mode is off.
  103.  
  104.  - notes on the "reset limit"-gadget:
  105.  
  106.     * CPC tries to place the longest words first; the "limit"-variable shows
  107.       the lower limit for the word length currently in effect.
  108.  
  109.     * use the "reset limit"-gadget to reset it to the initial (high) value.
  110.  
  111.  
  112.  
  113. message data file
  114. -----------------
  115. This file contains virtually every text used by CPC, at the moment in both
  116. German and English. Other languages can be added easily.
  117. Every entry in the message data file uses exactly one line.
  118.  
  119.  
  120.  
  121. Structure of the message data file
  122. ----------------------------------
  123. The first line of the message data file contains one single digit; this is
  124. the number of languages currently available.
  125.  
  126. This is followed by the name of each language (for example ENGLISH and
  127. DEUTSCH).
  128.  
  129. The following entries are present once for each language, too. These are the
  130. program messages.
  131.  
  132. If you want to add another language to the message data file, please make
  133. sure that your translation has approx. the same size as the original
  134. message, because some of them appear in requesters or gadgets.
  135. Every entry must start with a three-digit number. This number must be
  136. identical with the actual number (count 'em) of this message (sounds
  137. difficult; just take a close look at the message data file, you'll see what
  138. it means...).
  139. Entry number "999" which signals the "End of file" is the only exception
  140. to this rule.
  141.  
  142. If you encounter any problems after adding another language, just
  143. call "Cross" with the message debug mode on (parameter "-d"). This causes
  144. the message numbers to be displayed with the messages themselves; it will
  145. (hopefully) help you locate the problem.
  146.  
  147.  
  148.  
  149. ¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡¡
  150. ############################################################################
  151. Have you added another language to the message data file? Please send me a
  152. copy of your message data file on disk, it'll be included with the next
  153. release of CPC. As a reward I'll send your disk back with another one of my
  154. PD programs.
  155. ############################################################################
  156. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  157.  
  158.  
  159.  
  160. Word data files
  161. ---------------
  162. If you want to create your own word data files, please note:
  163.  
  164.  (1) Every word must be enterd in CAPITAL letters.
  165.  
  166.  (2) Only characters "A" trough "Z" are allowed.
  167.  
  168.  (3) The word length should always be odd, that is, 3, 5, 7, ... 25; (except
  169.      for two letter words). Maximum length is 25, minimum is 2.
  170.      These limitations are needed to improve the structure of the puzzle.
  171.      You MAY use words with even length, but this will probably cause larger
  172.      gaps in the crossword puzzle.
  173.  
  174.  (4) The word data file must not contain empty lines.
  175.  
  176.  (5) The last entry must be "***END***", without quotation marks, of course.
  177.  
  178.  
  179.  
  180. Yes, you're right. There is an easier way of creating word data files...
  181. Just run any standard ASCII text file through the "PreProcessor", which
  182. should also be somewhere in the "Cross" drawer. PreProcessor will break it
  183. down into single words and will remove anything illegal. You'll have to use
  184. your favourite editor though to delete all those words you don't want to use.
  185. There may also be some "crippled" words that didn't survive the PreProcessor.
  186.  
  187. Usage of the PreProcessor:
  188.   PreProcessor
  189.  
  190. There are no command line parameters; file selection is done by ARP file
  191. requesters.
  192.  
  193. Note: The PreProcessor uses a recursive algorithm (builds a binary tree
  194.       to sort the words); please make sure there's enough stack space
  195.       available. You can increase the stack space with a CLI command
  196.       called "STACK".
  197.       I'm always setting the stack space to 50000 bytes.
  198.       PreProcessor is very greedy anyway... i'm sure there's going to be
  199.       trouble with it on 512K Amigas if you try to convert large ASCII
  200.       text files.
  201.  
  202.  
  203.  
  204. Just a warning: if your word data file is very large (that is, if it
  205. contains MANY, MANY, MANY words), the creation of the crossword puzzle will
  206. be slowed down considerably. In order to avoid this effect, you might use
  207. several small word data files, loading the next when the current file is
  208. used up.
  209.  
  210. An example:
  211.  
  212.   File        | word length
  213.   ------------+------------
  214.   words05.crw | 25..17
  215.   words06.crw | 15.. 9
  216.   words07.crw |  7.. 5
  217.   words08.crw |  3.. 2
  218.  
  219.  
  220.  
  221. Known problems/bugs of CPC
  222. --------------------------
  223.  - strange behaviour in low mem situations (occurs only during startup):
  224.    program sometimes hangs (reason: unknown; might be a compiler problem)
  225.  
  226.  - (very seldom) memory fragmentation (reason: unknown)
  227.  
  228. If you encounter any bugs, please send me a detailed report.
  229.  
  230.  
  231.  
  232. Things to be done
  233. -----------------
  234.  - "GENERIC"-mode for puzzle printing via PRT:
  235.  
  236.  - high resolution crossword puzzle printing via PAR:
  237.  
  238.  - removing an already placed word
  239.  
  240.  - several patterns for setting the "seed" word(s)
  241.  
  242.  - icons for all data files
  243.  
  244.  - NEW option
  245.  
  246.  - NEW_SIZE option
  247.  
  248.  - user configurations
  249.  
  250.  - (possibly) storing word data in dynamic structures (linked lists);
  251.    I'm still thinking about this one.
  252.  
  253.  - puzzles with custom layouts instead of rectangles.
  254.  
  255.  
  256.  
  257. History
  258. =======
  259.  
  260. V3.3    automatic PAL/NTSC recognition by examining "height" field of
  261.         workbench screen
  262.         fixed some minor errors in program and documentation
  263.  
  264. V3.2    first RELEASE of M2 version on AMOK
  265.  
  266.  
  267.  
  268. Enjoy!
  269.  
  270.  
  271.  
  272.                    ####################################
  273.                  ########################################
  274.                 ##                                      ##
  275.                ##    /¯¯¯¯\   \\|||// \              /   ##
  276.                ##   /      \  \|o o|/  \            /    ##
  277.                ##          |   | . |    \    /\    /     ##
  278.                ##   \      /   | ' |     \  /  \  /      ##
  279.                ##    \____/    \ ~ /      \/    \/       ##
  280.                 ##              ¯¯¯                     ##
  281.                  ########################################
  282.                    ####################################
  283.