home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / gsysop.zip / readme.txt < prev    next >
Text File  |  1998-01-03  |  9KB  |  216 lines
  1. Readme for Golden Sysop
  2.  
  3. Installation:
  4.  
  5. 1) Unpack GSYSOP.ZIP into a new directory
  6.  
  7. 2) edit file FORUMS.CFG:
  8.  
  9. example:
  10. NUMBER=1
  11. OS2UGER=Deutsches OS/2 User Forum
  12. PEARLS=Pearl Support Forum
  13.  
  14. First line: NUMBER=[Number of forums you're sysop for]
  15. further lines: [GOWORD for forum]=[Forum LongName]
  16.  
  17. please note: NUMBER= must appear in first line of FORUMS.CFG. Each forum must appear in a separate line.
  18.  
  19. 3) Create CFG files for your forum(s):
  20.  
  21. SAMPLE.CFG is a sample file (in this case, SAMPLE is the GO Word for a Forum). If you're sysop at GCPSUPPORT you have to create a GCPSUP.CFG file (for example).
  22.  
  23. To create such a CFG file, please copy SAMPLE.CFG and rename it. Edit the new files with E or EPM and edit the first line of the file.
  24.  
  25. This line is set to:
  26.  
  27. PrePath=e:\gcp299m\
  28.  
  29. Please replace e:\gcp299m\ with the complete path of your Golden CommPass installation (ending with \ )
  30.  
  31. 4) Start the program with doubleclick onto GSYSOP.EXE
  32.  
  33. 5) If you have created more than one individual CFG (this means, if you're working for more than one forum) a dialogue appears, which allows you to select one forum you actual want to work with. 
  34.  
  35. 6) Select PreviewFiles/Select Libraries to define the libraries you want to scan (maybe you get all Previewed libraries of your Forum, but you're only interested in a few or one section).
  36.  
  37.  
  38. July, 30th 1997: Only E-Mail to uploader works well, all other features not implemented yet.
  39.  
  40. News on December, 31th 1997:
  41.  
  42. Now the following features work well:
  43.  
  44. - E-Mail to Uploader
  45. - Private and sysop-public message to uploader
  46. - New Message (to announce new uploads)
  47. - Disposition features: Download, Release, Merge, Cancel, Move
  48. - Building TopTen's: Top 10, Top 100, Top 20, .... as comma-separated ascii files (alltime.res)
  49.  
  50.  
  51.  
  52.  
  53. FAQ
  54.  
  55.  
  56. How to use the configurable Mail/Message files?
  57.  
  58. You have the following "template" files for your automatic messages and mails:
  59.  
  60. MAIL_OK.TXT        to use for e-mails generated by selecting "Upload OK"
  61. MAIL_VIR.TXT        to use for e-mails generated by selecting "Virus!"
  62. MAIL_LIC.TXT        to use for e-mails generated by selecting "License!"
  63. MAIL_CON.TXT    to use for e-mails generated by selecting "wrong forum!"
  64. NEW_1.TXT        to use for forum message announcements (for new uploads).
  65.  
  66. You can edit these files the way you like. Notice, these files are _exactly_ the mail/message
  67. you will send.
  68. To make it more "automatic" you can use the following "fields". Golden Sysop
  69. automatically will replace these "fields" with the right things.
  70. For example: If you want to insert the correct actual file name
  71. in your mail or message, you insert the "field" [FileName] into your template file.
  72.  
  73. Golden Sysop uses knows the following fields:
  74.  
  75. [Forum] - For the forum GO-Word, such as GCPSUP
  76. [ForumName] - For the Forum Description that you have entered in FORUMS.CFG
  77. [Name] - for the Uploader's user name
  78. [FileName] - for the name of the upload that was distributed
  79. [FileDescription] - the complete description of the uploaded file
  80. [LibraryNumber] - the library number where the upload was distributed
  81. [UploadDate] - the date of the upload
  82. [UploadTime] - the time of the upload
  83. [ForumNameDativ] - only for german sysops (please ask 104125,2070 for detailed information)
  84. [FileTitle] - the title (or short description) of the uploaded file
  85. [Date] - the current date in this form: YY/MM/DD
  86. [DateLong] - the current date in this form: 31 Dec 1997
  87.  
  88. There are two more fields, which are only allowed to use in NEW_1.TXT for announcement messages:
  89.  
  90. "[FileSize]" - the size of the file
  91. "[LibraryName]" - the library's name (for example: You have a library 0 "Sysop Library".
  92.                      In this case, "0" is the "[LibraryNumber]" and "Sysop Library" is the "[LibraryName]")
  93.  
  94. Please note: You have to insert _exactly_ these "field" names. Only if you have exactly used these
  95. names, Golden Sysop will work properly.
  96.  
  97.  
  98. The Subject (or title) line
  99.  
  100. Each of the mail/message templates have a first line, a so called "subject line").
  101.  
  102. For example, this line is:
  103.  
  104. {Subject:New File [DateLong]}
  105.  
  106. This line must be start with { and end with } - and the "Subject:" is also needed!
  107. After {Subject: you can insert the subject you want to have for the mail or message. It's allowed
  108. to use the "fields" (see above for a list of these "fields").
  109.  
  110.  
  111. The signature lines
  112.  
  113. Please note that automatic mails and messages, created with Golden Sysop, do not use the Signatures
  114. that are provided (if configured) by Golden CommPass. To have signatures in your mail or messages, 
  115. you have to insert the signature lines into the template files for your Golden Sysop mails and messages.
  116.  
  117. In a sample file these lines are:
  118.  
  119. .___YOUR NAME____
  120. .Sysop [ForumName]
  121.  
  122. For a simple signature, just replace the "___YOUR NAME____" string with your name.
  123.  
  124. In my case, I use the following signatures lines in each of my mail/message template:
  125.  
  126. .  Carsten Müller
  127. .
  128. .  Sysop
  129. .  [ForumName]
  130.  
  131.  
  132.  
  133. How to use the TopTen functions
  134.  
  135.  
  136. Building TopTen is just implemented and works only for
  137.  
  138. - all libraries (you can not select the libraries that you want to have for the TopTen)
  139. - alltime TopTen (this means you can not create monthly or weekly TopTen's)
  140.  
  141. First, you have to create a new forum catalog (there's a button in Golden Sysop which you can use 
  142. give Golden CommPass the command to create a new catalog).
  143.  
  144. Note: If you create this new catalog with Golden CommPass and _not_ with Golden Sysop, you have
  145. the chance to select the libraries you want to have for the TopTen! Golden Sysop's button to download 
  146. a new catalog will create a catalog of _all_ libraries!)
  147.  
  148. After creating a new catalog you can select what kind of TopTen you want to have (for example Top10,
  149. Top100, Top250 or maybe Top 173...? <g>) and push the "Build Top x" button.
  150.  
  151. After the build process you see the result in the multiline edit field at the right side of the Building
  152. TopTen Window.
  153.  
  154. The result comes in comma separated form and is stored in the file "alltime.res" in your Golden Sysop
  155. directory. This alltime.res file you can easily open in many word processor or spreadsheet applications
  156. to reformat it or use it otherwise.
  157.  
  158. At this moment, these are all of the features to build a TopTen. There are coming more.... soon!
  159.  
  160.  
  161.  
  162. How to use the membership report feature
  163.  
  164. Golden Sysop 0.9 and higher provides a new user interface to download membership reports. It's a little
  165. bit easier to select what kind of membership report you want to have.
  166.  
  167. Just select Membership/Get Membership reports - the user interface is simple and easy to use.
  168.  
  169.  
  170.  
  171. How to use the mail to members feature
  172.  
  173. Well, the "Mail to members" feature (you find it with the menu Membership/E-Mail to members) is
  174. one of my privat favorites of Golden Sysop. With this feature you're able to create mails to lots of
  175. your forum's members with just a few mouse clicks.
  176.  
  177. For example: If you want to "welcome" all new members, which joined your forum within the last days
  178. you have to get a membership report ("by date joined"). After downloading the report, you take 
  179. the mail to members feature of Golden Sysop and do the following:
  180.  
  181. - load the membership report file (in this case it's the FORUMNAME.DJN file)
  182. - load your e-mail template file (which you have created before)
  183. - Push the OK button
  184.  
  185. With the next online pass of GCP your mails will be sent to _all_ the members that are in the 
  186. membership report name (in this case FORUMNAME.DJN).
  187.  
  188. A "little" sample for your e-mail template file for this function you can found as "MEMBERS.TXT"
  189. in the Golden Sysop ZIP archiv. Feel free to change it with any ascii editor (such as E.EXE) to 
  190. configure it in the way you want to have it.
  191.  
  192. Please note: The E-Mail to members function does _not_ support field variables (you know, the fields
  193. that you have in the E-Mail to uploaders or the New Message functions). 
  194.  
  195. This feature not only works for DJN files. It also works for all other membership report files.0
  196.  
  197.  
  198.  
  199. What is planned for future releases of Golden Sysop?
  200.  
  201. Well, there are many things I really want to implement in the next future. These are:
  202.  
  203. - Completing the TopTen features:
  204.   weekly and monthly TopTens, automatic generating uplades and messages with the TopTen results
  205.  
  206. - Creating membership base features:
  207.   Editing membership entries to modify flags, user names, speacial accesses and all that stuff
  208.  
  209. If you have suggestions, bugs or something else, please feel free to contact me: 104125,2070
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.