home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / 1997 / 916 / REVISER.TXT < prev    next >
Encoding:
Text File  |  1997-01-23  |  8.7 KB  |  309 lines
  1. Reviser v1.1
  2. 22nd January 1997
  3.  
  4. Phil Whiles
  5. 4 Ivy Cottages
  6. Boyatt Lane
  7. Otterbourne
  8. Winchester
  9. Hants SO21 2HT
  10.  
  11.  
  12. Contents
  13.     What is Reviser ?
  14.     History
  15.     Registration
  16.     Installation
  17.     Source file format
  18.     Data Conversion
  19.     Test Files
  20.     Config Test
  21.     Config Sound
  22.     Config Graphics
  23.     Start - Q.Field X
  24.     Start - Q.Field Y
  25.     Start - Random
  26.     Start - Clear
  27.     Start - Mark
  28.     Marking
  29.     Warranty
  30.  
  31. What is Reviser ?
  32. -----------------
  33. Reviser is a learning aid which reads
  34. a data file you prepare, and presents
  35. a series of random flash card dialogs,
  36. the first showing a 'question', and the
  37. second showing the 'answer'.
  38.  
  39. What sets its aside from a simple random
  40. selector is that it can present subsets of
  41. questions from larger sets, provided you
  42. adopt a simple numbering scheme in your
  43. database.
  44.  
  45. As a test progresses, you get the option to
  46. mark questions which are easy, or that you are
  47. confident about. Once it has asked all the 
  48. questions in the subset, Reviser shuffles up
  49. the unmarked questions and starts the test
  50. again, allowing you to concentrate on the
  51. questions you have difficulty with.
  52.  
  53. History
  54. -------
  55. Reviser was written to help me in learning Japanese
  56. Vocabulary and Grammar. I had been entering the
  57. vocabulary I had coverered in the course book, into
  58. one large database file on my Psion, so that I could
  59. search the covered vocab. in one file. As I went along,
  60. I recorded the lesson that each word came from in the
  61. book, and a grouping so that Reviser, even in its
  62. earliest form, could select subsets from lessons. 
  63.  
  64.  
  65. v1.0    18/12/96     First Release
  66. v1.1    22/01/97     Fixed a clear/mark bug
  67.                                 Added Edit labels
  68.                                 Added % info summary at start of test
  69.                                 Added "Are you sure ?" on Esc from test
  70.                                 
  71. Registration
  72. ------------
  73. Reviser is shareware. If you find it useful, and wish
  74. to continue using it, please register. For the
  75. small fee requested, you receive a personal password
  76. which once entered removes the annoying nag screens.
  77.  
  78. In registering, you encourage the development of even
  79. more quality software for the Psion !
  80.  
  81. If you provide an email address with your registration
  82. I shall also send you future upgrades to Reviser.
  83.  
  84. To register send either £10 or $20 US as either cash
  85. ,UK cheque or Eurocheque to the address at the top of this
  86. document. If you send cash, please put it between
  87. two sheets of stiff paper, to disguise it in 
  88. the envelope !
  89.  
  90. Installation
  91. ------------
  92. The following shows where Revisers files need to be
  93. installed. To help you get the hang of the source
  94. file format, (described later), I have included my
  95. own Japanese Language database, and the associated
  96. tests, marked in the following list with an '*' :
  97.  
  98. \APP\                        REVISER.OPA (the executable)
  99.  
  100. \APP\REVISER\        REVISER.PIC (the graphic)
  101.                                 REVISER.RSC (optional help)
  102.  
  103. \OPD\                        REVISER.REG (once registered)
  104.  
  105. \DAT\                    *    NIHONGO.DBF (source data)
  106.  
  107. \TST\                    *    MONTHDAY.TST (test files)
  108.                             *    WEEKDAY.TST 
  109.                             *    COUNTRY.TST 
  110.                             *    OCCUP.TST   
  111.                             *    SML_NOS.TST 
  112.                             *    GRAMMAR.TST 
  113.                             *    SENTENCE.TST
  114.                             *    VOCAB.TST   
  115.                             *    TIME.TST    
  116.                             *    MONTHS.TST  
  117.                             *    COUNTERS.TST
  118.                             *    BIG_NOS.TST 
  119.                             *    OCLOCK.TST  
  120.                             *    ALL.TST     
  121.                             *    LESSON01.TST
  122.                             *    LESSON02.TST
  123.                             *    LESSON03.TST
  124.                             *    LESSON04.TST
  125.                             *    LESSON05.TST
  126.                             *    LESSON06.TST
  127.  
  128. Source file format
  129. ------------------
  130. Reviser reads a standard Data file that you
  131. provide, but that file must have the following
  132. format :
  133.  
  134. Field   Desc.     Example
  135. -----   ------    ----------
  136.   1     Mark      0 (or 1)
  137.   2     Lesson    4
  138.   3     Group     2
  139.   4     Field X   Hello
  140.   5     Field Y   Bonjour
  141.  
  142. Reviser scans the file for records that are not
  143. marked (0), falling within the lesson and group
  144. range specified under Config - Test. It then
  145. shuffles all those up (in memory) and randomly
  146. selects questions, presenting either 'field X' or
  147. 'field Y' as the question followed by the
  148. corresponding answer ('field Y' or 'field X').
  149.  
  150. It can either be set to always use 'field X' as the
  151. question, or 'field Y', or it can choose either on a 
  152. random basis. (See the Start menu)
  153.  
  154. Because the fields in the Psion Database application
  155. are all strings, if you want to be able to sort 
  156. your source file into lesson/group order, say with
  157. JBDATA, or if you want Reviser to be able to select
  158. subsets properly ie a range of questions, give some
  159. thought to how strings are compared :
  160.  
  161. ie string "2" is greater than "199" ,
  162. so a group range of "1" to "199" does
  163. not include "2".
  164.  
  165. Data Conversion
  166. ---------------
  167. To allow you to get your data into Revisers format
  168. there is a Data Conversion menu option under File.
  169. This will take a simple database file having only
  170. two fields, field X and field Y, and convert it
  171. into the 5 field format required by Reviser.
  172.  
  173. To simplify the job, you may enter defaults for
  174. the mark,lesson and group fields, and choose
  175. either an automatic mode, where each record uses
  176. these defaults, or an interactive one, where you
  177. may elect to overide these defaults on a per
  178. record basis. If you have a source data file having
  179. more than two fields, I will be glad to convert it 
  180. for you !
  181.  
  182. Test Files
  183. ----------
  184. The files that Reviser creates and which appear
  185. under its icon on the system screen, are the
  186. 'test' files. When a test file is first created,
  187. you provide the name and location of the test's
  188. source data file, and the labels you wish to be
  189. associated with 'field X' and 'field Y'.
  190.  
  191.  ie 'English' and 'French'.
  192.  
  193. Reviser uses these labels when asking it's questions.
  194. The test config is also saved as part of the test
  195. file, which by default includes all questions in the
  196. source file.
  197.  
  198. To setup a test to have different test config
  199. change it's config (Config-Test), then
  200. Save (File-Save).
  201.  
  202. Config - Test
  203. -------------
  204. Reviser allows a type of specialisation
  205. in its question selection, in that it can
  206. select questions from subsets within 
  207. subsets of questions.
  208.  
  209. ie each question/answer in the data file
  210. you prepare for Reviser, has two fields
  211. indicating the lesson and grouping/type of
  212. question that it is.
  213.  
  214. If you do not wish to make use of this 
  215. feature dont worry, simply mark each
  216. question as being in lesson 1 group 1,
  217. and make sure that Reviser is configured
  218. to select using those criteria. 
  219.  
  220. Config - Sound
  221. --------------
  222. Reviser will give two differently pitched
  223. beeps if Sound is on, one on a question, and
  224. the other on the answer.
  225.  
  226.  
  227. Config - Graphics
  228. -----------------
  229. When graphics is on, Reviser shows a graphical
  230. progress bar when it generates an index of your
  231. database at the start of the test sequence.
  232.  
  233. It will also show a similar graphic when it
  234. shuffles a test having more than 50 matches.
  235.  
  236. When graphics is off, a simple 'busy' type message
  237. is displayed.
  238.  
  239. Start - Q.Field X
  240. ---------------------
  241. The database will be indexed and the test sequence
  242. started with questions being 'field X' and answers
  243. being 'field Y'. ie would allow you to test your 
  244. translation of English to French.
  245. (The menu doesn't show 'field X' or 'field Y' but uses
  246. the labels that you gave when the test file was
  247. created.)
  248.  
  249. Start - Q.Field Y
  250. ---------------------
  251. The database will be indexed and the test sequence
  252. started with questions being 'field Y' and answers
  253. being 'field X'. ie would allow you to test your 
  254. translation of French to English.
  255.  
  256. Start - Random
  257. --------------
  258. The database will be indexed and the test sequence
  259. started with questions and answers being of mixed
  260. types ie Question in English or French.
  261.  
  262. Start - Clear
  263. -------------
  264. Will clear the Mark field in all the records in
  265. the current database, matching the current Test
  266. Configuration criteria. These question will then
  267. get asked on subsequent test runs.
  268.  
  269. Start - Mark
  270. ------------
  271. Will set the Mark field in all the records in
  272. the current database, matching the current Test
  273. Configuration criteria. These question will then
  274. not get asked on subsequent test runs.
  275.  
  276. Marking
  277. -------
  278. Once a test sequence has been started, 
  279. with each answer you get 3 choices for
  280. marking of that particular Q/A :
  281.  
  282. o None
  283. o Memory
  284. o File
  285.  
  286. Once all questions in a test have been
  287. asked, Reviser shuffles up its test
  288. index and starts again.
  289.  
  290. None means ask this question again next
  291. time round.
  292.  
  293. Memory means mark this question in memory
  294. only and dont ask it next time round
  295. (in this 'loop', ie next time the test
  296. is loaded it will still get asked again)
  297.  
  298. File means mark the question in the source
  299. file such that it wont get asked again,
  300. even when the test is reloaded.
  301.  
  302. Warranty
  303. --------
  304. You get absolutely none what so ever !
  305. The author holds no responsibility for this
  306. software, and you use it at your own risk.
  307.  
  308.  
  309.