home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / 1997 / 938 / REVISER.TXT < prev    next >
Encoding:
Text File  |  1997-03-03  |  11.4 KB  |  408 lines

  1. Reviser v2.2
  2. 3rd March 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.     Converting existing data
  19.     Test Files
  20.     File locking
  21.     Data Add record
  22.     Data Find and edit
  23.     Config Edit labels
  24.     Config Test
  25.     Config Sound
  26.     Config Graphics
  27.     Config Word wrap
  28.     Start - Q.Field X
  29.     Start - Q.Field Y
  30.     Start - Random
  31.     Start - Clear
  32.     Start - Mark
  33.     Start - List
  34.     Marking
  35.     Warranty
  36.  
  37. What is Reviser ?
  38. -----------------
  39. Reviser is a learning aid which reads
  40. a data file you prepare, and presents
  41. a series of random flash card dialogs,
  42. the first showing a 'question', and the
  43. second showing the 'answer'.
  44.  
  45. What sets its aside from a simple random
  46. selector is that it can present subsets of
  47. questions from larger sets, provided you
  48. adopt a simple numbering scheme in your
  49. database.
  50.  
  51. As a test progresses, you get the option to
  52. mark questions which are easy, or that you are
  53. confident about. Once it has asked all the 
  54. questions in the subset, Reviser shuffles up
  55. the unmarked questions and starts the test
  56. again, allowing you to concentrate on the
  57. questions you have difficulty with.
  58.  
  59. History
  60. -------
  61. Reviser was written to help me in learning Japanese
  62. Vocabulary and Grammar. I had been entering the
  63. vocabulary I had coverered in the course book, into
  64. one large database file on my Psion, so that I could
  65. search the covered vocab. in one file. As I went along,
  66. I recorded the lesson that each word came from in the
  67. book, and a grouping so that Reviser, even in its
  68. earliest form, could select subsets from lessons. 
  69.  
  70.  
  71. v1.0    18/12/96     First Release
  72.  
  73. v1.1    22/01/97     Fixed a clear/mark bug
  74.                                 Added Edit labels
  75.                                 Added % info summary at start of test
  76.                                 Added "Are you sure ?" on Esc from test
  77.  
  78. v1.2    06/02/97    Changed the flash card dialogs
  79.                                 to use scrollable fields. A side effect
  80.                                 is that the text is deletable, so a
  81.                                 "Refresh" button has been added to repaint
  82.                                 the dialog.
  83.  
  84. v2.0    19/02/97    Major upgrade. Flash dialogs now
  85.                                 replaced by graphical display,
  86.                                 allowing scalable multiline Q.A.'s.
  87.                                 Added Data - Add record
  88.                                 Added Data - Find and edit
  89.                                 Added List view
  90.  
  91. v2.1    27/02/97    Added Word wrap
  92.                                 Added saving of misc. config to ini file
  93.                                 
  94. v2.2    03/03/97    Added "cross-out" of marked entries
  95.                                 in list view
  96.                                 Added "isolated" option to Find
  97.  
  98. Registration
  99. ------------
  100. Reviser is shareware. If you find it useful, and wish
  101. to continue using it, please register. For the
  102. small fee requested, you receive a personal password
  103. which once entered removes the annoying nag screens.
  104.  
  105. In registering, you encourage the development of even
  106. more quality software for the Psion !
  107.  
  108. If you provide an email address with your registration
  109. I shall also send you future upgrades to Reviser.
  110.  
  111. To register send either £10 or $20 US as either cash
  112. ,UK cheque or Eurocheque to the address at the top of this
  113. document. If you send cash, please put it between
  114. two sheets of stiff paper, to disguise it in 
  115. the envelope !
  116.  
  117. Installation
  118. ------------
  119. The following shows where Revisers files need to be
  120. installed. To help you get the hang of the source
  121. file format, (described later), I have included my
  122. own Japanese Language database, and the associated
  123. tests, marked in the following list with an '@' :
  124.  
  125. \APP\                        REVISER.OPA (the executable)
  126.  
  127. \APP\REVISER\        REVISER.PIC (the graphic)
  128.                                 REVISER.RSC (optional help)
  129.  
  130. \OPD\                        REVISER.REG (once registered)
  131.  
  132. \DAT\                    @    NIHONGO.DBF (source data)
  133.  
  134. \TST\                    @    *.TST (test files)
  135.  
  136. Source file format
  137. ------------------
  138. Reviser reads a standard Data file that you
  139. provide, but that file must have the following
  140. format :
  141.  
  142. Field   Desc.     Example
  143. -----   ------    ----------
  144.   1     Mark      0 (or 1)
  145.   2     Lesson    4
  146.   3     Group     2
  147.   4     Field X   Hello
  148.   5     Field Y   Bonjour
  149.  
  150. Reviser scans the file for records that are not
  151. marked (0), falling within the lesson and group
  152. range specified under Config - Test. It then
  153. shuffles all those up (in memory) and randomly
  154. selects questions, presenting either 'field X' or
  155. 'field Y' as the question followed by the
  156. corresponding answer ('field Y' or 'field X').
  157.  
  158. It can either be set to always use 'field X' as the
  159. question, or 'field Y', or it can choose either on a 
  160. random basis. (See the Start menu)
  161.  
  162. Because the fields in the Psion Database application
  163. are all strings, if you want to be able to sort 
  164. your source file into lesson/group order, say with
  165. JBDATA, or if you want Reviser to be able to select
  166. subsets properly ie a range of questions, give some
  167. thought to how strings are compared :
  168.  
  169. ie string "2" is greater than "199" ,
  170. so a group range of "1" to "199" does
  171. not include "2".
  172.  
  173. Converting existing data
  174. ------------------------
  175. To allow you to get your data into Revisers format
  176. there is a Data Conversion menu option under File.
  177. This will take a simple database file having only
  178. two fields, field X and field Y, and convert it
  179. into the 5 field format required by Reviser.
  180.  
  181. To simplify the job, you may enter defaults for
  182. the mark,lesson and group fields, and choose
  183. either an automatic mode, where each record uses
  184. these defaults, or an interactive one, where you
  185. may elect to overide these defaults on a per
  186. record basis. If you have a source data file having
  187. more than two fields, I will be glad to convert it 
  188. for you !
  189.  
  190. Test Files
  191. ----------
  192. The files that Reviser creates and which appear
  193. under its icon on the system screen, are the
  194. 'test' files. When a test file is first created,
  195. you provide the name and location of the test's
  196. source data file, and the labels you wish to be
  197. associated with 'field X' and 'field Y'.
  198.  
  199.  ie 'English' and 'French'.
  200.  
  201. Reviser uses these labels when asking it's questions.
  202. The test config is also saved as part of the test
  203. file, which by default includes all questions in the
  204. source file.
  205.  
  206. To setup a test to have different test config
  207. change it's config (Config-Test), then
  208. Save (File-Save).
  209.  
  210. File locking
  211. ------------
  212. Reviser is a type 3 application, that is it is
  213. possible to have multiple copies of reviser 
  214. running. However, because two tests may read
  215. the same source data file, there is the restriction
  216. that if one Reviser is currently testing or listing
  217. any other Reviser running using the same source
  218. file will be unable to add or find/edit.
  219.  
  220. Data - Add record
  221. -----------------
  222. Allows you to add new records to the current test
  223. data source file. This means that you do not have
  224. to exit Reviser, start Data/JBData, add the record,
  225. exit Data, and restart Reviser !
  226.  
  227. Data - Find and edit
  228. --------------------
  229. This accomplishes several tasks ! By finding and 
  230. displaying each match to a find, you get to :
  231.  
  232. - view each match
  233. - edit and save each match
  234.  
  235. Find options available are illustrated thus:
  236.  
  237. Search for:    ie this
  238.  
  239. Positioned:    Start of line        ie this thing
  240.                         Anywhere                ie with this thing
  241.                         End of line            ie and this
  242.  
  243. Within field:    Mark
  244.                             Lesson
  245.                             Group
  246.                             Field X
  247.                             Field Y
  248.                             All
  249.                                                     
  250. Case sensitive:    Yes
  251.                                 No
  252.  
  253. Once the first match is found, you get the option
  254. to edit and save the matched record, after which
  255. the next match is displayed etd etc or simply
  256. view the next match etc etc.
  257.  
  258. Config - saving
  259. ---------------
  260. Note that test related config (Labels and Test) are
  261. saved as part of the test file, while other config
  262. is saved in \opd\reviser.ini, and is loaded for all
  263. tests.
  264.  
  265. Config - Edit labels
  266. --------------------
  267. Allows you to edit the labels used for the question
  268. and answer texts. These will be saved with the test
  269. configuration when File - Save is used.
  270.  
  271. Config - Test
  272. -------------
  273. Reviser allows a type of specialisation
  274. in its question selection, in that it can
  275. select questions from subsets within 
  276. subsets of questions.
  277.  
  278. ie each question/answer in the data file
  279. you prepare for Reviser, has two fields
  280. indicating the lesson and grouping/type of
  281. question that it is.
  282.  
  283. If you do not wish to make use of this 
  284. feature dont worry, simply mark each
  285. question as being in lesson 1 group 1,
  286. and make sure that Reviser is configured
  287. to select using those criteria. 
  288.  
  289. Config - Sound
  290. --------------
  291. Reviser will give two differently pitched
  292. beeps if Sound is on, one on a question, and
  293. the other on the answer.
  294.  
  295.  
  296. Config - Graphics
  297. -----------------
  298. When graphics is on, Reviser shows a graphical
  299. progress bar when it generates an index of your
  300. database at the start of the test sequence.
  301.  
  302. It will also show a similar graphic when it
  303. shuffles a test having more than 50 matches.
  304.  
  305. When graphics is off, a simple 'busy' type message
  306. is displayed, taking less time to get a test started.
  307.  
  308. Config - Word wrap
  309. ------------------
  310. When Word wrap is ON, the Q.and A. text wll word
  311. wrap at the end of each line.
  312.  
  313. When OFF it will spill over in the middle of a word.
  314.  
  315. You may want to switch it OFF if your text is long,
  316. as wrapping means less displayed text.
  317.  
  318.  
  319. Start - Q.Field X
  320. ---------------------
  321. The database will be indexed and the test sequence
  322. started with questions being 'field X' and answers
  323. being 'field Y'. ie would allow you to test your 
  324. translation of English to French.
  325. (The menu doesn't show 'field X' or 'field Y' but uses
  326. the labels that you gave when the test file was
  327. created.)
  328.  
  329. Start - Q.Field Y
  330. ---------------------
  331. The database will be indexed and the test sequence
  332. started with questions being 'field Y' and answers
  333. being 'field X'. ie would allow you to test your 
  334. translation of French to English.
  335.  
  336. Start - Random
  337. --------------
  338. The database will be indexed and the test sequence
  339. started with questions and answers being of mixed
  340. types ie Question in English or French.
  341.  
  342. Start - Clear
  343. -------------
  344. Will clear the Mark field in all the records in
  345. the current database, matching the current Test
  346. Configuration criteria. These question will then
  347. get asked on subsequent test runs.
  348.  
  349. Start - Mark
  350. ------------
  351. Will set the Mark field in all the records in
  352. the current database, matching the current Test
  353. Configuration criteria. These question will then
  354. not get asked on subsequent test runs.
  355.  
  356.  
  357. Start - List
  358. ------------
  359. Picks out test matches but rather than testing
  360. you on them, presents a simple list view for
  361. use as a study/revision aid. Currently limited
  362. to displaying a truncated list of Q.and A.'s,
  363. ie not scalable/scrollable if the text is too wide.
  364.  
  365. Very useful for reviewing the data reviser will pick
  366. out for a test.
  367.  
  368. Note that the ability to page the list is reserved for
  369. registered users.
  370.  
  371. Marking
  372. -------
  373. Once a test sequence has been started, 
  374. with each answer you get 3 choices for
  375. marking of that particular Q/A :
  376.  
  377. o None
  378. o Memory
  379. o File
  380.  
  381. Once all questions in a test have been
  382. asked, Reviser shuffles up its test
  383. index and starts again.
  384.  
  385. None means ask this question again next
  386. time round.
  387.  
  388. Memory means mark this question in memory
  389. only and dont ask it next time round
  390. (in this 'loop', ie next time the test
  391. is loaded it will still get asked again)
  392.  
  393. File means mark the question in the source
  394. file such that it wont get asked again,
  395. even when the test is reloaded.
  396.  
  397. Warranty
  398. --------
  399. You get absolutely none what so ever !
  400.  
  401. The author holds no responsibility for this
  402. software, and you use it at your own risk.
  403.  
  404. (I'll take credit for Grade A exam results though :-)
  405.  
  406.  
  407.  
  408.