home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / ppage105.zip / PROPAGE.DOC < prev    next >
Text File  |  1995-08-22  |  25KB  |  494 lines
  1.  
  2.                    ┌─────────────────────────────────────┐
  3.                    │            PRO PAGE (tm)            │
  4.                    │                                     │
  5.                    │        V1.05   22 August 1995       │
  6.                    │                                     │
  7.                    │      Copyright 1995, J Hepburn.     │
  8.                    │   (All rights reserved worldwide)   │
  9.                    └─────────────────────────────────────┘
  10.  
  11.  
  12.                               ┌────────────────┐
  13.                               │  INTRODUCTION  │
  14.                               └────────────────┘
  15.  
  16. Pro Page is the ONLY choice when your looking for the ultimate pager utility
  17. for an Adept bulletin board.  With its built-in configuration system, Pro Page
  18. offers a level of control and flexibility far beyond the basic paging functions
  19. in Adept.  Pro Page was first to offer SysOps the paging features they really
  20. needed, and this latest version surpasses all previous achievements. Among the
  21. many new innovations for V1.05 are full colour logging, improved configuration
  22. editor and better security features!
  23.  
  24.  
  25.                          ┌──────────────────────────┐
  26.                          │  PRO PAGE - AN OVERVIEW  │
  27.                          └──────────────────────────┘
  28.  
  29. Pro Page provides two paging periods per day, one of which can be limited to a
  30. minimum security level, whilst weekend paging periods can be defined seperately
  31. from weekday paging periods.  Priority users can page at any time without being
  32. prompted for a reason.  Maximum page attempts are catered for and use the
  33. setting defined in Adept's configuration automatically.  Options exist to limit
  34. paging for first time callers and by user age.
  35.  
  36. The SysOp can be alerted either audibly, visually, audiovisually or a mixture
  37. of both depending on the time of the page.  Audible alerts can be via the
  38. speaker, built-in or external multimedia support.  Full colour logging of page
  39. attempts, including abortive ones, is maintained and can be easily viewed or
  40. deleted by the SysOp.
  41.  
  42. Pro Page automatically recognises and supports ASCII, ANSI and AVATAR and
  43. utilises a 3D window, which overlays on top of the screen being displayed at
  44. the time, to inter-act with the Sysop and user.  This provides for a consistent
  45. interface and minimises the level of configuration work for the SysOp, not to
  46. mention eliminating all those (otherwise) additional ASC/ANS/AVT files clogging
  47. up valuable hard disk space. The interface is pleasant on the eye and designed
  48. to blend in, with nothing more than a discreet logo displayed.
  49.  
  50. Configuration is automatic and built-in, along with error checking at user and
  51. SysOp level. Every aspect of Pro Page's settings is handled by the integral
  52. configuration utility.  There are no additional external files requiring manual
  53. editing.  The SysOp can configure Pro Page either locally or remotely whilst
  54. logged on from another computer.
  55.  
  56.  
  57.                    ┌────────────────────────────────────┐
  58.                    │  PRO PAGE - FILES YOU SHOULD HAVE  │
  59.                    └────────────────────────────────────┘
  60.  
  61. The Pro Page archive should contain the following files:-
  62.  
  63. Propage.erx   -  The Pro Page program in Adepts extended REXX format.
  64. Propage.doc   -  The user manual (your reading it!).
  65. Propagev.exe  -  The visual, WPS PM, alert program.
  66. Qplay.exe     -  An external, hidden, multimedia player (*).
  67. Fm2play.exe   -  An external, WPS PM, multimedia player (*).
  68. History.txt   -  Text file describing historical changes to Pro Page.
  69. File_id.diz   -  Archive management file often used by BBS's.
  70.  
  71. During use, Pro Page will create Propage.log and Propage.cfg, which are the
  72. logging and configuration files respectively.
  73.  
  74.  
  75.           ┌────────────────────────────────────────────────────────┐
  76.           │  PRO PAGE - REQUIREMENTS AND INSTALLATION / UPGRADING  │
  77.           └────────────────────────────────────────────────────────┘
  78.  
  79. In order to use Pro Page you must be running OS/2 V2.1 (or higher), with REXX
  80. installed, and a copy of AdeptXBBS V0.97h (or higher).  You do not need any
  81. additional REXX dll's.  To make use of the multimedia features you must have a
  82. sound card and MMPM/2 installed.
  83.  
  84. Extract Propage.erx and Propagev.exe to your Adept directory.  If you want to
  85. use the multimedia features you should copy your favorite WAV or MID file to
  86. the same directory, and extract Qplay or Fm2play as well if you want to use an
  87. external multimedia player.  Add the following line to each of your menus from
  88. which you want to activate Pro Page, not forgetting to amend the line to use
  89. the key letter (Y) that you want, and also the correct location of Adept:-
  90.  
  91.                 Y ,10 ,pro page,d:\adept\propage.erx,0
  92.  
  93. Log on locally, using your SysOp account, and run Pro Page by pressing the key
  94. you previously specified.  Pro Page will start up and create a default
  95. configuration file, then prompt you to edit the configuration.
  96.  
  97.                                 ----------
  98.  
  99. If you are UPGRADING from an earlier version of Pro Page, extract Propage.erx
  100. and Propagev.exe to your Adept directory, overwriting the older versions.
  101. Log on locally, using your SysOp account, and start Pro Page.  Your original
  102. installation will be recognised and the configuration file automatically
  103. upgraded whilst saving your current settings.  Don't forget that *.erx files
  104. remain in Adept's memory so you MUST shut down and restart Adept after the
  105. upgrade has completed, or before logging on locally to start the upgrade!
  106.  
  107. Three new options have been added to Pro Page v1.05 and will be initially
  108. configured to their default settings.  They are:-
  109.  
  110. [K] Minimum security level to allow normal hours paging - default is 1.
  111. [N] Bar users under * years old........................ - default is 1.
  112. [O] Paging allowed on first call....................... - default is yes.
  113.  
  114. You should enter configuration mode if you want to modify any of these new
  115. settings.  Otherwise, Pro Page v1.05 is ready for use.
  116.  
  117.  
  118.                        ┌────────────────────────────┐
  119.                        │  PRO PAGE - CONFIGURATION  │
  120.                        └────────────────────────────┘
  121.  
  122. The configuration menu shows the current settings and a number of letters in
  123. enclosed [brackets] which, if pressed, display a brief explanation of the
  124. setting and allow you to enter a new setting.  After making any changes you
  125. should press [S] to save, or [Q] to quit without saving the new configuration.
  126.  
  127. A detailed explanation of the settings is as follows:-
  128.  
  129. [A] & [B] are for the start and finish times of the paging hours which will be
  130. available to all users on any day between Monday and Friday inclusive.  The
  131. time must be entered in 24hr (military) format with the hours and minutes
  132. seperated by a point (.).
  133.  
  134. The start and finish time must be within the same calendar day and can be any
  135. length between 1 minute and 23 hours,59 minutes.
  136.  
  137. [C] & [D] are for the start and finish times of the paging hours which will be
  138. available to all users on Saturday and Sunday inclusive. All other information
  139. is as for settings [A] & [B].
  140.  
  141. [E] & [F] are for the start and finish times of the extended paging hours which
  142. will be available to all users with a minimum security level matching that
  143. specified in [L], and on any day between Monday and Friday inclusive. The time
  144. must be entered in 24hr (military) format with the hours and minutes seperated
  145. by a point (.).
  146.  
  147. The start and finish time must be within the same calendar day and can be any
  148. length between 1 minute and 23 hours,59 minutes.
  149.  
  150. Extended paging hours are in effect, a second paging period for the same day.
  151. During these hours Pro Page will display additional information to the user,
  152. though this can be disabled via [L].  If extended paging hours overlap normal
  153. paging hours, then normal paging hours take priority.  That is, if you set
  154. normal paging hours to end at 22.00 and extended paging hours to commence at
  155. 21.00 then between 21.00 and 22.00 the page will be treated as a normal hours
  156. page.
  157.  
  158. You will probably want to configure extended paging hours for late night or
  159. early morning extensions available to your special users (subcribers perhaps?).
  160. If you want to 'wrap' around midnight then set normal hours to end at 23.59 and
  161. extended hours to start at 00.00.
  162.  
  163. [G] & [H] are for the start and finish times of the extended paging hours which
  164. will be available to all users with a minimum security level matching that
  165. specified in [L], on Saturday and Sunday only.  All other information is as for
  166. settings [E] & [F].
  167.  
  168. [I] & [J] are the settings to determine the length of the page attempt before
  169. the user is informed the SysOp is unavailable.  Pro Page displays an increasing
  170. line of stars (*) to the user during a page, where each star indicates one
  171. second.  Enter the duration in seconds, perhaps using a lower value for [J] if
  172. your extended hours are at a time when a shorter page duration would be
  173. preferable.
  174.  
  175. The user can abort a page at any point during this duration but will not be
  176. prompted to leave a message unless the page duration completes.  Keep this in
  177. mind when setting these values.
  178.  
  179. [K] is the minimum security level a user must have in order to be able to page
  180. during normal paging hours.  This number is matched against the number stored
  181. in Adept's User Editor file, known as 'Sec Level 1'.
  182.  
  183. If a users security rating is less than this setting, they will be told the
  184. SysOp is unavailable and returned to the BBS.  Unlike unsuccessful pages, they
  185. will not have the option to leave a message which makes this an ideal way to
  186. bar twit users!
  187.  
  188. [L] is the minimum security level a user must have in order to be able to page
  189. during extended paging hours.  This number is matched against the number stored
  190. in Adept's User Editor file, known as 'Sec Level 1'.
  191.  
  192. To disable the extended hours messages just append this setting with a star (*)
  193. ie: 20*, and reduce the security level to a low number, perhaps the same as
  194. that for your normal users or less.  Extended hours will then respond as a
  195. second 'normal hours' period which is ideal for use in a commercial environment
  196. where you need to suspend paging during a lunch break perhaps.
  197.  
  198. [M] is the minimum security at which 'privileged' paging is allowed.  This is
  199. also matched against 'Sec Level 1' and will allow the user to page at any time
  200. of day or night, without prompting for a reason.  Ideal for your Co-SysOp!
  201.  
  202. [N] is the minimum age for users to be allowed to page the SysOp.  In the
  203. absence of a SysOp's setting, this defaults to the 'minimum age of user on BBS'
  204. setting in Adept's configuration.  Any users whose age is below this setting
  205. will be informed the SysOp is unavailable and returned to the BBS.  Unlike
  206. unsuccessful pages, they will not have the option to leave a message
  207.  
  208. [O] determines whether callers (new users) can page the SysOp during their
  209. first call to the BBS.  If set to NO then users can only page on their second
  210. or subsequent calls.  Otherwise, paging is available on every call.
  211.  
  212. [P] Pro Page normally displays the SysOps name as a full name unless it
  213. contains greater than 15 characters, in which case it is truncated to the first
  214. name in order to avoid character displacement in the Pro Page window.  If you
  215. want your users to see a more personal touch, select 'first name only' to
  216. truncate your name irrespective of its length.
  217.  
  218. [R] is the number of the message area you want any messages placed in.  If the
  219. SysOp is unavailable, or the page is not answered, the user is prompted to
  220. leave a message for the SysOp.  You should choose a local message area,
  221. probably your 'SysOps Office'.
  222.  
  223. [T] is where you decide what sort of alert you want.  There are 4 options:-
  224.  
  225.     Audio              -  Whatever the time of page, Pro Page will alert you by
  226.                           making a noise, either via the internal speaker or by
  227.                           playing a multimedia file.
  228.  
  229.     Visual             -  Whatever the time of page, Pro Page will display a
  230.                           dialog box alerting you to the page.  The dialog will
  231.                           display for 30 seconds before closing.  You must have
  232.                           the propagev.exe file available or this setting will
  233.                           default to audio during a page.
  234.  
  235.     Audio & Visual     -  is a mixture of the two.  A page will result in the
  236.                           dialog box displaying, and an audio alert as well,
  237.                           whatever the time of page.
  238.  
  239.     Audio normaly,     -  will alert you with audio during normal paging hours.
  240.     else visual.          and visually at all other times.  This is ideal for
  241.                           the nocturnal SysOp not wishing to disturb the peace!
  242.  
  243. The above settings apply to all users at the respective times, irrespective of
  244. their security level.
  245.  
  246. [U] is where you decide the type of audio alert to use, and relates to the use
  247. of multimedia . There are 3 options:-
  248.  
  249.     Off (Speaker)      -  Multimedia is in-active and the computers speaker or
  250.                           beeper will sound a warble every second of the page.
  251.  
  252.     On (Internal)      -  Multimedia is active and Pro Page will play the file
  253.                           specified in [R] using its own internal player.  This
  254.                           currently has one disadvantage in that the file must
  255.                           play completely before control is returned to the
  256.                           user or SysOp.  Use a short file, say 10-15 seconds,
  257.                           if you enable this option.
  258.  
  259.     On (External)      -  Multimedia is active and Pro Page will play the file
  260.                           specified in [R] using an external player (such as
  261.                           Qplay.exe * ).  Enabling this option will display a
  262.                           second screen where you must enter the name of the
  263.                           media player file to use.  During a page, Pro Page
  264.                           will spawn a seperate session with the command
  265.                           'mediaplayer soundfile' and return control to the
  266.                           user or Sysop straightaway.  You may specify any
  267.                           media player which uses that format to play a file.
  268.  
  269. [V] is where you specify the sound file to play during a multimedia page.  The
  270. internal multimedia supports both MID and WAV formats, whilst the external
  271. multimedia support is dependent on the media player you use.  Qplay and Fm2play
  272. also support MID and WAV formats.  Enter the file name exactly as it appears,
  273. including any spaces and the file extension (ie: wm_tell.wav).
  274.  
  275. [W] allows you to specify a string of text, up to 56 characters long, to
  276. display to the user when you press the F key in response to a page.  Known as
  277. the FUN KEY, you can use this feature to send the user a humerous (or perhaps
  278. offensive) message. Pro Page terminates after this message is displayed (for a
  279. few seconds).
  280.  
  281. NB:  Qplay is a background media player which once started, will play the whole
  282. sound file with no option to abort.  Fm2play displays a PM dialog with options
  283. to pause, resume or abort playing.  Both programs run independent of Pro Page.
  284.  
  285.  
  286.                            ┌─────────────────────┐
  287.                            │  PRO PAGE - IN USE  │
  288.                            └─────────────────────┘
  289.  
  290. We have dealt with setting up Pro Page and its features.  Now lets summarise
  291. how it works, both for the user and the SysOp.
  292.  
  293. NORMAL HOURS:  When a user pages you, Pro Page will prompt for a reason unless
  294. the user has sufficient security to bypass the reason prompt or is barred from
  295. paging via one of the configuration settings. If no reason is entered the page
  296. will abort.  If the reason is less than 5 characters, or contains multiple
  297. matching characters (ie: KKKKKKK or KGKGKGKG), the user is prompted to enter
  298. a proper reason.   Pro Page will then alert the SysOp according to its
  299. configuration.  Whilst the SysOp is being alerted the user is displayed an
  300. incrementing line of stars (*), one every second, for the duration of the
  301. page. The user can abort the page at any time by pressing the spacebar key.
  302.  
  303. The SysOp may respond by pressing the TAB key to inform the user he is
  304. responding, or the F key to send the FUN KEY message instead.  Pro Page closes
  305. following one of these actions. If the page goes unanswered, the user is
  306. informed of the SysOps unavailability and can either display the paging times,
  307. leave a message or quit.  If the user pages in excess of the maximum page
  308. attempts, Pro Page will inform them and offer the option to view the paging
  309. times or leave a message. No subsequent paging will be allowed until a new user
  310. logs on.
  311.  
  312. EXTENDED HOURS:  Exactly as above but only available to users with sufficient
  313. security clearance unless extended hours have been configured as available to
  314. all users.
  315.  
  316. SYSOP USAGE:  After its initial configuration, subsequent use by the SysOp will
  317. display a menu prompting a choice of either running Pro Page, viewing the log
  318. file, deleting the log file, editing the configuration or quiting.  If Pro Page
  319. is run it will display a header indicating it's in SysOp mode.  Keep in mind
  320. that the SysOp will (or should) be treated as a 'privileged' user due to their
  321. high security level and are also exempt from maximum pages.  To see how Pro Page
  322. works with other users, just edit your settings to temporarily reduce your
  323. security level or log on using a spare account (recommended).
  324.  
  325. LOGGING:  Pro Page maintains a log file containing the date, time, user and
  326. reason for paging.  Colours are used for easy identification of the different
  327. paging reasons, which comprise red for aborted pages; dark grey for pages by
  328. privileged users; and green for successful pages.  These colours are assigned
  329. to the reason column only, whilst date, time and user have consistent colours.
  330.  
  331. The log file is viewed one page at a time, with a static header to ensure easy
  332. identification of the different columns.  Viewing of multiple pages can be
  333. aborted at any page.  A brief summary is displayed at the end of the file.
  334.  
  335. Nb: Dates are in the European format - dd/mm/yy
  336.  
  337.  
  338.                    ┌──────────────────────────────────────┐
  339.                    │  PRO PAGE - REGISTRATION & WARRANTY  │
  340.                    └──────────────────────────────────────┘
  341.  
  342. Pro Page is Shareware.  You may use this program for a period not exceeding 30
  343. days in order to evaluate it, after which you must register it.  To register
  344. Pro Page, complete the form found at the end of this document.
  345.  
  346. After careful consideration I decided NOT to build any form of crippling into
  347. Pro Page.  That is, it will continue to function as supplied whether you
  348. register or not.  I ferverently believe in the honesty of users and accept that
  349. use beyond the evaluation period may occur for reasons other than dishonesty.
  350. I also have a strong distaste for the current trend to cripple software with
  351. time bombs and feature withdrawals.  However, please remember that many hours
  352. of work went into producing Pro Page and dishonest use is not only illegal, but
  353. also deprives an impovrished SysOp of his rightful revenue.
  354.  
  355. Registering Pro Page not only gives you peace of mind but also a copy of the
  356. visual alert program with no 'unregistered' markings.  Support, via my BBS, is
  357. only available to registered users.
  358.  
  359. Pro Page is supplied 'as is'. There is no warranty implied or supplied.  It
  360. works for me, I hope it works for you. If it doesn't - bad luck (but tell me)!
  361.  
  362.  
  363. The current price of Pro Page is:-
  364.  
  365.    Single user version, none commercial ....................... $10.00 (US)
  366.                                                                 £ 5.00 (UK)
  367.  
  368.    Single user version, commercial ............................ $27.50 (US)
  369.                                                                 £15.00 (UK)
  370.  
  371. Single user means one copy per user, licensed for use on one machine at any one
  372. time.  Commercial means use in any environment designed to make profit.  Please
  373. contact the author if you require pricing for multiple site/machine usage.
  374.  
  375. If your paying in a currency other than US or Sterling then please convert the
  376. UK price to your local currency, at prevailing business rates, and send the
  377. equivelent amount.
  378.  
  379. Payment may be either by cheque or cash/postal order made payable to:-
  380.  
  381.                                "Jon Hepburn"
  382.  
  383. Cash may also be sent but is entirely at the senders risk and must be sent via
  384. registered post whereby a signature of receipt is required from the recipient.
  385. Claims of mislaid cash registrations will not be entertained where this method
  386. is not adhered to.
  387.  
  388.  
  389.                       ┌───────────────────────────────┐
  390.                       │  PRO PAGE - ACKNOWLEDGEMENTS  │
  391.                       └───────────────────────────────┘
  392.  
  393. Recognition is afforded to Mark Kimes for his kind permission to include Qplay
  394. and Fm2play in the Pro Page archive.  Both are part of Mark's FM2UTILS package
  395. which along with FM/2, a superb file and utility manager, is worthy of
  396. inspection by anyone using OS/2.
  397.  
  398. Adeptsoft for producing AdeptXBBS and thus making it possible to release Pro
  399. Page - nice work lads, keep it up!
  400.  
  401.  
  402.                    ┌──────────────────────────────────────┐
  403.                    │  PRO PAGE - MISCELLANEOUS FOOTNOTES  │
  404.                    └──────────────────────────────────────┘
  405.  
  406. Shareware vendors wishing to redistribute Pro Page are welcome to do so
  407. providing they do not modify the archive contents in any way, shape or form
  408. other than permissible repackaging to a different archive format.  Vendors may
  409. charge for the distribution of Pro Page but must not levy a charge for Pro
  410. Page itself.
  411.  
  412. Distribution of registered versions of Pro Page is via the author only.  No-one
  413. else is authorised or allowed to distribute or redistribute registered copies.
  414.  
  415. Pro Page may not be modified, reverse-engineered or otherwise dissasembled.
  416.  
  417.  
  418. The author of Pro Page can be contacted by one of the following ways:-
  419.  
  420. Letter to:  Jon Hepburn           E-Mail to:   Jon Hepburn
  421.             P O Box 2485                       Galaxy-Ten BBS
  422.             Maldon                             +44 1621 850032
  423.             Essex                              (2:257/88.0@FidoNet)
  424.             CM9 7FZ
  425.             United Kingdom         Internet:   jon@galaxy10.dungeon.com
  426.  
  427. Comments, suggestions and questions from users are welcomed via one of the
  428. above methods or can be placed in the FidoNet Adept echo which I read.
  429.  
  430.  
  431.                       ┌────────────────────────────────┐
  432.                       │  PRO PAGE - REGISTRATION FORM  │
  433.                       └────────────────────────────────┘
  434.  
  435. To register Pro Page, complete the following form and mail it to the above
  436. address enclosing your payment.  Applications must be received postage paid or
  437. they will be declined (not returned).
  438.  
  439.  
  440. Please register ___ copy/s of Pro Page to the following person/organisation.
  441.  
  442.  
  443.      Name:          _______________________________________________
  444.  
  445.      Company:       _______________________________________________
  446.  
  447.      Address:       _______________________________________________
  448.  
  449.      Town/City:     _______________________________________________
  450.  
  451.      County/State:  _______________________________________________
  452.  
  453.      Post/Zip Code: _______________________________________________
  454.  
  455.  
  456. I enclose a payment of _______ , drawn on ______________________ (currency).
  457.  
  458. I have read and understand the terms under which Pro Page is supplied and agree
  459. to them without modification.  I also agree not to distribute the registered
  460. version unless expressly agreed to in writing with the author.  I agree that
  461. this registration is valid for one whole version level of Pro Page and the cost
  462. of obtaining updates will be borne by myself.
  463.  
  464.  
  465.  
  466.     Signed: ____________________________     Date: ________________
  467.  
  468.  
  469. The following information is optional:
  470.  
  471.      BBS name:      _______________________________________________
  472.  
  473.  
  474.      BBS number:    _________________  Voice number:_______________
  475.  
  476.      E-mail
  477.      addresses:     _______________________________________________
  478.  
  479.  
  480.                     _______________________________________________
  481.  
  482.  
  483.  
  484.                                     <END>
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.