============================================================================ $vER: Platinum, v1.96 README (15-Sep-96) by Dotoran of Frontiers! ============================================================================ What Is Platinum? ~~~~~~~~~~~~~~~~~ Platinum is an AREXX FileList Generator written specifically for CNet Amiga BBS's (v3.xx and above), which has the ability to create multiple different filelists in both TEXT and AMIGAGUIDE format. Presently, here's what PLATINUM can do: - Allows the SysOp to create BOTH text AND amigaguide formatted listings of files. - There are three types of scans that PLATINUM can do on a directory: - File Directory - If a "/data/_Items3" file exists. - Text Directory - If a "/data/_Items2" file exists. - Dos Directory - If neither of the above exists. - Regardless of the TYPE of directory in question, each filelist will contain at LEAST the filename, short description, file size, and the AGE of the file(in DAYS) Each listing will also contain a line of totals(files, bytes, etc). - If a "File Directory", one where an _Items3 file exists, the listing will also contain the number of times file was downloaded, whether or not the file was tested, if it was virus scanned, if it's marked as a SysOp Favorite, if it's a FREE Download, and the FULL eight line short description(from the _short file). A check will also be done on the "missing" flag, the "killed" flag, and the "post" flag, and these will be skipped if seen. - ALL listings(txt or guide) may also contain a Header File (or NEW FILES Header), a "Table of Contents", a listing of MAGIC Names, a "Most Downloaded Files" Listing, a "FREE Downloads" listing, a "SysOp Favorites" Listing, and a Footer File. - You have the ability of creating MULTIPLE listings, as well as a NEW FILES listing. You might choose to create a main FILES list, a NEWFILES list, then separate listings for specific groups(perhaps based on the computer being used, whether they were a SysOp, had Adult access, etc.) /***** Not in Evaluation Release *****/ - An "Access Group" range can also be specified, but is only used in the included downloader module, that allows your users to either VIEW or DOWNLOAD one of your created filelists. (These are not used for actual REQUESTING of filelists using a MAILER). - Another module allows your users to either VIEW or DOWNLOAD one of your filelistings. They'll only be shown those lists they have access to, as defined above, and can VIEW both the TXT and the GUIDE file, while online(using MoreText for Guide Viewing). They can then either DOWNLOAD one of the lists, or if they chose to VIEW one of the GUIDES, they'll be asked if they wish to SELECT FOR DOWNLOAD the files they selected in their .REQ file(provided they have room for them in their Select Buffers, etc.). /*************************************/ - You have the ability of individually toggling whether a TXT or GUIDE formatted listing is created for EACH list, so it's possible to create BOTH for SOME of the lists, only TXT's for others, only GUIDES, etc. - Each file can also be PACKED, using either ZIP, LHA, or LZX. You can opt to PACK the TXT file using one format, and the GUIDE using a different one, or choose NOT to pack a listing. - An included "Ansi-ARexx" config file allows the SysOp to easily modify any of the above settings, as well as creating the list of MAGIC names, with descriptions, Directory Paths, with descriptions, and more! This file also uses the "rexxreqtools" library to display requestors asking for information whenever it warrants the need for one(like when you're editing a path, or choosing the listing to use as JM's filelist, etc.) - As well as being able to create MULTIPLE listings, you also have the ability of specifying WHICH directories to USE in each listing, AND what ORDER you wish them to appear in. The config file has numerous ways to make creating these "sorted" lists a snap! - A series of external text files for Headers, Footers, and GuideTexts can also be created. If you opt NOT to create one of the above, the "small"(1 line) text will be used. You can opt to use the 4-Line or the 10-Line text file instead, though. The CNet Visual Editor is used to edit these files from within CONFIG. - You can specify WHERE you wish the created filelists to be stored. - As mentioned below, you can specify up to SIX Node Addresses to where a user could FREQ you from. These addresses are used to create buttons in the AmigaGuides to ask the user to specify the correct .REQ name to use. - For those with slower systems, there's a toggle that allows filelists to be created from "Dos Information". You'll lose a lot of the "neat" features, however it will create smaller filelistings, which won't hurt the download times as much. - You can specify the number of days files will be considered NEW as, as well as the minimum number of times a file needs to be DOWNLOADED, so it can appear on the "Most Downloaded Files" listing. - You can toggle whether or not you wish the "Tiny Navigation System" to be used in AmigaGuides(more on this below). - Those using JamMail can specify one of the filelists to be used as the file sent to a user who types FILELIST from the "Press ESC twice to enter bbs..." prompt JamMail displays upon logon. - Those using FFRS can specify if they wish the INDEX file FFRS uses to locate files be updated each time filelists are created. - AmigaGuide formatted listings have these added features: - A "Pre-Header" allows SysOps running Multiple Networks to ask the reader to select which network they wish to REQUEST from. An "out" is also given for those NOT running mailer software. - The "Table of Contents" list, as well as the three Special Lists have the ability of taking you directly to the directory that houses the appropriate file(s). - The filelists, Magic list, Most Downloads List, SysOp Favorites, and Free Downloads listing have the ability of letting you click on their filenames and have that file's name added to a .REQ file. - A "Tiny Navigation System" is included in the form of some small buttons that appear at the start of every filelist. These buttons allow you to immediately go to the buttons screen, the magic names screen, one of the three special lists screens, or the main title screen, all at the click of a mouse button! Additional buttons let you KILL/DELETE a .REQ file that was already started, or VIEW the CONTENTS of a .REQ in progress(using the "c:MORE" dos executable.) - A "customized" HELP Node is also created within each listing, which will only discuss commands available in THAT listing. For instance, if no "SysOp Favorites" exist, then the " S " button is not discussed, etc. (nor will the "S" button appear on the Navigation bar) - Up to EIGHT "Text Buttons" can also be included in the AmigaGuide listings. You can define ALL EIGHT, yet choose only to USE one or two in each listing, as well as specifying the ORDER you'd like the buttons to appear in. You'll be asked for the text to appear on the button, as well as the full path to the text file to use in the created node. What Do I Need to Use Platinum? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ As mentioned above, Platinum is written in UNCOMPILED ARexx, however it DOES make use of some external libraries, AmigaDos commands, and external programs, which you will need to obtain to take full advantage of it's power. Most notably, you'll need a copy of the "rexxreqtools.library", as well as it's host, the "reqtools.library". You'll also need the "rexxsupport" library(which you should already have). All three should be placed in your LIBS: assigned directory. You'll also need the following AmigaDos commands, located somewhere in your local path: SORT, DELETE, ECHO, ASSIGN, SETENV, and COPY. I believe all versions of AmigaDos(2.x and higher) came with these commands, located in your C: assigned directory. Just check to make sure you have them all. For use with PACKING/ARCHIVING created filelists, you'll also need to obtain copies of ZIP, LHA, and LZX. /***** Not in Evaluation Release *****/ Lastly, you'll need a copy of the MORETEXT program, which allows for the viewing of AmigaGuide formatted documents, while online(meaning they can be viewed from REMOTE). /*************************************/ I've included the "reqtools" and "rexxreqtools" libraries that I am presently using for those who may not have them, however these are NOT the complete releases. Here's where you can obtain the complete packages for these files, for those interested: ReqTools22c_us.lha - Both can be found on disk "A" of the AmiNet, Set I RexxReqTools.lha 4 CD-Rom Set, inside the "Aminet/Util/Libs/" dir. /***** Not in Evaluation Release *****/ MoreText045.lha - Can be located on disk "B" of the AmiNet, Set I 4 CD-Rom Set, inside the "AmiNet/Text/Show" dir. /*************************************/ If you do not have access to this AmiNet series, the above archives can also be obtained from my bulletin board system. How Do I Install Platinum? ~~~~~~~~~~~~~~~~~~~~~~~~~~ Installation of Platinum is a snap! First, make sure you've located BOTH the "reqtools" and "rexxreqtools" libraries in your LIBS: directory. Next, copy the "Platinum/" directory somewhere appropriate on your bbs system. Once copied, run the "Platinum/PL_INSTALL" file as an ARexx SysOp Only Door. Answer the questions it will present to you, then come back to this document. Once you've run the INSTALL program, you can delete it's entry from your doors section(but KEEP the actual file, just in case)! You should now load your BBSMENU file into an editor and add the following two commands to the end of "Menu # 1; Maintenance Menu": PLC, PLATINUMC | {#0Platinum/PLATINUMC} PL, PLATINUM | {#0Platinum/PLATINUM} ^ Control-Q NOTE: above is the location you opted to store the "Platinum/" directory. Enter THAT text, instead of the "". Save your BBSMENU file, then reload it by clicking once on your CNet Control Panel, then pressing RAMIGA-T. You will also most probably want to create an EVENT to run the included PLATINUM file, perhaps once a week, or once a night, depending on how much usage your system's file areas get on a day to day basis. Here's how my event looks, using CNet, v4.22: Name: Platinum Event Type: RunARexx Port(s): 0 Execute Date: Invoke: Immediate-UDump Repeat Days: 1 Repeat Hours: 0 Repeat Mins: 0 Valid Time: 01:00 Status: Ready Unloaded Port: Ignore Checkboxes: Check ALL SEVEN Boxes. Command: Platinum/PLATINUM NOTE: Remember to use YOUR specified above. TIMES: Use 0-12-0 for Days-Hours-Mins to run it TWICE a day, etc. For those using CNet, v3.xx, you can create an event to run the file "Platinum/PLATINUM" once nightly, or weekly. It's an AREXX file. How Do I Use the Platinum Config File? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ More than half the power of Platinum is in it's configurability, as you have control over all aspects of a filelists creation. Once you've run the initial installation script, and have added the new commands to your BBSMENU file, type PLC from any command prompt. The CONFIG file for Platinum will be loaded. This file is a rather formidable "Ansi-ARexx" command module, and allows you to easily modify all data values used within Platinum. Below, you'll see more detailed descriptions of what you'll see on Platinum Config's different screens. Refer to this document if the online help doesn't shed light on a specific value. (Hopefully, it should NOT be neccessary for you to READ all of the following) The initial screen is divided into two regions: upper and lower. In the TOP REGION, you'll find all data pertaining to the individual filelists you wish to create with Platinum: File List - The 10 character filename to be used for this listing. The AmigaGuide version, if created, will use this name, with a "G" appended to the end, like "FILESG", etc. The name "NEWFILES" holds special significance, as it is this file that will be used to list only the NEWEST files uploaded to your system. It MUST be called NEWFILES, else you'll NOT have this special listing created. Txt - A Yes/No toggle as to whether or not you wish to create an Ascii TEXT formatted version of this filelisting. Arc - A 4-way toggle, using ---, ZIP, LHA, and LZX. If --- is not chosen here, then the TEXT version of this filelist will be packed using the signified archiver program. Gde - A Yes/No toggle as to whether or not you wish to create an AMIGAGUIDE formatted version of this filelisting. Arc - A 4-way toggle, using ---, ZIP, LHA, and LZX. If --- is not chosen here, then the AMIGAGUIDE version of this filelist will be packed using specified archiver program. Dos - A Yes/No toggle signifying which format you wish each included directory listing to appear in. If set to YES, then ALL included directories for this listing will use the shorter, less formal listings, however if set to NO, areas you have chosen that are part of CNet integrally will have their data files read to glean more information, like number of times downloaded, if the file passed it's integrity tests, virus tests, etc. Hdr - A 3-way toggle, using 1L, 4L, and 10L. If set to 1L, then this listing will use a 1 line header text, however you can opt to use either a 4 line or 10 line header instead, if you wish to be a bit more formal. The header texts can be modified using Screen 5 of the config program. TextButn - A series of numbers, which correspond to the created text buttons, as to WHICH ONES, and in WHAT ORDER they should appear in when creating the AMIGAGUIDE formatted listings. (See more info on this setting below). Toc - An On/Off toggle as to if a "Table of Contents" should be created in both types of filelists. Set to NO, and the contents will be omitted from the specified listing. Mag - An On/Off toggle as to if a "Magic Filenames" list should be created in both types of filelists. Set to NO, and the magics will be omitted from the specified listing. DLs - An On/Off toggle as to if the "Most Downloaded Files" list should be created in both types of filelists. Set to NO, and this listing will be suppressed from the listing. Sys - An On/Off toggle as to if the "SysOp Favorite Files" list should be created in both types of filelists. Set to NO, and this listing will be suppressed from the listing. Fre - An On/Off toggle as to if the "Free Downloads" list should be created in both types of filelists. Set to NO, and this listing will be suppressed from the listing. Ftr - A 3-way toggle, used exactly the same as the Header file above, where you can opt to use a 1 line, 4 line, or 10 line text file which appears at the END of the listing. Screen 5 in config is used to edit the Footer files. Dir - Displays how many directories exist in specified listing. When edited, a separate screen is presented, which is described more fully below. TinyB - A 4-way toggle, giving: None, Above, Below, and Both. This toggles IF and WHERE you wish the Tiny Navigation Buttons to be used in the AMIGAGUIDE formatted filelist. Set to ABOVE and the buttons will appear BEFORE the lists, while set to BELOW and, right, they'll appear BELOW the lists. Set it to BOTH to have them appear ABOVE and BELOW! In the LOWER REGION, you'll find a listing of your defined MAGIC NAMES, as well as a description on what this MAGIC will send to the user. You will need to create more approriate descriptions for your magics, before using Platinum for the first time. In BOTH REGIONS, you can use numerous commands to move about, as listed at the bottom of the screen. Press your ? or / key to activate the online help mode. Once activated, press the highlighted command character for information as to what that command can do for you. Press your ? or / key AGAIN to disable the online help mode. Editing Text Button Definitions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ As mentioned above, while talking about the "TextButn" field of the UPPER REGION, you'll be presented with a slightly different screen for use in editing this information. Text Buttons are only used in the AmigaGuide formatted filelistings. Platinum will create a series of buttons, directly below the Header text, that the users can click on to be shown more information. You might wish to include a button talking about your bbs, another talking about a network you run, another pertaining to what it takes to obtain more access to your bbs, etc. The possibilities are endless. It is possible to create up to EIGHT(8) text buttons for use in your filelists. When creating a NEW button, you'll be asked for the text you wish to appear on the button(what the USER would see), as well as the full path/filename to the text file you wish to include in this button. Use the SELECT command to specify WHICH buttons, and in WHAT ORDER you wish them to appear in the selected filelist. You do NOT have to include ANY buttons in a filelist if you do not wish to. REMEMBER TO USE THIS COMMAND, as if you see a "0" in the "TextBtn" column in config, then NO buttons will be included, no matter how many you defined as usable above. Editing Directory Paths for Platinum's Use ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From Screen 4, you can specify which directory paths you'd like Platinum to scan for use in filelists. You specify both the exact path to the given directory, as well as a short description of what this path holds. The ORDER of the paths in THIS listing is of NO consequence. Editing Directory Path Inclusions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When you specify you wish to edit the "Dir"'s of a filelist, you'll be shown yet ANOTHER screen for purposes of editing data. This screen has TWO regions to it. The LOWER REGION lists all currently available directory paths, as set on the Screen 4. This region can only be traversed. Data in this region can NOT be edited(again, use Screen 4 for this purpose). The UPPER REGION allows you to specify WHICH lists, and in WHAT ORDER, you wish them to appear in the created filelist. Again, please use the online help mode for more information on what the different commands will do for you. Editing Even More Data In Platinum ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Screen 5 holds yet even MORE data for you to edit. Some of this data may be familiar to you, if you'll remember having entered it during the initial installation procedure. Here is some information on some of the other data values you can edit on this screen: Header, Footer, NewFile, & Guide ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Platinum uses a series of external support text files, while building the filelists. In the "Platinum/Texts/" directory, you'll notice a series of filenames. Here's how Platinum USES these text files: The 1 Line versions of these files will ALWAYS be included in listings, PROVIDED they EXIST. This data is stored in the "Platinum.cfg" file. The "Short" versions of these files will ONLY be used if you specified "4L" on the initial data screen, under the Hdr or Ftr columns. The "NewFile" files will REPLACE the "Header" file for a filelist using the name "NEWFILES", while the "Guide" files replace the "Header" file in all AmigaGuide created filelists(with the exception of NEWFILES, of course). The "Long" versions of these files will ONLY be used if you specified "10L" on the initial data screen. The same "exceptions" will be made with these files, as specified above for the SHORT files. CNet's Visual Editor is used to edit these files, regardless of what you have your account set for, however if you had been using the LINE editor BEFORE editing these files, you'll be given back your line editor when you complete the editing process. Network Node Addresses ~~~~~~~~~~~~~~~~~~~~~~ The AMIGAGUIDE version filelistings have the ability of creating .REQ files, for use with file requesting files over networks. Platinum allows you to specify up to SIX networks you may be using for use in it's listings. The user will be asked to choose ONE of the networks to be used as the NAME of the .REQ file. To clarify the usage of this area abit more, I am aware of the fact that many MORE networks can be defined within CNet, however for usage in your filelists, it is thought that you'd want to use your most noteworthy networks, instead of the "littler" ones. For instance, a user that might be in your "Pinetree Network" is almost probably a member of a larger network, like Fido or CLink, so it's thought these users would(should) opt to select your Fido or CLink address, instead of the littler "Pinetree" net, etc. New Files Minimum Age ~~~~~~~~~~~~~~~~~~~~~ This setting holds the NUMBER of DAYS a file must have been UPLOADED within, in order to be considered a "New Upload" in the NEWFILES listing. There's no easy answer as to what this value should be set to. It will largely depend on how often users upload to your bbs. Minimum # of Downloads ~~~~~~~~~~~~~~~~~~~~~~ This setting is the MINIMUM number of times a file has to have been DOWNLOADED before being added to the "Most Downloaded Files" special list. Again, judging exactly which value YOU should use will largely depend on how active your file areas are. Last, but certainly not Least! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Wow, you're STILL reading this, eh?!? Well, Screen 6 rounds off the plethora of values you have to edit. Here's the overview: Upper Region Pertaining to the "Viewer" Program & Options A, B, and C. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ These values hold little meaning for you in this evaluation version, but hold a bit of significance in the registered release... :hint:hint: :-) Path to Store Lists ~~~~~~~~~~~~~~~~~~~ This is the path where filelists created by Platinum will be stored. It is suggested you use the included "Platinum/FileLists/" path, but the choice is yours to make. Path to FFRI & FFRS Config ~~~~~~~~~~~~~~~~~~~~~~~~~~ These two values are used to specify the locations of support files that are used with the FFRS (Fidonet File Request Server) program for use in automatically updating it's index file each time new lists are created. If you are NOT using FFRS, edit these two values to hold NOTHING. You'll see a confirmation tag of displayed instead. The initial Install script automatically disables this setting, so be sure to activate it IF you ARE a user of FFRS. Path to JamMail FileList ~~~~~~~~~~~~~~~~~~~~~~~~ This is the path where users using JamMail have chosen to store their "banner" type text files. (Those shown during the "Press ESC twice..." procedures). If you are NOT using JAMMAIL, edit this value to hold NOTHING. You'll see a confirmation tag of displayed instead. Again, the same as with the FFRI program, initially, the Install script DISABLES this feature, so be sure to ACTIVATE it if you are using JAMMAIL. File to use with JamMail ~~~~~~~~~~~~~~~~~~~~~~~~ Those SysOps using JamMail as there front-end mailer software can use this option to specify which filelist will be copied for use with the JM keyword FILELIST. Using JamMail, a user can type FILELIST from the "Press ESC twice..." prompt to read an online filelisting. If the above "Path to JamMail" value is set to "", then this option is moot, regardless of it's setting. Archiver Pack Strings ~~~~~~~~~~~~~~~~~~~~~ The last three values on this screen let you edit the pack format strings used for the ZIP, LHA, and LZX archivers respectively. You can opt to use your own settings, or erase everything in the edit area and hit return to use the one you have set in your CNet Config. (Note that during your initial use of the INSTALL file, these values were automatically set according to your CNet config "add" values.) What's in the Future? ~~~~~~~~~~~~~~~~~~~~~ Something I haven't yet finished is the "Online Viewer" module that will allow your USERS to either VIEW or DOWNLOAD one of your filelists. I want to make the viewer also capable of using the MORETEXT file to view the Amiga- Guide listings online, and somehow tie a hook into the listing that will allow the user to "SELECT" the files, instead of adding them to a ".REQ" file. (Not sure how I'm going to do this yet. Probably will make it create the .REQ file, but then when they exit the file, have the viewer read in the contents of the .REQ and add them to the user's Select Buffer, provided they have the access, room, etc.) Later down the road, I'd also like to toy with the idea of letting an online user specify directories they'd like to create a filelisting of, and then launch a background task to create the listing. If completed, and the user was still online, it'd send them an OLM, else it'd add it to their select buffer for download later(just like what the YANK command does). What else?!? I'll add any other features you can think of. ============================================================================ Frontiers BBS (716)/823-9892! ============================================================================