home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / comms / bbs / dtopx101.lzh / DLGTopX.Doc < prev    next >
Text File  |  1991-04-15  |  8KB  |  257 lines
  1.  
  2.  
  3.           ****   **      ****  ******             **    **
  4.           ** **  **     **  ** ******              **  **
  5.           **  ** **     **       **   ****  *****   ****
  6.           **  ** **     ** ***   **  **  ** **  **   **    v 1.01
  7.           **  ** **     **  **   **  **  ** **  **  ****
  8.           ** **  **     **  **   **  **  ** *****  **  **  by Michael
  9.           ****   ******  *****   **   ****  **    **    **     Dreher
  10.                                             **
  11. What is it ??
  12. ~~~~~~~~~~~~~
  13. Just a simple but powerful proggie to generate Top-X-lists of your
  14. users' activities, such as Top-X.Downloaders, -Callers, -Msg-Readers..
  15.  
  16.  
  17. Why DLGTopX and not DLGTop10 ??
  18. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  19. Because you are not limited to a Top-10 or a Top-15 or whatsoever,
  20. but can do as many users in the list as you want (ok, it's not
  21. really unlimited, but Top-x00 should be no problem, it has been
  22. tested with some thousand and worked ok :-)
  23.  
  24.  
  25. What can it do ??
  26. ~~~~~~~~~~~~~~~~~
  27.  
  28. - DLGTopX will generate lists with:
  29.  
  30.                   - Up-/Downloaders (Files and Bytes)
  31.                   - Msg-Readers/Writers
  32.                   - Callers
  33.                   - Chatters
  34.                   - UserAge
  35.  
  36. - Each list has a summary/average shown at the bottom, which also can
  37.   be used as variables in the TopXSummary-File (see below...)
  38.  
  39. - For special purposes, there is the possibility to exclude a user
  40.   from any list (e.g. the SysOp, since he will be always the
  41.   Top-Caller/Msg-Reader/Writer :-)
  42.  
  43. - The Top-User of each list will be informed via his User:*/event.log
  44.   (only when using config-file, switchable..)
  45.  
  46. - You can even make some "inverted" list, with the "Bottom-on-Top",
  47.   try it :-)
  48.  
  49. - any ideas ?? send them to:
  50.  
  51.   Marcus Kuba       @ 2:244/7253 (DLGTopX-World-Support :-) or
  52.   Michael D. Deberg @ 1:232/300  (DLGTopX-USA-Support)
  53.  
  54.  
  55. How does it work ??
  56. ~~~~~~~~~~~~~~~~~~~
  57. DLGTopX  needs  an  ASCII-file  with  formatted user-data, done with
  58. DFExport  (included  in the DLG Professional BB/OS-package..) (later
  59. versions  will perhaps no longer need this, but since the Data-Files
  60. of  DLG Pro are subject to change, we did it the simple and save way
  61. and used DFExport :-)
  62.  
  63. It scans the Data of this file, calculates the Top-X-list of the
  64. specified criteria (Down/Uploads, Msgs, Calls,...) and writes it to
  65. a file you can later show in the BBS (e.g. add a menu-entry which
  66. uses DF to display it...)
  67.  
  68. To run DLGTopX, you should make some script that calls DFExport
  69. first to do the ASCII-file and then lets DLGTopX do its work.
  70.  
  71. The command-line for DLGTopX is:
  72.  
  73. DLGTopX <userfilename> <outputfilename> <listnumber> [X] [Sysopname] [-]
  74.  
  75. where <userfilename>   is the path to the file generated with DFExport
  76.                        (see the files in this archive...)
  77.       <outputfilename> is the path/filename of the generated list
  78.       <listnumber>     is the parameternumber to sort on, where:
  79.  
  80.               0 -> number of downloads
  81.               1 -> downloaded bytes
  82.               2 -> number of uploads
  83.               3 -> uploaded bytes
  84.               4 -> messages written
  85.               5 -> messages read
  86.               6 -> number of calls
  87.               7 -> number of chats
  88.               8 -> user's age
  89.  
  90.   [X]         is the number of output users (default 10)
  91.   [Sysopname] is the Name of the Sysop to exclude from TopXlist
  92.   [-]         tells DLGTopX to sort invers (lowest on top)
  93.  
  94.  
  95. If you use a config-file (recommended..), the command-line is:
  96.  
  97. DLGTopX config <configfilename>
  98.  
  99. where   "config" is a fixed switch to tell DLGTopX to use the file
  100.         <configfilename> to look which lists to generate and where
  101.                          to put them.
  102.  
  103. The format of the config-file is as follows:
  104.  
  105. ---------------cut here----------
  106. <userfilename>
  107. <outputfilename>
  108. <listnumber> [X] [Sysopname] [-] [+]
  109. .
  110. .
  111. .
  112. overall <formfilename> <summaryfile>
  113. .
  114. .
  115. ---------------cut here----------
  116.  
  117. Where <userfilename>    is the same as above, the Filename of the
  118.                         DFExport-ASCII-file
  119.       <outputfilename>  is the path and prefix to all the generated
  120.                         lists, each ending with <listnumber>
  121.  
  122.       <listnumber> [X] [Sysopname] [-]  are the same as above
  123.  
  124.       [+]               is a flag whether or not to inform the
  125.                         user of being the Top-???
  126.  
  127. There can be one <listnumber> [X] [Sysopname] [-] [+]  line for each
  128. of the <listnumbers> (plus one for each with the [-]-flag)
  129.  
  130. If you don't need any of the [X] [Sysopname] ... -flags and wish to
  131. use the default, you MUST enter a "" (twice a " :-) for it.
  132.  
  133. Examples:
  134. ~~~~~~~~~
  135. 4 15 "Marcus Kuba" "" +
  136. \ |        |       |  |
  137.  \|        |       |  inform Top-User
  138.   |        |       normal sort (no Bottom-on-Top)
  139.   |        exclude the SysOp
  140.   create a Top-15 Message-Writer list
  141.  
  142. 6 "" "" - ""
  143. \ |  |  | |
  144.  \|  |  | don't inform User
  145.   |  |  reverse sort (Bottom-on-Top)
  146.   |  don't exclude anyone
  147.   create a "Bottom-10-Caller" list
  148.  
  149. 7
  150. \ |  |  |  |
  151.  \|<-|<-|<-|--- oops, no Data, but not necessary with ALL default
  152.   |  |  |  |
  153.   create a standard Top-10-Chatter list, no exclusion, no reverse
  154.   sort, no info
  155.  
  156. I hope it's clear now ???
  157.  
  158.  
  159. BE CAREFUL: The configfile may NOT include any commentlines or empty
  160.             lines !!! I don't think that this could cause any loss
  161.             of data, but DLGTopX certainly will NOT work properly !
  162.  
  163. (We know that this could be better, but it just would take more time
  164.  for parsing the configfile and checking for any bugs in it, and we
  165.  don't wanna spend our time with debugging configfiles instead of
  166.  adding new useful features to the program :-)
  167.  
  168.  
  169. The "overall"-switch:
  170. ~~~~~~~~~~~~~~~~~~~~~
  171. with the "overall"-switch, you can make textfiles including the
  172. summary- and average-data of each CREATED Top-X-list, for example to
  173. put them at the login or somewhere else in the BBS. You can specify
  174. as much "overall..."-lines as you want.
  175.  
  176. <formfilename>   is the inputfile with the switches
  177. <summaryfile>    is the outputfile with the numbers
  178.  
  179. The inputfile has no special format, so here just a list of the
  180. switches:
  181.                    sum:  average:
  182. DLs             <-  @0     @9
  183. DLbytes         <-  @1     @10
  184. ULs             <-  @2     @11
  185. ULbytes         <-  @3     @12
  186. MsgsWritten     <-  @4     @13
  187. MsgsRead        <-  @5     @14
  188. Calls           <-  @6     @15
  189. Chats           <-  @7     @16
  190. Number of Users <-  @8     @17
  191. Full date       <-  @18
  192. Eventlog date   <-  @19
  193.  
  194.  
  195. If you try to use a switch which has not been created (e.g. using @4
  196. and there was no line telling DLGTopX to create the Top-X-Msg-Writer
  197. list), then this switch will be replaced by a "0" !!
  198.  
  199. You can put a ".y" after the switch, telling DLGTopX that this
  200. number shall be right-justified with y characters width (try it out,
  201. and you'll now what I mean, it's something like DF's option of
  202. making TAB's in the display-files)
  203.  
  204. Sorry, all output will be RIGHT-justified (not LEFT, like when using
  205. DF..), because we think that NUMBERS look better this way :-)
  206.  
  207. Look at the included example-files, you'll see how it' works.
  208.  
  209.  
  210. How must I install it ??
  211. ~~~~~~~~~~~~~~~~~~~~~~~~
  212. Oh, this is quite simple, just copy the files from this Archive to
  213. the appropriate directories and read all the scripts and examples:
  214.  
  215. TopX.form        ->    DLGConfig:Text/
  216. TopXsummary.form ->    DLGConfig:Text/
  217. DLGTopX.cfg      ->    DLGConfig:Misc/
  218. DLGTopX.batch    ->    DLGConfig:Batch/
  219. DLGTopX          ->    anywhere in your Path, e.g. in the C:-directory
  220.  
  221. Then make an event, which call's the DLGTopX.batch every day (every
  222. user ?? :-) and add a menu which uses DF to show the files...
  223.  
  224.  
  225. CopyRight:
  226. ~~~~~~~~~~
  227. DLGTopX is shareware, if you like it and use it, we recommend a
  228. shareware-fee of let's say $10 (15 DM) or send us YOUR proggies to
  229. use with DLG Pro..
  230.  
  231. author:
  232.  
  233.             Michael Dreher
  234.             Wielandstr. 12
  235.  
  236.             7250 Leonberg
  237.  
  238.              West Germany
  239.  
  240. Fido Netmail:  2:244/7253 Intuition Base ++49-7152-45768  HST DUAL V.42bis
  241.  
  242. or write to:
  243.  
  244. Marcus Kuba, SysOp: 2:244/7253 (Intuition-Base, DLGTopX and
  245.                                 CONTRIS!-Support-BBS :-)
  246.  
  247. Special thanks:
  248. ~~~~~~~~~~~~~~~
  249. Marcus Kuba      : - He had the ideas for this program and he
  250.                      was the first tester.
  251.                    - He wrote this documentation.
  252.  
  253. Heiko Richter    : - He was the first (and only ???) who payed the shareware-fee
  254.  
  255. Michael D. Deberg: - for his support in the USA
  256.  
  257.