Current Shareware 1994 January

home *** CD-ROM | disk | FTP | other *** search

/ Current Shareware 1994 January / SHAR194.ISO / business / vend11gb.zip / VENDOR.DOC < prev next >

Wrap

Text File | 1993-08-09 | 33KB | 691 lines

PROGRAM TITLE: The Disk Vendor DESCRIPTION: The Disk Vendor is a tool for creating "on-disk" product catalogs. For businesses who would like an alternative to a printed catalog, The Disk Vendor will make the process of creating an on-disk catalog a simple one. The Disk Vendor run-time module is completely menu driven, with a clean simple user interface, which makes it easy for your customers to navigate through and order from. The product catalogs that you create can be distributed on a diskette, or printed to hardcopy format. AUTHOR: Philip P. Kapusta P.O. Box 5423 Falmouth, VA 22403 REQUIREMENTS: Hard disk drive, printer, and an editor/word processor. TERMS AND DEFINITIONS: There are several terms that will be used throughout this documentation and that need to be fully understood by the user before you create your own on-disk catalog. Please review these definitions carefully: ASCII FILE: This is a term used to describe any file that you create and save with an editor such as DOS' EDIT or Window's Notepad. The Disk Vendor does NOT come with an editor because most users already have a favorite editor or word processor that they feel comfortable with. We saw no reason to force the user to use another editor and have consequently not included one. An ASCII file contains NO control characters such as nor graphic characters such as ║ ▒ █ ╚ ½ å CATALOG FILE: A catalog file is an ASCII file that contains product numbers, product names and descriptions. These files are identified by the file extension ".CAT" and can be edited or created with a program like DOS' EDIT editor, or Window's Notepad, or any programmer's editor. You can even use your favorite word processor to edit and generate catalog files, but you must remember to save them as ASCII files. You use The Disk Vendor compiler (COMPILE.EXE) to merge and compress all your individual .CAT catalog files into one single data file (CATALOG.DAT). COMPILER: The compiler is the program that gathers all of your ASCII catalog files (*.CAT) and all other miscellaneous ASCII text files (*.TXT), and then merges and compresses this information into a single data file (CATALOG.DAT). The Disk Vendor compiler also prompts the user for information such as quantity discount rates, your mailing address, sales tax, and currency format before actual compilation begins. DATA FILE: The data file is a specially formatted and compressed file that contains ALL your product names, prices, mailing address, shipping costs, opening and closing screens, etc. This data file is created by using The Disk Vendor compiler (COMPILE.EXE) and once it has been created it can be identified by the filename "CATALOG.DAT". This data file is one of the two necessary files that must be placed on your distribution disk for your customers. HELLO AND GOODBYE FILES: These are silly sounding terms, I admit, but their names imply what you would think. These are two OPTIONAL files that are displayed at the beginning and end of your on-disk catalog. The opening screen file is identified with the filename "HELLO.TXT" and the closing screen as "GOODBYE.TXT". You can have a hello file without a goodbye file, or vice versa. One does not require the other. Or you may wish to eliminate both. The choice is up to you. These files are extended ASCII files, which means you can use any of the high ASCII characters (graphics) such as ║ ▒ █ ╚ ½ å RUN-TIME MODULE: Refers to the file "CATALOG.EXE". This is the program that reads the information in your data file and displays it to your customers. Remember, in order to create a catalog on a disk for your customers, two files must exist on that disk: 1) CATALOG.EXE and 2) CATALOG.DAT. SHIPPING FILE: This is a small ASCII file that contains information on the various modes of shipping and costs available to your customer. It is identified by the filename "SHIPPING.TXT". TEXT FILE: Text files are ASCII files that contain miscellaneous messages and notes that you want your customers to have access to. Text files are identified by the file extension ".TXT" and must NOT be confused with catalog files. Text files should NOT contain products that you want your customers to order, unless you expect them to hand write those items at the end of their order form. The contents of text files can only be viewed on the screen, and no order prompts, prices or discount windows appear in conjunction with "*.TXT" text files. An example of a useful text file would be a file that gives a brief sketch about your company or about how your products are better than your competitor's. WAIT FILE: This is a special ASCII file that is displayed to your customers by the run time module as it reads in information from the data file. It can be considered as a commercial message if you wish. It is called a "wait file" because its contents are displayed on the screen as your customer waits for the program to finish a task. It is appropriately identified by the filename "WAIT.TXT". With these terms now under your belt you will be ready to begin creating your own on-disk shareware catalog. LET'S GET STARTED: The first thing that we recommend a brand new user to do is to run the compiler (COMPILE.EXE) and generate a personalized data file (CATALOG.DAT). Then after this execute the run time module (CATALOG.EXE) so that you can see how quick and easy it is to generate a catalog. Do this right now! At the DOS prompt, just enter COMPILE and fill in the blanks as you are prompted by the program. Once you have done this, enter CATALOG at the DOS prompt and look at your results. Before you generate your own catalog files (*.CAT) spend some time getting familiar with the run-time module (CATALOG.EXE). Explore its features and interface. Try placing a few orders as if you were a customer. Print out your order forms, print the catalog, search for words, save and retrieve your orders, etc. By playing with the run- time module you will get a feel for the power and ease of use that The Disk Vendor provides you. Once you have spent some time with the run-time module (CATALOG.EXE) and the compiler (COMPILE.EXE) then you should begin creating your very own catalog files (*.CAT). To begin, use your favorite text editor or word processor and open a new file. We will call the name of the new file "VIRUS.CAT" and we will generate a catalog file that contains virus checking software programs. Note: You can give the file any name you wish as long as it contains the file extension ".CAT". "SOFTWARE.CAT", "DISNFECT.CAT", "_VIRUS_.CAT" are all valid catalog file names. Whatever is easiest for you to remember, give it an appropriate filename. THE STRUCTURE OF A CATALOG FILE: Once you begin a new catalog file, there is a specific format that you must follow: 1) The very first line of the catalog file (*.CAT) must contain a 34 character or less description. The first line of a catalog file will be used in the Main Menu catalog index listing. 2) A pound symbol "#" separates one product and description from another. The "#" can be followed by your catalog number identifying the product that follows it. Catalog order numbers must not be longer than 20 characters. 3) The name of the product follows on the next line after the line that contains the "#" symbol. 4) Any lines after the product name are used for you to describe that product. 5) Product description line length must not exceed 72 characters in width. All right, got it? Clear as mud? Probably. So here are some examples that will help you. Again, we are in our editor and have the file "VIRUS.CAT" open. With the cursor at the very top of the document (line 1), enter a description used to identify the contents of the catalog file: ┌─────────────────────────────────────────────────────────┐ │Virus protection software │ │ │ │ │ │ │ It is simple so far, isn't it? Just keep the number of characters in this description line less than 34. Now, on to line 2! As we stated above, a "#" symbol separates one product from another. Since we are about to enter a new product name and description, we need to place a "#" on line 2, column 1: ┌─────────────────────────────────────────────────────────┐ │Virus protection software │ │# │ │ │ │ │ If you wish to identify your products using a catalog number, now is the time to do so. Immediately following the "#" symbol, enter your catalog number. The number does not need to be a number, but can be characters if you so choose, or a combination of both. For example: ┌─────────────────────────────────────────────────────────┐ │Virus protection software │ │#VI040 │ │ │ │ │ Again, you are not required to enter a catalog number if you choose not to. What is mandatory, however, is that a "#" symbol exists in column 1 and must precede the line that contains the product name. When you are ready to enter a product name, move down one line below the "#" and enter it: ┌─────────────────────────────────────────────────────────┐ │Virus protection software │ │#VI040 │ │Expel │ │ │ In the example above the software program "Expel" has been placed immediately below the line containing the "#" symbol. To show you some of the features unique to The Disk Vendor we will let you know here that you can add a comment note on the same line as the product name. A "comment note" may consist of anything you wish, as long as it is enclosed in squiggly brackets {}. For example, let's say that Expel is obtained wholesale through your distributor Acme Software. Your sales representative with Acme Software is Jim Smith. If you wanted to make a note of that fact, you can add a comment note recording this. For example: ┌─────────────────────────────────────────────────────────┐ │Virus protection software │ │#VI040 │ │Expel {Acme: Jim Smith} │ │ │ Above we see that the software title Expel is purchased through Acme Software, whose sales rep. is Jim Smith. This comment note is enclosed in {} brackets. The brackets are very important! When this catalog file is compiled, your comment notes are ignored. Comment notes in {} brackets do not appear to your customer because they never find their way into the data file (CATALOG.DAT). Comment notes are for your use and are optional. You can enter anything you wish between {} brackets - the name of a company, a stock bin number, an inventory count, the weight of the product, whatever. Again, this comment note is optional. The next bit of information that you need to add is the selling price for the product. At the end of the line that contains the product name, enter its price. Although you can add a currency symbol before the price, this is not necessary, and in fact it is not recommended. The reason we do not recommend that you enter a currency symbol (e.g. "$") is because it takes up file space. The run-time module does not need the currency symbol repeated hundreds of times in your *.CAT files. One little "$" sign may not seem like much, but if you repeat this symbol hundreds of times it slowly eats up disk space. But if you can't break the habit, that's fine too. The compiler and run-time module do not care. ┌─────────────────────────────────────────────────────────┐ │Virus protection software │ │#VI040 │ │Expel {Acme: Jim Smith} 23.95 │ │ │ Above we see a price of $23.95 for one unit of "Expel". This $23.95 is the undiscounted selling price for this product to your customers. If you wish to give multiple quantity discounts, see the compiler (COMPILE.EXE) and set up the discount rates at compile time. Here in your catalog file (*.CAT) simply enter the price of the product item as shown above. Now that we have entered a product number, a product name and price, all that we have left is to give Expel a description. The product description lines follow immediately below the line that contains the product's name and price. For example, let's describe Expel: ┌─────────────────────────────────────────────────────────┐ │Virus protection software │ │#VI040 │ │Expel {Acme: Jim Smith} 23.95 │ │Anti-virus program that helps preserve the integrity of │ │your files. │ │ │ You can definitely get more descriptive if you wish. We do not recommend that you enter more than 13 lines for a program description because it will be truncated when it is compiled. 13 lines should be more than enough to describe most programs. Also, keep all description lines less than 72 characters wide. You can insert blank lines if you wish, and they will be preserved when compiled. Believe it or not, that is all there is to it! Not very hard is it? To add additional programs to our "VIRUS.CAT" catalog file, simply repeat steps 2-4 above. Here is our catalog file after adding two more virus checking programs: ┌─────────────────────────────────────────────────────────┐ │Virus protection software │ │#VI040 │ │Expel {Acme: Jim Smith} 23.95 │ │Anti-virus program that helps preserve the integrity of │ │your files. │ │#VI107 │ │ │Flu Shot+ 17.95 │ │Protects you system against virus and Trojan horse │ │programs. Read/write protection for programs. Checks for │ │contamination and prevents virus activities. │ │#VI100 │ │Virex {Version 2.1} 34.95 │ │Virex checks an entire disk for over 800 different virus │ │strains. If it detects a virus, Virex will remove the │ │virus from the program or disk. Quarterly update │ │virus signature lists are available from the publisher │ │to protect your computer against new virus strains. │ Notice that you do NOT repeat the "Virus protection software" category description line. This occurs only ONCE, and must be on the first line of your catalog file (VIRUS.CAT). We strongly recommend that you enter/insert new products in alphabetical order. This will make your catalog easier to navigate through when viewed by your customers. There exists a function in The Disk Vendor run-time module (CATALOG.EXE) that lists all the product items in the currently selected category. This "quick browse" listing displays the products' names in the same order in which you entered them into the catalog file. Therefore, if you want this list to appear in alphabetical order, you should enter the products in alphabetical order. The Disk Vendor will not sort this list because it wants you to practice good catalog file creation and maintenance. It is also to your benefit to enter and maintain products in alphabetical order. It not only makes it easier for your customers to locate products, but it makes it easier for YOU to locate products when it comes time to update or purge your catalog files. If these 3 titles are all you have in the way of virus checking software programs, then close the "VIRUS.CAT" catalog file and save it to disk. One last feature that you may be interested in adding to your catalog file is a "customer note". A "customer note" contains text information that helps better describe the items that follow. A "customer note" does NOT have prices or part numbers attached to them. You begin a customer note with a "#" symbol, immediately followed by "NOTE#". Move down one line and enter a header line, then move down one line and enter the ASCII text that makes up your note. Using the VIRUS.CAT file as an example: ┌─────────────────────────────────────────────────────────┐ │Virus protection software │ │#VI040 │ │Expel {Acme: Jim Smith} 23.95 │ │Anti-virus program that helps preserve the integrity of │ │your files. │ │#NOTE# │ │WHAT IS A COMPUTER VIRUS? │ │A computer virus is a program designed to replicate and │ │spread on its own, preferable without you knowing it │ │exists. Like a human body, computers are vulnerable to │ It is best to experience a customer note in a compiled data file first hand in order to appreciate its usefulness. We have included several customer notes in the sample catalog files (*.CAT) that accompanied this program. Take a good look at these files to understand how they work. Customer notes can occur anywhere in your catalog files, and they can be unlimited in length (1 to 1000 lines) but are restricted to 72 columns in width. A few other guidelines that you should be aware of when working with catalog files (*.CAT): Use lower case letters as much as possible. Upper case letters do not compress well during compile time. On average you will achieve a 40% file size reduction if the majority of your catalog files are in lower case (before: 100,000K, after: 60,000K). Don't overdo this, of course. Just type your catalog files as if you were typing a letter to a friend. Keep the CAPS LOCK off, and avoid entering product names in uppercase and you will be OK (or is it "ok"?). Do not use high ASCII characters in your catalog files (*.CAT). Characters such as ║ ▒ █ ╚ ½ å will not be compiled properly. Absolutely avoid them! OTHER NECESSARY FILES BEFORE COMPILING: Although your catalog files (*.CAT) are the most important files that you need to have prior to compilation, there are additional files that you can and should create. The first mandatory file required for compilation is a "wait file". This file is an ASCII text file that contains a message for your customer while the run-time module works on a task. This file can be created with an editor, and must be saved with the filename "WAIT.TXT". If this file does not exist when you go to compile your catalog using COMPILE.EXE the compilation process will abort. "WAIT.TXT" is absolutely mandatory. With The Disk Vendor package that you have received a sample "WAIT.TXT" file can be found that you may use as a guide. The most important things that you must remember when working with the "WAIT.TXT" file is that it can NOT be longer 72 characters wide by 17 rows high. Also, this wait file must not contain any high ASCII characters. The second (and last) mandatory file that must exist prior to compilation is a shipping text file. Identified with the filename "SHIPPING.TXT", this file contains information on the shipping/mailing methods that you provide your customers with, and their costs. A sample "SHIPPING.TXT" file has been included with The Disk Vendor system that you received and can be used as a guide. Its format is as follows: [Type of shipping]=[Cost] Where [Type of shipping] is replaced with the words identifying the type of shipping/mailing method available, and where [Cost] is replaced with the actual cost. These two parameters are linked together with a "=" equals symbol. Here is a real life example of a "SHIPPING.TXT" file, so that you can see better the format you must follow: USPS (US)=2.95 USPS (Canada)=5.00 USPS (Elsewhere)=7.00 UPS Ground (US)=4.00 UPS Blue (48 Sts)=7.00 UPS Blue (AL HI PR)=8.00 UPS Red (US)=16.00 UPS Red (AL HI PR)=19.00 Federal Express overnight=20.00 You can have one line in your shipping file, or 10 lines. You have the choice to add or delete any lines. The only requirement is that at least one line exists in the "SHIPPING.TXT" file, and that you follow the format outlined above. Having your catalog files (*.CAT) and the "WAIT.TXT" and "SHIPPING.TXT" files, you can now begin the compilation process if you wish. These files are mandatory before running COMPILE.EXE. You may wish to add some additional files, but this is optional (see next section). OPTIONAL TEXT FILES TO INCLUDE IN YOUR CATALOG: Many businesses and companies who use The Disk Vendor may wish to add additional ASCII text files for their customers to view. This can be done with an editor, and the only requirements that The Disk Vendor impose are: 1) The text file must NOT contain control characters nor high ASCII characters > 126 (decimal). 2) The text file must be saved with a filename extension ".TXT" (short for "text"). "BONUS.TXT", "README.TXT", "COUPON.TXT", "SPECIALS.TXT" are all valid text filenames. 3) The text file can be any length (within reason), and should be less than 81 characters in width. 4) The first line of your .TXT file must be reserved for a description line. This reserved description line works exactly as the description line in your catalog files (*.CAT). This description line will appear in the Main Menu catalog index box and must contain less than 35 characters. Again, this description line MUST reside on line 1 of your text file! What would you use .TXT files for? Some possibilities are: To describe your company and its products. To display a discount coupon that the customer can print using the PRINT SCREEN key and then redeem. To explain your return policies. HELLO AND GOODBYE: Should you wish to create a special opening screen that your customer views before the Main Menu screen appears, then create a "hello" file. This file is also created using an editor, and must be saved with the filename "HELLO.TXT". Unlike other ASCII text files, the "HELLO.TXT" file can contain high ASCII graphic characters. This will enable you to create some attractive opening screens with boxes and shadows and text. The "HELLO.TXT" file can contain up to 25 lines of characters by 80 characters in width (the size of a normal text mode screen). Here is an example of what you could do: ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓┌───────────────────────────────────────┐▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓│ │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ XYZ COMPUTERS PROUDLY PRESENTS │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ ITS WINTER 1995 SOFTWARE │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ CATALOG ON A DISK │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ Press any key to begin... │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ │░░▓▓▓▓▓▓▓ ▓▓▓▓▓└───────────────────────────────────────┘░░▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ Just remember to include an instruction for your customer to "PRESS ANY KEY TO CONTINUE..." or else you may find your customer scratching his head wondering what to do next. You may never receive an order from him because he could not get past your opening screen! Likewise, if you wish to have a special message appear at the close of the program, create a "goodbye" file with an editor. Follow exactly the same guidelines as described above for the "hello" file, but save this file as "GOODBYE.TXT". Again, remind the customer with a message to press any key to exit the program! Both the "HELLO.TXT" and "GOODBYE.TXT" files are optional. You may wish not to have opening or closing screens, or you may wish to have one but not the other. This is fine. Just delete the files you don't need, or don't create them in the first place. THAT'S ALL FOLKS!: Speaking of "goodbyes", the instructions above are all you need to get you up and running creating your own personal shareware catalog on disk. We hope that you find The Disk Vendor a useful tool in marketing your products. SHAREWARE: The Disk Vendor is shareware software and continued use of the program requires you to support the author. Once you have registered, you will receive the latest version of The Disk Vendor that will permit you to begin distributing your compiled data file (CATALOG.DAT) and the run-time module (CATALOG.EXE) freely without royalties. ALL IN THE FAMILY: Attention shareware distributors!!!! If you would like to use The Disk Vendor to distribute public domain and shareware software disks, we have a special version of The Disk Vendor JUST FOR YOU! Custom tuned for the shareware industry, The Disk Vendor "shareware vendor" version has features unique to your industry, such as multi-disk prices, separate pricing structures for 360K, 720K, 1.2M and 1.4M disk sizes. We highly recommend this "shareware vendor" version if you need a catalog on disk system to distribute your shareware library. Contact the program author with a SASE or by phone to learn more details. CAN I CONVINCE YOU TO CONVERT?: Question: "I currently use EmmaSoft's Catalog-On-A-Disk program to distribute the products we sell and would like to switch to The Disk Vendor. What are the differences between these two products, and can I salvage my COAD *.TXT files for use with The Disk Vendor?" Answer: 1) A very clean, uncluttered, attractive user interface distinguishes our product from EmmaSoft's product. Your customers will find it easier to use, and hopefully order more products from you if they can navigate easily through the on-disk catalog that you have provided them. 2) The Disk Vendor run-time distribution .EXE module (CATALOG.EXE) is only 54000 bytes in size. Our competitor's product is approximately 81000 bytes. So what? The more products you offer your customers, the more products you are likely to sell. The more disk space available on your distribution disk means more products you can list. The smaller the run-time .EXE program, the more products you can offer your customer. You know how many products you can get into 27000 bytes of disk space (the difference in size between our product and theirs)? Literally hundreds! The more product selections you offer your customers, or the better you describe your products, the more disks you will be able to sell. Free disk space equals more potential sales. 3) On your distribution disk to your customer, only two files need to exist for your on-disk catalog to run using The Disk Vendor - (CATALOG.EXE and CATALOG.DAT). Our competitor creates dozens of ".CM" files if you have dozens of product categories. So what, you may ask? Again, getting back to the story of available disk space. The more available space on your distribution disk, the more products or better descriptions you can offer your customers. It is a hardware fact in DOS that if you have a file on a 360K disk that is only 11 bytes long, it actually will take up 1024 bytes of disk space! This is due to the way files are allocated on a disk. For instance, if you have a file called "HELLO.CM" and in it contains the letters "HELLO WORLD", although the file listed in a DIR command shows the file size as 11 bytes long, it actually displaces 1024 bytes on disk. Multiply "HELLO.CM" two dozen times, and 264 bytes (24 x 11) now has displaced 24576 bytes! Alright, so what's the point? The point is that the more files you have on your distribution disk, the more disk space you are most likely wasting due to partially filled clusters. The Disk Vendor eliminates wasted disk space by needing only two files to exist on your distribution disk - CATALOG.EXE and CATALOG.DAT. Also, needing only two files on your distribution disk makes file housekeeping chores much easier. 4) The compilation of your catalog ASCII text files to a single catalog data file (CATALOG.DAT) is a one-step wham bam, "run it once and I'm done process". Our competitor's product requires you to compile two dozen ".CM" files one at a time if you have two dozen product categories. The Disk Vendor saves you time, compiling ALL your catalog ASCII files automatically in one swoop, insuring that the resulting CATALOG.DAT file is the latest and contains complete, up to date information. 5) The Disk Vendor provides you with a utility that will convert all your Catalog-On-A-Disk .TXT files to The Disk Vendor ASCII .CAT format. Converting from our competitor's product to The Disk Vendor couldn't be easier! You lose none of your hard work. Copy the file "COAD_CVT.EXE" to the directory where you store your EmmaSoft COAD .TXT files, then run "COAD_CVT.EXE" from DOS. This conversion utility will create new catalog files (*.CAT) that can be placed in the directory where The Disk Vendor resides.