Document AmiCFA Documentation AmiCFA Documentation ~~~~~~~~~~~~~~~~~~~~ Release 1.1 (April 1997) c Douglas M. Hess 0. Overview =========== Thank you for acquiring AmiCFA. The program has been written to assist you in creating the header and other files necessary for the 'COMPUTER FLOHMARKT' computer zeitschrift for kleinanzeigen. Note: Although the program has been given the kind blessing of the 'COMPUTER FLOHMARKT' team, the program author and the program itself are in no way connected to the 'COMPUTER FLOHMARKT'. Criticisms, Bug reports, comments, etc. must be directed to: Douglas M Hess Krämerstr. 26 D-63450 Hanau eMail: dmhess@t-online.de 0.0. AmiCFA =========== The program has been made as user-friendly as possible. AmiCFA actually contains several editors and utilities 'rolled' into one program! * The 'User' functions allow you to easily manage text for yourself as well as others. The number of users that can be managed is only limited by your disk space! * Creating or editing your header file is easy with the header editor. * A custom database program is also available to manage 'biete' and 'suche' software lists. * The built-in text editor allows you to type your text without leaving the program! * After the data is complete, you only click on the 'Create' button to write the finished files to the disk of your choice. AmiCFA requires 1 megabyte of RAM and a harddisk or second disk drive. 0.1. Msh ======== Short: read/write filesystem for pc floppies. Long: Msh: An Amiga file system handler that handles MSDOS formatted diskettes. Version "1.30" (Release 1 patch 3). You can use files on such disks in almost exactly the same way as you use files on native AmigaDOS disks. This is a fully functional, read/write version, that supports 8, 9, or 10 sector disks of 80 tracks, and should also work on 40 track drives and hard disks with 12 or 16 bit FAT of any dimension the FAT allows. Update to version "1.5" (Release 1) on disk 327. Includes source. Author: Olaf Seibert With the kind permission of Olaf Seibert, the Msh device has been included with AmiCFA. Please note, Msh is a freely distributable program package and that donations to its author are welcome.The entire Msh package with utilities and source code is located in the drawer 'Msh_1_30'. The newest version of "Msh" is 1.56 and it even handles high-density floppies. Version 1.56 is available on the Aminet. 0.2. The Manual =============== How is this manual arranged? The manual is divided into three sections: 'Install', 'Quick-Start', and 'Reference'. Install gets you set up and running. The Quick-Start section will have you writing ads in a few minutes. The Reference section describes the functions and features of AmiCFA in detail and also answers the most commonly asked questions. 0.2.0. Installing AmiCFA ======================== 0.2.0.0. For systems with two floppy drives and no harddisk =========================================================== To avoid unnecessary disk swaps, 'AmiCFA'should be installed on to a bootable Workbench diskette. 1.) copy a complete Workbench diskette and relabel the copy "AmiCFA_Work". 2.) start your computer new with "AmiCFA_Work". 3.) insert the "AmiCFA" diskette and double-click on its disk icon to view its contents. The following icons will be seen in the "AmiCFA" window: MakeRoom13.Script makes room for AmiCFA on a Workbench 1.3 boot diskette labeled "AmiCFA_Work". MakeRoom20.Script makes room for AmiCFA on a Workbench 2.0 boot diskette labeled "AmiCFA_Work". MakeRoom30.Script makes room for AmiCFA on a Workbench 3.0 boot diskette labeled "AmiCFA_Work". Install_Msh.Script installs the Msh files to your boot partition or diskette. AmiCFA drawer containing the AmiCFA program and data. 4.) to make enough room (about 311K) on the 'AmiCFA_Work' disk, double- click on the 'MakeRoomXX.Script'. (Use the script with your Workbench version in place of the XX.) Wait for all disk activity to cease. 5.) drag the 'AmiCFA' drawer icon from the 'AmiCFA' window and release it over the 'AmiCFA_Work' icon and wait for all disk activity to cease. Close the 'AmiCFA' window. 6.) 'AmiCFA' is now installed. If you wish to use 'Msh' to read, write to, and format MS-DOS compatible diskettes, please read the instructions on how to install 'Msh'. 0.2.0.1. For systems with a harddisk ==================================== 1.) insert the "AmiCFA" diskette and double-click on its disk icon to view its contents. The following icons will be seen in the "AmiCFA" window: MakeRoom13.Script makes room for AmiCFA on a Workbench 1.3 boot diskette labeled "AmiCFA_Work". MakeRoom20.Script makes room for AmiCFA on a Workbench 2.0 boot diskette labeled "AmiCFA_Work". MakeRoom30.Script makes room for AmiCFA on a Workbench 3.0 boot diskette labeled "AmiCFA_Work". Install_Msh.Script installs the Msh files to your boot partition on or diskette. AmiCFA drawer containing the AmiCFA program and data. 2.) drag the 'AmiCFA' drawer icon from the 'AmiCFA' window and release it over the desired harddisk destination. Wait for all disk activity to cease. Close the 'AmiCFA' window. 3.) 'AmiCFA' is now installed. If you wish to use 'Msh' to read, write to, and format MS-DOS compatible diskettes, please read the instructions on how to install 'Msh'. 0.2.1. Installing 'Msh' ======================= 1.) Boot your system with the diskette or partition that you will boot with when using 'AmiCFA'. 2.) insert the "AmiCFA" diskette and double-click on its disk icon to view its contents. The following icons will be seen in the "AmiCFA" window: MakeRoom13.Script makes room for AmiCFA on a Workbench 1.3 boot diskette labeled "AmiCFA_Work". MakeRoom20.Script makes room for AmiCFA on a Workbench 2.0 boot diskette labeled "AmiCFA_Work". MakeRoom30.Script makes room for AmiCFA on a Workbench 3.0 boot diskette labeled "AmiCFA_Work". Install_Msh.Script installs the Msh files to your boot partition or diskette. AmiCFA drawer containing the AmiCFA program and data. 3.) double-click on the 'Install_Msh.Script'. After all disk activity has ceased, Msh has been installed on your boot diskette or partition. 0.2.2. Quick Start: AmiCFA ========================== 0.2.2.0. Starting the program ============================= After starting AmiCFA with a double click on the program icon, you will be presented with the main control panel. On the side of the panel is a list gadget containing names of all 'Users'. At the moment only one name is being displayed...'User1'. We will begin by going through all of the necessary steps to create the different CFA files for an imaginary user, 'User1'. 0.2.2.1. Step 1: Selecting a User ================================= Select the user whose data you will be editing or creating. To select a user, just click on his or her name in the list. After selecting a user, all actions taken will effect that user's data until another user is selected or the program is ended. 0.2.2.2. Step 2: Creating a header ================================== Creating a 'Header' should always be done immediately after creating a 'User'. Once a Header has been created for a User it will only have to be edited when information changes for that User. To create or edit the Header, click on the 'Edit Header'on the main control panel. Enter the data for 'User1' in the text gadgets. Click on the 'Save' button to write the information to disk and return to the main control panel. 0.2.2.3. Step 3: Entering the text ================================== Click on 'CF' button in the 'Edit section' of the main control panel to enter the text editor. Type the desired text into the large text editing area. 0.2.2.4. Step 4: Selecting a rubrik =================================== Enter the rubrik selector by clicking on the 'Rubrik' button. Click on a topic displayed in the huge list gadget. A list of sub-topics will then be shown. Click on a sub-topic in the list window. (If BIETE, SUCHE, FRAGE, ANTWORT, or INFO appear at the end of the sub-topic, click on one of these words.). If you wish to change the main topic, click on the small button to right of the upper text gadget. Click on 'Return' when finished 0.2.2.5. Step 5: Selecting end-variables ======================================== The end variables that you select determine what information will be shown at the bottom of your current text when published in the 'Computer Flohmarkt'. If readers are to contact you by mail, then click on the 'ANSCHRIFT' button. This will cause all of your address information to be printed. If 'CF' readers are to contact you by phone, then click on the 'VORNAME' and 'TELEFON' buttons. If you wish to change your choice, click on the 'Start again' button. Click on 'Return' when you are finished. 0.2.2.6. Step 6: saving your text ================================== Click on the 'Save' button. If you have not yet given your text a name, a requester will appear to ask you for a name. Delete the text in the lower text gadget and enter the name of your text. Click on 'Ok' to save your text. 0.2.2.7. Step 7: Creating additional ads ======================================== If you wish to create another ad, click on the 'New' button to clear the old text. Repeat steps 3 to 6 for each new ad. When saving your text, try to use descriptive names to assist you in finding a particular ad if you should wish to change it later. 0.2.2.8. Step 8: Preparing your text for 'CF' ============================================= Workbench 2.1+ users should mount 'PC0:' before continuing. Workbench 1.3 and 2.0 users should mount 'MS0:'. (Please refer to the 'Msh QuickStart' section for more information about 'Msh'.) NOTE: A text converter, ie. CrossDOS, is not necessary. Click on the 'Return' button to return to the main program window. Then click on the 'CF' button in the 'Create .txt' section. A file requester will appear with 'RAM:' as the default directory. Click on the 'Volumes' button to display all of the mounted volumes. If the name of your diskette is not visible in the list, scroll the list using the scroll bar located on the right side. Click on the name of your diskette in the list and then on 'Ok'. You will then be asked if you wish to delete the text files. If you answer 'Yes, AmiCFA will delete the text files as it writes the 'CF.TXT' file. If you answer 'No', the text files will not be deleted. This is a good option if should you want to use the text again. Click on one of these two buttons and AmiCFA will write your file to disk. 0.2.2.9. Step 9: Sending in your data ===================================== Please read the instructions in the latest edition of the 'Computer Flohmarkt' for details. Here is a partial list of things to be aware of: * Label your diskette with your name, address, and telephone number. * If you have filled in the 'Pseudo' field, fill out a 'Pseudoantrag' and include it with the diskette. This is only necessary if your pseudo is not already in the pseudo list. * If sending in a 'Biete' or 'Suche' software list, fill out the address portion of the 'Biete' or 'Suche' form located in the 'Computer Flohmarkt' and send it in with your diskette. * Please check the diskette for virus' before sending it to 'CF'. Also ensure that only the files needed by the 'CF' are on the disk. * Disks will not be returned. * Here is the address: -------------------- Computer-Flohmarkt Postfach 66 D-75430 Maulbronn Germany * You can also upload your text to the CF mailbox: ------------------------------------------------ Phone number = ++49-7043-33446 password (kennwort) = CF username = CF 0.2.3. Quick Start: Msh ======================= For the purpose of this example we will assume that your external drive is "df1:". Place the disk to be formatted to 720K in df1: and the "AmiCFA_Work" disk in "df0". Open a "CLI" or "Shell" window. In this window, type: 1>mount ms1: 1>messyfmt 1 answer the prompts with until the following appears: Format whole disk (enter 1)? [0] type: 1 then the following will appear: Are you sure? (enter 42)? [0] If you just hit then the disk will not be formatted. To format the disk type: 42 The computer will begin formatting the disk in drive 1. Progress will be shown on the screen. When finished the following will appear: Now remove the disk from the drive (or use DiskChange). 1> type: diskchange ms1: You should now have an icon with the name "DF1:BAD" or "DF1:???" and another with the name "Unnamed". The "Unnamed" disk icon is the 720K disk. Files may be written to or from the 720K disk as with any other disk. If you now remove the disk and replace it with another, the diskchange will be recognised automatically. You may now close the CLI window and continue on with your work. 0.2.4. Reference: AmiCFA ======================== 0.2.4.0. user window ==================== After starting AmiCFA with a double-click on the program icon, you will be presented with the 'user window'. The 'user window' is divided into several sections: 1. a 'user list', 2. a 'user section' containing 'add', 'delete', and 'rename'buttons, 3. a 'header section' containing an 'edit header' button, 4. an 'edit section' containing 'cf' 'biete' and 'suche' buttons, 5. a 'create .txt section' also containing 'cf' 'biete' and 'suche' buttons. 0.2.4.0.0. user list ==================== The 'user list' is located in the upper left-hand corner of the 'user window'. The current user is always highlighted. Another user can be selected by clicking on the name in the 'user list'. If no users have been created the 'user list' will be blank. All buttons in the 'user window' affect the user that is highlighted in the 'user list'. 0.2.4.0.1. user section ======================= The 'user section' contains three buttons that affect the currently selected user. The 'add' button in the 'user section' is used to add a name to the 'user list'. At least one user must be entered into the 'user list' for you to use the program. Most of the time only one user is needed, yourself. However, those who also wish to manage data for friends, businesses, etc., will find the 'user section' functions very handy. The 'delete' and 'rename' buttons in the 'user section' allow the currently selected user to be renamed or deleted. Be aware that deleting a user is permanent and that all of the deleted data, header, texts, etc., is irretrievably lost. 0.2.4.0.2. header section ========================= The 'Edit Header' button in the 'header section' activates the 'header editor'. This is where the header information is entered or changed. 0.2.4.0.3. edit section ======================= The 'CF' button in the 'edit section' activates the 'text editor'. This is where ads are written. The 'Biete' button in the 'edit section' activates the built-in 'database editor' for creating and editing lists of software that is to be offered for sale. The 'Suche' button in the 'edit' section activates the built-in 'database editor' for creating and editing lists of software that you wish to purchase. 0.2.4.0.4. create .txt section ============================== The 'CF' button in the 'create .txt section' writes all ads present for a user and his header information to disk. The name of the file written should be cf.txt for the first cf file written and cf2.txt for the second file written to the same disk. Subsequent files should be named cf3.txt, cf4.txt, etc. Only one cf file should be present on the disk for each user. Please see the current edition of 'Computer Flohmarkt' for details. You will be asked if the text files should be deleted, if you select 'yes' then the text files will be deleted as the cf file is written to disk. You may also select 'no' and delete the files manually from the 'text editor' (the safest method). The 'biete' button in the 'create .txt section' writes the biete software list for a user and his header information to disk. The name of the file written should be cfbiete1.txt for the first biete file written and cfbiete2.txt for the second file written to the same disk. Subsequent files should be named cfbiete3.txt, cfbiete4.txt, etc. Only one biete file should be present on the disk for each user. Please see the current edition of 'Computer Flohmarkt' for details. The 'suche' button in the 'create .txt section' writes the suche software list for a user and his header information to disk. The name of the file written should be cfsuche1.txt for the first suche file written and cfsuche2.txt for the second file written to the same disk. Subsequent files should be named cfsuche3.txt, cfsuche4.txt, etc. Only one suche file should be present on the disk for each user. Please see the current edition of 'Computer Flohmarkt' for details. 0.2.4.1. header editor ====================== The purpose of this editor is create a header file or edit an existing one. The labeled text fields is where the information is entered. The fields are self explanatory except for the following: Land The 1 to 3 letter country code should be entered not the full country name, ie; 'D' should be entered for Deutschland. Telefon '/' Sould be entered as the separator between area code and telephone number, ie; '06181/259599'. Telefax See 'Telefon' above. Pseudo Check to see that you desired Pseudo does not conflict with one already being used. See the latest issue of 'Computer Flohmarkt'. Also you may need to complete a Pseudoantrag. AdressNr You will receive an address number when your biete or suche software list is published. Until then leave this blank. Zeichensatz You may not change this field. Zeitschrift 'CF' means 'Computer Flohmarkt'. 'PCH' means 'PC Heimwerker'. This program was written to accommodate 'CF' contributors. If you change this field, you must also save your file under 'PCH.TXT'. See the latest issue of 'Computer Flohmarkt' for details. Be sure to press the 'Enter' key after changing a field to ensure that the new info is accepted. Fill out the header information as completely as possible. Without this information your ad may not be published. The 'Save' button saves the header and takes you back to the 'user window'. 'Cancel' takes you back to the 'user window'without saving the header information. 0.2.4.2. text editor ==================== This is where ads, infos, etc. are entered. The name of the current user is displayed in the window title bar. On th left side of the window are buttons. On the right is a large list gadget with scroll bars along the right and bottom edges. This is where the text is entered. On the bottom edge of the window is a white rectangle. This is where you end variables for the current are displayed. By pressing the mouse button you will see the 'delete a file' item under the 'files' menu. The 'Load', 'Save', and 'Save As' buttons are used to load and save text files. NOTE: Before a text file can be saved, a rubrik and at least one end variable must be selected. Use meaningful names when saving files. An ad offering a harddisk for sale might be saved under the name 'hdisk_for_sale'. All files that will later be sent to 'CF' must be written to the 'CF' directory in the user directory. This is where AmiCFA looks for text files. Example: AmiCFA is located on volume 'Work:'. A text file has been written for a user named 'Bob'. This file should be saved with the path name - 'Work:AmiCFA/Bob/CF/hdisk_for_sale'. NOTE: If you do not change the path in the file requester, AmiCFA will always save the files in the correct directory. The 'Rubrik' button takes you to the 'rubrik selector'. The text field just below this button will display the current rubrik number. If you know which rubrik number to use (such as an answer to a question), you may also type it directly into this field. The rubrik number will also appear on the first line in the text area. Do not change this! Also, do not enter text on the same line with the rubrik number. The actual ad text should begin on the second line in the text entry window. If you enter text before choosing a rubrik, the text will be automatically moved to the second line to make room for the rubrik number. The 'Absatz' button allows you to mark the beginning of a new paragraph. This is not needed in an ad of normal length. However long-winded users may find this handy when typing lengthy infos, answers or questions. Like the rubrik number, the absatz keyword should be on a line with no other text. Additional text should start on the next line. The 'ProgEin/Aus' buttons allow you to mark the start and end of program code listings. The 'EndVars' button takes you to the 'end variables selector'. End variables determine what information is printed after the ad text (name, telephone number, etc.). 'Return' takes you back to the 'user window'. The menu item 'Delete a file' allows you to delete an old or no longer needed file from disk. The text area is where the currently loaded text is displayed and changed. A simple form of word-wrapping is performed. This word-wrapping limits the length of a normal line to 55 characters and a program listing (when the 'ProgEin' is active) to 40 characters. The word-wrap is only active when the cursor is at the end of the last line of text. Text will not be wrapped when typing in the middle of the text. NOTE: The editors of the 'Computer Flohmarkt' will reformat your text before publishing it, anyway. The word-wrap is only to keep the text visible while being edited. To enter text in the text area, anywhere inside it with the mouse. You should then see a cursor. Anything you type is always entered at the current cursor position. The '#' symbol should not be used in your text. '#' marks the beginning of keywords, ie; #ABSATZ or #RUBRIK. Several functions are available to make text editing easier: function key press -------- --------- Move to start of text left amiga - home (7 on the number pad) Move to end of text left amiga - end (1 on the number pad) Move cursor arrow keys delete character left backspace key delete character under cursor "Del" key mark start of block double-click left mouse button (end of block is always the current cursor position) cut right amiga - x (deletes from start of block to current cursor position and places a copy in the paste buffer) copy right amiga - c (places a copy of the marked block in the paste buffer) paste right amiga - v (inserts the contents of the paste buffer at the current cursor position) NOTE: cut, copy, and paste are line-based functions. Only entire lines are affected. 0.2.4.3. rubrik selector ======================== The 'rubrik selector' makes it easy to find the right rubrik number for your ad. The top of this window is filled with a list gadget. Here, the main rubrik topic are shown. The list may be scrolled up and down by dragging the scroll bar on the right side of the list. By clicking on an item in the list, you cause the valid rubrik numbers for this topic to be displayed in the list and the topic will be shown in the upper text field below the list. An entry in the list might look like this: 1740 Kontakte/Erfahrungsaustausch FRAGE ANTWORT INFO To select a rubrik click on the line. If the words FRAGE ANTWORT INFO BIETE or SUCHE appear at the end of the line, you must click on one of these words. To 'back up' to the main topic list, click on the small button next to the field displaying the current main topic. Click on the 'return' button when finished. 0.2.4.4. end variable selector ============================== At the bottom of each ad certain information is to be displayed such as a name and telephone number, or a mailing address. The 'end variable selector' where you determine what information will be printed at the bottom of the ad currently being edited. The buttons above the white field each represent a valid variable from the header. The white field shows the selected variables. The 'Start Again' button clears all variables. The 'Return' button takes you back to the 'text editor'. When a button has been clicked, the variable appears in the white field and the button can not be selected again. Selecting 'Anschrift' is the same as selecting 'Vorname', 'Name', 'Straße', 'Land', 'Plz', and 'Ort'. Selecting any of these alone causes the 'Anschrift' variable to be disabled. If you make a mistake, click on 'Start Again'. 'Vermerk' can only be selected immediately after 'Telefon'. NOTE: At least one variable must be selected to allow you to return to the 'text editor' 0.2.4.5. database editor ======================== This is where biete and suche software lists are created. The user and mode (biete or suche) are displayed in the window title bar. Also in the window title bar is info about the current list in the form of 'Item X of Y'. 'X' is the item number being displayed and 'Y' is the total number of items in the list. To complete a software entry you must fill in each of the text fields. The only field in which an entry is not required is the 'vermerk' field. Those fields with a small button to right must contain one of several valid entries. If you click on one of these buttons, all of the valid entries for that field will be displayed in the list gadget in the lower left corner of the window. By clicking on an entry in the list gadget, the valid value will automatically be entered in the field. The list gadget may be scrolled up and down by dragging the scroll bar running along its right side. After filling in all the text fields, you must check to see that the radio buttons reflect the correct information, ie; gebraucht or neu, etc. To add an entry to the list click on 'add entry', to delete one click on 'delete entry'. Click on the 'prev' button to view the previous entry and 'next' to view the next entry. To save your changed data, click on 'save' and then 'return' to got to the 'user window'. NOTE: To completely delete the database file from disk, click 'delete entry' until the window title bar shows 'Item 1 of 1' and the current entry is blank. Then click on 'return'. After a warning, the database file will be deleted from disk. It is a good idea to always delete an empty database. 0.3. Legal ========== Users of this program do so at their own risk! The author will not be held responsible for damages caused by the use or misuse of this software. Registered users agree not to reveal the registration number to anyone. Also, copying or distributing copies of a registered AmiCFA program or its associated files is also prohibited. Thank You. 0.4. Registering AmiCFA ======================= To register your copy of AmiCFA, send 10 German Marks or US Dollars to: Douglas M Hess Krämerstr. 26 D-63450 Hanau Germany You will receive a registration number by return mail. To register the program, select "Project/Register" from the menu and type your number into the requester. After re-starting AmiCFA, ta da!, no nerve requester.