TOPPER v1.1 by Henri Veisterä ============================= - A Freely Customizable Top X Bulletin Creator For Xenolink Document Index: =============== 1. Updating from version 1.0 2. Version history 3. Quick example 4. Usage 5. Installing 6. Output 7. Customizing 8. Unwanted users 9. Extra mush 10. The End 1. Updating from version 1.0 ============================= If you already have Topper running on your system, do this: 1. Read the section 2. Version history for update info. 2. Make a directory XENOLINK:Text/Topper. Move your Topper form files (XTEXT:T*F*.*), XENOLINK:Ratings.txt and XENOLINK:NoTopper.txt files here. 3. New default output directories are XENOLINK:Text/0/ for ascii and XENOLINK:Text/1/ for ansi. Both ansi and ascii versions now have the same name without the suffix (.txt or .gr1) so you can't use the same directory for both. You can change the directories with the -o1 and -o2 command line options. 4. Edit your Ratings.txt file and change all the ":" in ratios to "~". "1:3" -> "1~3" 5. Copy the new executable over your old one. 2. Version history =================== Version 1.1 - released 01-Apr-1995 ---------------------------------- Fixed a bug where Topper could crash if there were no Uploads/Downloads/Messages/Calls recorded in the user file for any of the users (ie. zero users to display in the charts). If user had more than 1,4 Giga Bytes of uploads/downloads/etc. this was not displayed correctly. Now displays correctly upto Xenolink's own maximum of 2,4 GB. Changed the default paths so that Topper no longer needs the obsolete Z3 version assigns (XUSERS: XTEXT: XBULLETINS:). All Topper files can now be found in the XENOLINK:Text/Topper/ directory. Topper now has different output dirs for ansi and ascii versions. The default path for ascii texts is XENOLINK:Text/0/ and for ansi texts XENOLINK:Text/1/. There is no -o option anymore, this was replaced with the -o1 and -o2 options. Added the ~P tilde code to display users alias. Added the ~Z tilde code to display users download bytes divided by their upload bytes or vice versa with one decimal point accuracy. A plus (+) sign is added if user has more uploads than downloads and a minus (-) sign is added if user has more downloads than uploads. Added the -k option for a double row display (two users per line). Added the -j command line option to specify the character to separate three digit groups in numbers displayed (default is "'" : 9'999'999). Changed the ratio separator in Ratings.txt from ":" to "~" so that you can use ":" in your ratings. Version 1.0 - released 16-Dec-1992 ---------------------------------- First public release. 3. Quick example ================= To quickly try out Topper try this in CLI in the directory where you unpacked the Topper archive (in this example to ram:) MakeDir ram:0 ram:1 Topper -a -b -c -d -e -f -g1 -r -iram:Topper/Forms1/ -o1ram:0/ -o2ram:1/ Type ram:0/Topper#? Type ram:1/Topper#? Topper -a -b -c -d -e -f -g1 -iram:Topper/Forms2/ -o1ram:0/ -o2ram:1/ Type ram:0/Topper#? Type ram:1/Topper#? Topper -a -b -c -d -e -f -g1 -k -r -20 -iram:Topper/Forms3/ -o1ram:0/ -o2ram:1/ Type ram:0/Topper#? Type ram:1/Topper#? 4. Usage ======== Topper can be run from the CLI or from a script. The command line syntax is as follows: Topper - -[options] Where is one or more of: -a - create two charts (ansi&ascii) sorting users by their upload bytes -b - create two charts sorting users by their download bytes -c - create two charts sorting users by their uploaded files -d - create two charts sorting users by their downloaded files -e - create two charts sorting users by their calls to bbs -f - create two charts sorting users by their written messages -g - create two charts sorting files by their access count -g option format is: -gfilebase1,filebase2,filebase3... And [options] is one or more of: -i - input path for the form files -o1 - output path for the ascii output files -o2 - output path for the ansi output files -xx - the number of users/files to include in the chart ranging from 1-9999, default is 10 -j - three digit group separator, default is "'" (ex. 9'999'999) -r - copyright message at the end of the output, no screen clearing code at the beginning of output, plan for this in your form files -k - display two users per row The paths (-i -o1 -o2) must have a trailing slash (/) or colon (:). The options are not case sensitive and can be in any order. Example command lines: Topper -f -e -20 - Create caller and message charts for the 20 best users. Topper -g20,1 -a -b -15 -o1ram:0/ -o2ram:1/ -ixtext:myforms/ -r - Create most downloaded file charts from files in filebases 20 and 1 and upload and download bytes charts for the 15 best users and files. Output files are created in ram: and the form files are fetched from the xtext:myforms/ directory. The copyright message is inserted at the end of the output. Topper -a -b -c -d -e -f -g1,2 -j, - Create all possible charts for the 10 (default) best users/files. Output and input paths are the default ones. The numbers displayed look like this: 1,234,567,890 . 5. Installing ============== First copy the executable file 'Topper' to your c: directory. Make a directory with the name XENOLINK:Text/Topper. Copy the T*F*.* files to your XENOLINK:Text/Topper/ directory. Copy the NoTopper.txt and Ratings.txt to your XENOLINK:Text/Topper/ directory. Or use the installation script provided. Normally this kind of a utility would be run from your logout.X script(s). To do this add this or a similar command line to your script(s): Topper -a -b -c -d -e -f -g1,2,3,4,5 -r Alternatively you can update the charts every time a users wants to view them. You can use the TypeFile command in Xenolink to display your charts. 6. Output ========== Topper's default output directories are your XENOLINK:Text/0/ and XENOLINK:Text/1/ directory. Specify a different output path with the -o1 and -o2 options. The fixed names for the charts are: TopperUl - top uploaders (bytes) TopperDl - top downloaders (bytes) TopperUl2 - top uploaders (files) TopperDl2 - top downloaders (files) TopperCalls - top callers TopperMsgs - top message writters TopperFile - top downloaded files 7. Customizing =============== Output is customized with 10 different T*F.* files. The default path for these files is your XENOLINK:Text/Topper/ directory. Specify a new path with the -i command line option. The tilde (~) codes in these files are replaced with the relevant information and a copyright notice is added either to the top or to the bottom of the output files (see option -r). You can edit these files as much as you want to with a common text editor. The first line starting with two @-chars is copied for every user or file listed and the tilde codes are again replaced with the relevant information. The actual difference with the .gr1 and .txt files is that you get an ansi copyright line for the .gr1 files and an ascii one for the .txt files. Your .txt files can of course contain ansi-sequences or control codes if you so wish (and vice versa). The tilde codes are: - @@ line codes for users (strings or 32 bit integers) ~A - a running number starting from 1 increased for every user by 1 ~B - current users name ~P - current users alias ~C - users location ~D - users uploaded bytes ~E - users downloaded bytes ~S - users uploaded kilos ~T - users downloaded kilos ~F - uploaded files ~G - downloaded files ~H - number of calls ~I - number of messages ~V - users rating (length defined in Ratings.txt) ~W - download:upload ratio "1:123" (fixed length is 5, always use: ~WWWW) ~Z - dl/ul ratio "-27.3" or ul/dl ratio "+ 2.6" (always use: ~ZZZZ) - @@ line codes for files (strings or 32 bit integers) ~a - filename ~b - files uploader ~c - files section ~d - files length ~e - access count ~f - date uploaded (fixed length is 9, always use: ~ffffffff) ~g - date last downloaded (fixed length is 9, always use: ~gggggggg) - tilde codes to place anywhere (strings or 64 bit integers) ~J - total number of bytes uploaded to the bbs ~K - total number of bytes downloaded ~L - total files uploaded ~M - total files downloaded ~N - total calls to bbs ~O - total messages written by all the users ~Q - total uploads in mega bytes ~R - total downloads in mega bytes ~X - total uploads in kilo bytes ~Y - total downloads in kilo bytes ~U - total number of users You control the space taken up by these codes like this: ~BBBBBBBBBBBBBBBB - Displays the first 17 chars of the users name. Another thing you can customize are the ratings you can give to users by their upload to download ratios. These ratings are defined in a file called XENOLINK:Text/Topper/Ratings.txt . The format of the file is : ... 1~RATIO,RATING 1~1,RATING RATIO~1,RATING ... The 1~RATIO's are for those people who have more upload bytes than download bytes. And the RATIO~1's are for those who have more download bytes than upload bytes. You can have one 1~1 ratio rating for those who have approx. the same amount of uploads and downloads. An example: You have these ratings defined: 1~3,Best! 1~2,Good! 1~1, - 2~1,Bad!! An user with 1024'1234 upload bytes and 512'0617 download bytes has a ratio of 1~1024'1234/512'0617 = 1~2. His rating would be 'Good!'. An user with 1024'1234 upload bytes and 512 download bytes would get the rating 'Best!' altough his actual ratio is much larger. An user with 345'434 upload bytes and 1'234'321 download bytes would get the rating 'Bad!!' and so on. All users whose ratios are in the 1~1.4 - 1.4~1 range get the 1~1 rating ' - '. Be careful to check that all your ratings are of equal length. If some are shorter than the others, pad them with extra spaces or other chars. Do not use the tilde ~ char in your ratings texts. 8. Unwanted users ================== If you have users (like yourself and your aliases) you don't want to have in the charts, list their names in a file called XENOLINK:Text/Topper/NoTopper.txt. End every name with a return (ascii code 10). The names are not case sensitive. See example in archive. 9. Extra mush ============== If for some reason you want different NoTopper.txt files for your charts do this: Make many NoTopper files and name them something like NoTopper.1 , NoTopper.2 ... . Use a logout.X script like this: ... cd XENOLINK:Text/Topper copy NoTopper.1 NoTopper.txt Topper -a -10 copy NoTopper.2 NoTopper.txt Topper -b -10 ... copy NoTopper.6 NoTopper.txt Topper -f -10 ... 10. The End =========== Topper was coded in 100% assembler by me, Henri Veisterä. To contact me leave a message to 'Henri Veistera' in the xenolink.util net-area or e-mail me at hveister@snakemail.hut.fi . Topper has been tested under many different Amiga/Xenolink setups but if for some reason it wipes out your hard drive, I'm not responsible.