Guidance on Using MaxBase 1.0 .*******Intro Panel ***** <panel name=main disable-previous next=Requirements enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1000> <title>Hello! Welcome to the MaxBase SmartGuide! First off, please check to have the following items in your MaxBase folder on the WPS: <ul> <li> "Open local DB" (Main MaxBase icon). <li> "Share DB on the network" (To let other users access your DBs). <li> "Access a remote DB" (To access other MaxBase DBs on the network). <li> "db_store" (Where you should store your DBs). <li> "Docs" (The files you should read - start with readme.1st). <li> "New DB" (A template to create new DBs - drag it and drop on the db_store folder). <li> "Get the latest 1.02 Java Runtime!" (An URL object to retrieve up-to-date versions of the Java runtime). </ul> If you don't have one or more elements, it means that the installer couldn't do its job properly. Please contact MaxBase author (see BUGS! section) specifying your setup and other relevant info (use of WPS utilities, etc). </panel> .***** MaxBase Requirements Panel ***** <panel name=Requirements next=MaxBase previous=main enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1001> <title>Requirements Things to have and to do to use MaxBase. <ul> <li>You should have a recent OS/2 Java rel 1.0.2 (type "java -version" on an OS/2 shell to see what is the one you got). MaxBase won't run on Java 1.0.1! <li>You should have installed MaxBase in an HPFS drive, because you need long file names. <li>You should reboot your computer after installation before using MaxBase for the first time. <li>You should have Rexx support installed in order for the installation program to do its job. </ul> Warning: to launch the following program you need to have EPM installed. (close it when you have finished) <al center> <li action="start epm 'shell java -version'">~Check your Java runtime revision now! </al> </panel> .***** MaxBase Panel ************************************************** <panel name=MaxBase next=plugins previous=Requirements enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1002> <title>MaxBase How to use MaxBase. MaxBase ("Open Local DB", or "java MaxBase" from the command line) is the program used to: <ul> <li>Create your databases (from the Tools..DB Related..Create DB menu). <li>Delete and pack them (packing means reindexing them). <li>Export your DBs in DBIII format, and import DBIII databases. <li>Add/delete fields, change field names, indexing and length (from the Tools..Field Related menu). <li>Work with your data. </ul> <al=left> Let's expand this latest point. To work with your data, you can go to the record panel and add/modify/delete records, order the db on a field, set a filter and so on. Note that when you add one or more records, you must hit the 'refresh' button to see them. When you exit from MaxBase, the current settings (window size/position, properties, filter, used index) will be saved on the directory you have started MaxBase from. If you have installed plugin support, in the main panel you will also see the buttons to launch the plugins (See the plugins page for details). </al> Available shortcuts from within MaxBase: <ul> <li>Advance to the next entry field: PAGE DOWN. <li>Return to the previous entry field: PAGE UP. <li>Confirm add/modify of a record, use the new filter: CTRL+END. <li>Same as before, but with the a 'cancel' meaning: CTRL+HOME. <li>Modify a record: select it and double-click on it. <li>The CTRL+A keys bring you directly into the 'add record' layout. Note that when you start inserting records, the default action after insertion is to insert another record. You need to hit "cancel" to return to the default browse view; this was done to help the people who have to insert a lot of records at once. <li>The CTRL+C keys when used during record adding or modifying, copy the record which was last stored into disk into the current fields. <li>The CTRL+D keys bring you directly into the 'delete records' layout. <li>The CTRL+F keys bring you directly into the 'filter' layout. <li>The CTRL+O keys bring you directly into the 'order' layout. </ul> Why such funky key combinations? Because There is no standard TAB in Java for example. Yes I know you're using OS/2 and your TAB key is just fine, but this program can be used also on NT, Unix etc. Warning: you should reboot your computer after installation before using MaxBase for the first time. If you did that, and you want to play with MaxBase now, hit the "start MaxBase now" button. <al left> <li action="start java MaxBase">~Start MaxBase now </al> </panel> .***** Plugins Panel ************************************************** <panel name=plugins next=WPSInteract previous=MaxBase enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1003> <title>Plugins How to expand MaxBase capabilities. MaxBase can be expanded by means of PLUGINS, small NetRexx (or Java) programs that let you do things on selected records. But how do they work? When MaxBase starts up, it looks (among the other things) in the directory it was launched from, for the file plugin.ini. If it is present, you should have one or more couple of lines, the first being the name of the plugin, the second being the program to launch when the button is pressed. After the plugin has initialized itself, it receives from MaxBase info about records selected, and therefore it can do what it wants on them (locally, NOT on the real DB data), like printing them, using the infos to draw a graph, etc. The included plugins are txtimg (a plugin which will show images and associated text, see the imgs.dat database for an example) and printrec (a plugin which will print record data). <ul> <li>If you are interested in creating plugins, please refer to README.PLUGINS in the Docs folder. <li>If you have InfoZip's unzip push the "unzip plugins" button to activate them. The next time you will open MaxBase from the main MaxBase directory two new buttons will show up in the main panel. </ul> <al left> <li action="start unzip plugins.zip">~Unzip plugins <li action="start java MaxBase imgs.dat">~Start MaxBase now </al> </panel> .***** Interacting with the WPS Panel ***** <panel name=WPSInteract next=bugs previous=plugins enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1004> <title>WPS and MaxBase How to get the most from your MaxBase under OS/2. MaxBase integrates nicely with OS/2 WorkPlace Shell, even though it doesn't interact with SOM/DSOM. The installation program created some objects in your WPS, and they have been created this way in order to let you use MaxBase in a document-centric fashion. Drag a "new db" from its template to the db_store shadow folder (the original is a subfolder of the main MaxBase directory) to create a new database, customize its name, and then double click on it. Now go to tools..Field Related..Change field name and change the field name. Add other fields, then start adding records. Yes, it is that easy! When you right click on a .DAT file (the default association for MaxBase DBs) and left-click on 'open as..' you will see at least two options: <ul> <li>Open local DB. If you select this (it should be the default action, BTW) the database will be opened locally and you can start working on it directly. <li>Share DB on the network. When you select this, you will be prompted for a port (use different ports for different DBs! I use port 6789 for tests) and then RXDBServer will start serving remote requests and logging info into log.txt in the db directory. </ul> I strongly recommend you to use this document-centric way of operating, since it is very powerful. Since MaxBase looks in the directory from where it is launched (and when you double-click on a DB MaxBase is launched from that DB directory) you can (and should) have customized .INIs, menus and plugins for every DB. Also, when you exit from MaxBase, the program will save in the current directory the current settings (window position, active query, how many records to display at once, what index was used last time), so this will add more power to the document-centric way of using MaxBase: it will be like having "customized views" for every DB. NOTES: <ul> <li> Yes, you can customize MaxBase menus: just copy the maxbase.mnu file which is in the main maxbase directory into a DB directory, and edit the strings found there. As an example, I have created a maxbase.ita (also in the main maxbase directory) which makes MaxBase use all italian names and strings. If you customize MaxBase for your language, please let me have that translation, I will add it to the MaxBase distribution package! Note to the note: If you use a dash (-) as a button label, that button will be disabled. (And if the button gives access to a panel, that whole panel will be inaccessible too - useful to protect the DB from "malicious" users) <li>You can act as a server both on a LAN or on a WAN like the internet. The only requirement is that the network should use the TCP/IP protocol. <li>You can share as many DBs as you want, only set them at different ports (eg ports 7000, 7001, etc). <li>Several users, including yourself, can be logged at once into a DB which is shared on the network. <li>There is, on many implementations of the 1.0.2 Java, a bug which makes decimal IP (eg. 10.0.0.1) address resolution fail; please use only alpha-numeric IPs (eg. www.funky.com), or hardwire into your HOSTS file (from the TCP/IP configuration object) the info about who-is-who. </ul> </panel> .***** bugs Panel ***** <panel name=bugs previous=WPSInteract disable-next enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1005> <title>Bugs! Things to know when using MaxBase. <ul> <li>There is, on many implementations of the 1.0.2 Java, a bug which makes decimal IP (eg. 10.0.0.1) address resolution fail; please use only alpha-numeric IPs (eg. www.funky.com), or hardwire into your HOSTS file (from the TCP/IP configuration object) the info about who-is-who. <li>The networking extensions have been tested, but not THAT much. <li>Please report any errors to me, maxmars@pianeta.it. </ul> <al center> <li action="start explore.exe mailto:maxmars@pianeta.it">Mail the author (via ~Web Explorer) <li action="start netscape.exe mailto:maxmars@pianeta.it">Mail the author (via ~Netscape/2) </al> </panel> </sguide>

