home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: InfoMgt / InfoMgt.zip / genmb107.zip / MaxBase.doc < prev    next >
Text File  |  1997-05-26  |  11KB  |  263 lines
  1. This is part of the official documentation for MaxBase V 1.06
  2. An HTML version of this document (with *much* more 
  3. information) is available on a separate zip package.
  4.  
  5. ACKNOWLEDGMENTS
  6. "'"'"'"'"'"'"'"
  7.  
  8. Many thanks to Giuseppe Aprile for his great .dbf <---> .dat conversion
  9. utilities. Also thanks to all the testers who have helped me while I
  10. was (but I still am and will be!) developing MaxBase. 
  11. Thanks saCUL, Penny and all the others!
  12.  
  13.  
  14. Index:
  15.  
  16.   1 .. What Is MaxBase?
  17.   2 .. Shortcuts
  18.   3 .. Legal Stuff
  19.   4 .. Frequently Asked Questions:
  20.        - How can I move the buttons in the panels from bottom to top?
  21.        - How can I avoid users messing up with my db?
  22.        - How can I translate MaxBase to my language?
  23.        - I have heard that I can print and view images. How do I?
  24.        - How much can I customize it? Can I have two languages at once?
  25.        - How can I reduce memory footprint for MaxBase?
  26.        - Why do I get an empty archive when importing from DBF files?
  27.  
  28.  
  29.  
  30. 1 What is MaxBase?
  31. ------------------
  32.  
  33. MaxBase is a graphical tool that allows you to manage your 
  34. databases, both as a database administrator (working with DBs structure), 
  35. and as a user. Of course the db created with MaxBase are compatible with 
  36. the RXDbase class, and vice versa, since MaxBase is only a front end 
  37. to the RXDbase APIs. 
  38. At the moment, nearly all of the RXDbase features are implemented.
  39.  
  40. Notice: Sportello, the net-aware application (similar to MaxBase, but 
  41. network-oriented) has the same capabilities as MaxBase, only lacks the 
  42. functions that allow to manage the db structure and login/logout.
  43.  
  44. A third GUI based DB tool is SpApplet, the Applet version of MaxBase,
  45. much slimmer, with options to browse the archive only.
  46.  
  47.  
  48. 2 Shortcuts:
  49. ------------
  50.  
  51. The following keyboard shortcuts are active in the list which presents
  52. the records:
  53.  
  54. .) When presented with more than one entry field (eg. when entering
  55. records data), use the keys PAGE UP and PAGE DOWN to move from
  56. one line to the previous or the next. CTRL+PAGE DOWN, CTRL+PAGE UP
  57. move one page forward or backward (when 6 or more fields are present).
  58.  
  59. .) double-clicking on an item brings you directly into the 'modify record'
  60. layout.
  61.  
  62. .) Selecting a record and then selecting another one, while pressing
  63. the shift key selects also all the records between the first and the
  64. last that have been clicked.
  65.  
  66. .) The CTRL+END key is used as a shortcut for "store" when adding or
  67. modifying records, "set filter" when setting filters.
  68. Similarly, CTRL+HOME aborts the very same operations (much like hitting
  69. "cancel" or equivalent)
  70.  
  71. .) The CTRL+A keys bring you directly into the 'add record'
  72. layout.
  73.  
  74. .) The CTRL+B keys blank a field with a single
  75.    keystroke.
  76.  
  77. .) The CTRL+C keys, when used during record adding or modifying,
  78. copy the record which was last stored into disk into the
  79. current fields. Warning: this way only up to four fields will be
  80. filled. In fact, CTRL+C fills all the fields visible for that
  81. page except for the one field you're in. Useful when you have
  82. to enter a batch of records which differ only for a field.
  83. ALT+C copies ALL of the fields for the page you're in (including 
  84. the one the cursor is on). [See also CTRL+V]
  85.  
  86. .) The CTRL+D keys bring you directly into the 'delete records'
  87. layout.
  88.  
  89. .) The CTRL+F keys bring you directly into the 'filter'
  90. layout.
  91.  
  92. .) The CTRL+O keys bring you directly into the 'order'
  93. layout.
  94.  
  95. .) The CTRL+V keys act like CTRL+C, but only copy the values for
  96. the field you're in.
  97.  
  98. Also, you can select which of the standard MaxBase's functions are to be
  99. activated upon MaxBase startup. If MaxBase finds a file called maxbase.mnu
  100. then it reads all the strings in it, and labels buttons and text bits
  101. after those strings. If a button string is set to '-' (the dash character,
  102. without the single-quotes), then that button is disabled. If maxbase.mnu
  103. doesn't exist, then the default strings will be used.
  104.  
  105. NOTE: maxbase.mnu files for Unix and Mac (\n and \r line-terminated)
  106. are stored in maxbase.*.unix and maxbase.*.mac where * = a language
  107. (eg eng = english or ita = italian).
  108. Just copy one of them into maxbase.mnu.
  109.  
  110. NOTE-2: All the messages and buttons presented to the user are configurable
  111. through the customization of maxbase.mnu ASCII file, and that means also 
  112. that you can _translate_ maxbase from english to other languages (as 
  113. examples I've put in this package the english and the italian translations; 
  114. if you translated MaxBase into another language let me know!).
  115.  
  116. From RXDbase 0.90 on, I started using Taligent's widgets. You can browse your
  117. data with the vertical and horizontal scrollbars, and you can also resize
  118. the columns width by dragging the column separator in the maint caption for 
  119. that column.
  120.  
  121. MaxBase can be given a parameter in the command line: the name of the
  122. database to log in to at startup (trailing .dat extension NEEDED).
  123. E.g.: 'java MaxBase imgs.dat' or (OS/2's 1.0.1 Java) 'javapm MaxBase imgs.dat'
  124.  
  125.  
  126. You can expand MaxBase functionalities through the use of plug-ins. Refer to 
  127. the plugins packages for more details.
  128. The printing functions are provided as a plugin, and must be extracted
  129. from the plugin.zip (macplug.zip, unixplug.zip) package.
  130. (The plugin.ini file gets read *in the current directory* if it's present)
  131.  
  132.  
  133. 3 Legal Stuff
  134. -------------
  135.  
  136. See license.txt for details.
  137. MaxBase is (c) Max Marsiglietti 1996, 97.
  138.  
  139.  
  140.  
  141. 4 Frequently Asked Questions
  142. ----------------------------
  143.  
  144. Q) How can I move the buttons in the panels from bottom to top?
  145.  
  146. A) Settings for placements of buttons:
  147. maxbase.mnu, 2nd line reads "South". Change it to North, East, West to see
  148. what is the best for you. (North and South are the two that work well now).
  149.  
  150.  
  151.  
  152. Q) How can I avoid users messing up with my db?
  153.  
  154. A) If you want to customize MaxBase, remember that if you put a dash ("-"
  155. without the quotes) on a button label in the maxbase.mnu text file, that
  156. button will be disabled (useful if you want to put the db in a computer
  157. on a fair or on a show room, or avoid your cousins/sons/etc hacking it).
  158. NOTE: maxbase.mnu files for Unix and Mac (\n and \r line-terminated)
  159. are stored in maxbase.*.unix and maxbase.*.mac where * = a language
  160. (eg eng = english or ita = italian). 
  161. Just copy one of them into maxbase.mnu.
  162.  
  163.  
  164.  
  165. Q) How can I translate MaxBase to my language?
  166.  
  167. A) maxbase.eng and maxbase.ita can be copied/renamed to maxbase.mnu;
  168. eg if you 'copy maxbase.ita maxbase.mnu' you'll see all the text strings
  169. turning suddendly into italian words (yes I am italian). To create a new
  170. language just copy maxbase.eng into, as an example, maxbase.de and translate
  171. all the text that's there in German. Copy maxbase.de into maxbase.mnu and
  172. your menus, labels, buttons, everything will show up in German.
  173. Don't forget to send me a copy of your maxbase.mylanguage, so I can include
  174. it in newer releases!
  175.  
  176.  
  177.  
  178. Q) I have heard that I can print and view images. How do I?
  179.  
  180. A) unzip plugins.zip (or macplug.zip or unixplug.zip) 
  181. and you'll find two new buttons in the main panel after a DB has 
  182. been loaded: view text/image and print.
  183.  
  184. View text/image works only with dbs which have the words
  185. "image" and/or "text" in some field's name, and show an applet which
  186. sports the image for that record (field with IMAGE in its name) along 
  187. with the text for that record (field with TEXT in its name).
  188.  
  189. Printing is a bit easier, because you basically select some records, 
  190. push the "print records" button. A new application will then pop up 
  191. and allow you to customize the command to send to the printer in order 
  192. to print the "printme.txt" file which has been generated and there are also
  193. some options to control the appearance of the fields which are being printed. 
  194.  
  195.  
  196.  
  197. Q) How much can I customize it? Can I have two languages at once?
  198.  
  199. A) MaxBase looks for plugins and .mnu files in the directory where it is
  200. launched, so you must pay attention to that (also, the position/size of the
  201. window and fonts/colo(u)rs get saved in that directory). You can use this 
  202. info to make it work for you: call 'java MaxBase' from the directory where 
  203. you did put a database plus its own plugins and .mnu and .ini files and you 
  204. will have a database customized with those settings (.mnu, plugins, .inis).
  205.  
  206. More in detail:
  207.  
  208. plugin.ini  -- 2 lines each plugin: 
  209.                  the 1st is the text to show in the button,
  210.                  the 2nd is the command to issue when the button is pushed.
  211. maxbase.ini -- position, size of the window, number of records to be loaded
  212.                at once, active query, index last used, information on fonts
  213.                and colors.
  214. maxbase.mnu -- menus, labels, buttons, messages, etc.(*)
  215.  
  216. (*) If maxbase.mnu can't be found, MaxBase proceeds with the default
  217. action: english language, all buttons enabled.
  218.  
  219.  
  220.  
  221. Q) How can I reduce memory footprint for MaxBase?
  222.  
  223. A) Well, I have spent a lot of time trying to optimize it.
  224. Whenever you enter one of the principal panels (Main Panel,
  225. Records Panel, Tools Panel) MaxBase makes the garbage 
  226. collection mechanism turn on.
  227. As a net result, if you're experiencing memory hogging, try
  228. to switch panels and you should recover at least some of
  229. your RAM. If the above doesn't work, add as a last parameter
  230. -gc:0 to MaxBase (works also with Sportello); if neither this
  231. helps please contact the author.
  232. -gc:0 simply prevents those garbage collections to be kicked in,
  233. and so it can be useful also for those VM which have GC bugs.
  234.  
  235.  
  236.  
  237. Q) Why do I get an empty archive when importing from DBF files?
  238.  
  239. A) Records stored in DB III files are marked as 'deleted' when
  240. they have a '*' character somewhere (the exact location isn't
  241. important to our discussion); I have seen that at least in one 
  242. case ALL of the records which were imported from another
  243. database did sport that '*' character, effectively fooling our
  244. DBF import routines (as a side note, also Object Desktop pro DBF
  245. filter was fooled the same way), and this is probably a problem on
  246. the export routines in certain databases.
  247.  
  248. So, the workaround is to provide the -sdr:0 (it means Skip Deleted 
  249. Records = 0) parameter to MaxBase prior to launching it.
  250.  
  251. Warning: this way all the records marked as deleted will be imported
  252. as well, and in many circumstances you don't want this to happen
  253. (because you could have many records which you don't see with other
  254. databases for they're deleted, but they still are phisically present,
  255. and that's why this option has been defaulted to skip deleted records).
  256. After having imported an archive with the -sdr:0 switch you may
  257. have to manually delete unwanted records with MaxBase (just select
  258. the records to be deleted and press CTRL+D, or choose 'delete' from
  259. the 'data..' panel).
  260.  
  261.  
  262. Sayonara!
  263.