home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: Java / Java.zip / rdb084r2.zip / readme.now < prev    next >
Text File  |  1996-11-29  |  3KB  |  62 lines
  1. This is the readme file for plugin support under MaxBase.
  2.  
  3. If you have questions about this (or any other) topic, please
  4. redirect your comments to maxmars@pianeta.it (me, the author).
  5.  
  6.  
  7. 1) First of all, what are plugins, and why do I need them?
  8.  
  9. Plug-ins are simple Java applets/applications, or even native code
  10. applications which get called by MaxBase when the user presses
  11. certain buttons on the MaxBase panel.
  12.  
  13. You can expand the functionality of MaxBase (a graphical front end for
  14. the RXDbase database class), without having to modify its source files.
  15.  
  16.  
  17. 2) What can plugins do?
  18.  
  19. They can use the informations in the records or field names at their will.
  20. You can make a plugin to execute calculations on quantities, to make
  21. reports, to launch applications, all you want.
  22.  
  23. Want to send E-mail to someone? Just make a simple name-surname-email 
  24. database and write a plugin which calls your favourite browser, 
  25. specifying mailto:email@address as a parameter.
  26.  
  27.  
  28. 3) Care to expand? Examples, anyone?
  29.  
  30. In the plugins.zip file you will find a template for building
  31. a NetRexx application which will act as a plug-in (although it does
  32. nothing - insert your code to make it do useful work), and a first, 
  33. simple working example (show image files) which calls an applet,
  34. the GifShow from NetRexx slightly modified to make it accept parameters.
  35. Note: you need to have the command APPLET (JDK?) to make it (GifShow) work.
  36.  
  37. The exact procedure to build a plug-in is this:
  38.  a) copy plugin.nrx into nameofyourplugin.nrx
  39.  b) customize it! 
  40.     Plugin.nrx comes with many comments, and there is a section of code
  41.     which communicates with MaxBase, retrieving the name of the fields
  42.     of the currently loaded database, and all of the selected records
  43.     values.
  44.  c) Compile it.
  45.  d) Add to the file plugin.ini (you may have to create it) two lines:
  46.     nameofmyplugin (es: Show Image)
  47.     nameoftheapplicationtorun nameofthefiletolaunch (es: java ImgShow)
  48.  
  49.     warning: only use ASCII editors to edit this file (OS/2's e.exe,
  50.     for example, does add an extra byte at the end of the file and this
  51.     confuses MaxBase)
  52.  
  53. Done! Now fire up MaxBase and you will notice that as soon as you
  54. login to a database, in the main panel "nameofmyplugin" will appear
  55. as a button. Select one or more records and press this button. Your
  56. application will be launched.
  57.  
  58. To quickly test a simple plugin, just unpack plugins.zip, fire up MaxBase,
  59. login to the database imgs, select one record and press "View Text-Image".
  60.  
  61. It's all for now, folks.
  62.