home *** CD-ROM | disk | FTP | other *** search
/ PDA Software Library / pdasoftwarelib.iso / PSION / 1997 / 1004 / REVISER.TXT < prev    next >
Encoding:
Text File  |  1997-04-18  |  13.6 KB  |  485 lines

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