d.*************************************************************** .* Filename: MBASE.SGS * .* * .* This file is parsed by sguide.exe to generate panels for * .* the Guidance on MaxBase Use WarpGuide. * .* * .*************************************************************** .* TRANSLATOR DIRECTIONS: * .* * .* If the words do not fit in the panel, a scroll bar will * .* be dynamically created on the right side of the panel. * .* To eliminate the scroll bars adjust the low-res-size, * .* med-res-size, and high-res-size of the tag. * .* To test the size of the translated panels. Put the * .* the printer.sgs file in the os2\help directory and type * .* "sguide system" from a OS/2 window command line. * **************************************************************** Guidance on Using MaxBase 1.0 .*******Intro Panel ***** <panel name=main disable-previous next=Requirements enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1000> <title>Hello! Welcome to the MaxBase SmartGuide! First off, please check to have the following items in your MaxBase folder on the WPS: <ul> <li> "Open local DB" (Main MaxBase icon). <li> "Share DB on the network" (To let other users access your DBs). <li> "Access a remote DB" (To access other MaxBase DBs on the network). <li> "db_store" (Where you should store your DBs). <li> "Docs" (The files you should read - start with readme.1st). <li> "New DB" (A template to create new DBs - drag it and drop on the db_store folder). <li> "Get the latest 1.02 Java Runtime!" (An URL object to retrieve up-to-date versions of the Java runtime). </ul> If you don't have one or more elements, it means that the installer couldn't do its job properly. Please contact MaxBase author (see BUGS! section) specifying your setup and other relevant info (use of WPS utilities, etc). </panel> .***** MaxBase Requirements Panel ***** <panel name=Requirements next=MaxBase previous=main enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1001> <title>Requirements Things to have and to do to use MaxBase. <ul> <li>You should have a recent OS/2 Java rel 1.0.2 (type "java -version" on an OS/2 shell to see what is the one you got). MaxBase won't run on Java 1.0.1! <li>You should have installed MaxBase in an HPFS drive, because you need long file names. <li>You should reboot your computer after installation before using MaxBase for the first time. <li>You should have Rexx support installed in order for the installation program to do its job. </ul> Warning: to launch the following program you need to have EPM installed. (close it when you have finished) <al center> <li action="start epm 'shell java -version'">~Check your Java runtime revision now! </al> </panel> .***** MaxBase Panel ************************************************** <panel name=MaxBase next=plugins previous=Requirements enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1002> <title>MaxBase How to use MaxBase. MaxBase ("Open Local DB", or "java MaxBase" from the command line) is the program used to: <ul> <li>Create your databases (from the Tools..DB Related..Create DB menu). <li>Delete and pack them (packing means reindexing them). <li>Export your DBs in DBIII format, and import DBIII databases. <li>Add/delete fields, change field names, indexing and length (from the Tools..Field Related menu). <li>Work with your data. </ul> <al=left> Let's expand this latest point. To work with your data, you can go to the record panel and add/modify/delete records, order the db on a field, set a filter and so on. Note that when you add one or more records, you must hit the 'refresh' button to see them. When you exit from MaxBase, the current settings (window size/position, properties, filter, used index) will be saved on the directory you have started MaxBase from. If you have installed plugin support, in the main panel you will also see the buttons to launch the plugins (See the plugins page for details). </al> Available shortcuts from within MaxBase: <ul> <li>Advance to the next entry field: PAGE DOWN. <li>Return to the previous entry field: PAGE UP. <li>Confirm add/modify of a record, use the new filter: CTRL+END. <li>Same as before, but with the a 'cancel' meaning: CTRL+HOME. <li>Modify a record: select it and double-click on it. <li>The CTRL+A keys bring you directly into the 'add record' layout. Note that when you start inserting records, the default action after insertion is to insert another record. You need to hit "cancel" to return to the default browse view; this was done to help the people who have to insert a lot of records at once. <li>The CTRL+C keys when used during record adding or modifying, copy the record which was last stored into disk into the current fields. <li>The CTRL+D keys bring you directly into the 'delete records' layout. <li>The CTRL+F keys bring you directly into the 'filter' layout. <li>The CTRL+O keys bring you directly into the 'order' layout. </ul> Why such funky key combinations? Because There is no standard TAB in Java for example. Yes I know you're using OS/2 and your TAB key is just fine, but this program can be used also on NT, Unix etc. Warning: you should reboot your computer after installation before using MaxBase for the first time. If you did that, and you want to play with MaxBase now, hit the "start MaxBase now" button. <al left> <li action="start java MaxBase">~Start MaxBase now </al> </panel> .***** Plugins Panel ************************************************** <panel name=plugins next=WPSInteract previous=MaxBase enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1003> <title>Plugins How to expand MaxBase capabilities. MaxBase can be expanded by means of PLUGINS, small NetRexx (or Java) programs that let you do things on selected records. But how do they work? When MaxBase starts up, it looks (among the other things) in the directory it was launched from, for the file plugin.ini. If it is present, you should have one or more couple of lines, the first being the name of the plugin, the second being the program to launch when the button is pressed. After the plugin has initialized itself, it receives from MaxBase info about records selected, and therefore it can do what it wants on them (locally, NOT on the real DB data), like printing them, using the infos to draw a graph, etc. The included plugins are txtimg (a plugin which will show images and associated text, see the imgs.dat database for an example) and printrec (a plugin which will print record data). <ul> <li>If you are interested in creating plugins, please refer to README.PLUGINS in the Docs folder. <li>If you have InfoZip's unzip push the "unzip plugins" button to activate them. The next time you will open MaxBase from the main MaxBase directory two new buttons will show up in the main panel. </ul> <al left> <li action="start unzip plugins.zip">~Unzip plugins <li action="start java MaxBase imgs.dat">~Start MaxBase now </al> </panel> .***** Interacting with the WPS Panel ***** <panel name=WPSInteract next=bugs previous=plugins enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1004> <title>WPS and MaxBase How to get the most from your MaxBase under OS/2. MaxBase integrates nicely with OS/2 WorkPlace Shell, even though it doesn't interact with SOM/DSOM. The installation program created some objects in your WPS, and they have been created this way in order to let you use MaxBase in a document-centric fashion. Drag a "new db" from its template to the db_store shadow folder (the original is a subfolder of the main MaxBase directory) to create a new database, customize its name, and then double click on it. Now go to tools..Field Related..Change field name and change the field name. Add other fields, then start adding records. Yes, it is that easy! When you right click on a .DAT file (the default association for MaxBase DBs) and left-click on 'open as..' you will see at least two options: <ul> <li>Open local DB. If you select this (it should be the default action, BTW) the database will be opened locally and you can start working on it directly. <li>Share DB on the network. When you select this, you will be prompted for a port (use different ports for different DBs! I use port 6789 for tests) and then RXDBServer will start serving remote requests and logging info into log.txt in the db directory. </ul> I strongly recommend you to use this document-centric way of operating, since it is very powerful. Since MaxBase looks in the directory from where it is launched (and when you double-click on a DB MaxBase is launched from that DB directory) you can (and should) have customized .INIs, menus and plugins for every DB. Also, when you exit from MaxBase, the program will save in the current directory the current settings (window position, active query, how many records to display at once, what index was used last time), so this will add more power to the document-centric way of using MaxBase: it will be like having "customized views" for every DB. NOTES: <ul> <li> Yes, you can customize MaxBase menus: just copy the maxbase.mnu file which is in the main maxbase directory into a DB directory, and edit the strings found there. As an example, I have created a maxbase.ita (also in the main maxbase directory) which makes MaxBase use all italian names and strings. If you customize MaxBase for your language, please let me have that translation, I will add it to the MaxBase distribution package! Note to the note: If you use a dash (-) as a button label, that button will be disabled. (And if the button gives access to a panel, that whole panel will be inaccessible too - useful to protect the DB from "malicious" users) <li>You can act as a server both on a LAN or on a WAN like the internet. The only requirement is that the network should use the TCP/IP protocol. <li>You can share as many DBs as you want, only set them at different ports (eg ports 7000, 7001, etc). <li>Several users, including yourself, can be logged at once into a DB which is shared on the network. <li>There is, on many implementations of the 1.0.2 Java, a bug which makes decimal IP (eg. 10.0.0.1) address resolution fail; please use only alpha-numeric IPs (eg. www.funky.com), or hardwire into your HOSTS file (from the TCP/IP configuration object) the info about who-is-who. </ul> </panel> .***** bugs Panel ***** <panel name=bugs previous=WPSInteract disable-next enable-done hide-undo hide-help image-lib=os2imgs.dll image-id=1005> <title>Bugs! Things to know when using MaxBase. <ul> <li>There is, on many implementations of the 1.0.2 Java, a bug which makes decimal IP (eg. 10.0.0.1) address resolution fail; please use only alpha-numeric IPs (eg. www.funky.com), or hardwire into your HOSTS file (from the TCP/IP configuration object) the info about who-is-who. <li>The networking extensions have been tested, but not THAT much. <li>Please report any errors to me, maxmars@pianeta.it. </ul> <al center> <li action="start explore.exe mailto:maxmars@pianeta.it">Mail the author (via ~Web Explorer) <li action="start netscape.exe mailto:maxmars@pianeta.it">Mail the author (via ~Netscape/2) </al> </panel> </sguide>