home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / top2src.zip / LNG_HELP.TXT < prev    next >
Text File  |  1995-07-06  |  6KB  |  143 lines
  1. ~ShortHelp
  2.     Displayed both when the user enters TOP, and when the user presses
  3. ENTER without typing anything.  It follows the list of the names of people
  4. that are in the Pub.
  5.  
  6. Parameters:  None
  7. ~SitDown
  8.     Displayed when the user enters TOP for the first time.  This item is
  9. purely to set a "mood" and is not important.
  10.  
  11. Parameters:  None
  12. ~EnterName
  13.     This is a prompt that is displayed in LOCAL and LAN modes when the user
  14. needs to enter his or her real name.  You should specify a colour setting
  15. at the end of this item to indicate what colour the user's name will be
  16. echoed back in.  A space at the end of this item is also recommended.
  17.  
  18. Parameters:  None
  19. ~Searching
  20.     Displayed while TOP is searching for the user's name in the user file.
  21.  
  22. Parameters:  @1 - Name being searched
  23. ~EnterPW
  24.     This item is the prompt for the user's password.  It is only displayed
  25. if the user's password in the user file is not blank.  A colour setting at
  26. the end is recommended, and will be the colour used to echo back the
  27. password "mask" characters (* by default).  A space at the end is
  28. recommended.
  29.  
  30. Parameters:  None
  31. ~InvalidPW
  32.     Displayed each time the user enters an invalid password.
  33.  
  34. Parameters:  None
  35. ~MaxPW
  36.     Displayed if the user does not enter the correct password within the
  37. maximum number of allowed tries.
  38.  
  39. Parameters:  @1 - Maximum number of tries allowed
  40. ~LogMaxPW
  41.     This is what will be written to the log when the user does not enter
  42. the correct password within the maximum number of tries.
  43.  
  44. Parameters:  None
  45. ~Greeting
  46.     Displayed to the user after his/her user record has been found, as a
  47. welcome.
  48.  
  49. Parameters:  @1 - User's login name
  50.              @2 - User's record number
  51.              @3 - Number of days since the user last entered TOP
  52. ~Setup
  53.     Displayed while TOP logs in the user and notifies other people in TOP
  54. that the user has entered.  This does not usually take very long, so you
  55. can use this item for nearly anything.
  56.  
  57. Parameters:  None
  58. ~LogHandle
  59.     Written to the log when the user logs in if handles are enabled.  If
  60. handles are not enabled, this item is not used.
  61.  
  62. Parameters:  @1 - User's handle.
  63. ~LogStartSignOn
  64.     Written to the log when a user begins the New-User Signup Procedure.
  65.  
  66. Parameters:  None
  67. ~EnterHandle
  68.     Prompts the user to enter a handle that will be used to identify his or her
  69. self in TOP.  It is also used in the Bio. Editor when a user changes their
  70. handle.  It is not used if users are not allowed to enter/change their handles.
  71. A colour setting at the end is recommended, and will be used to echo back the
  72. handle that the user types.  A space at the end is also recommended.
  73.  
  74. Parameters:  None
  75. ~LogAbortSignOn
  76.     Written to the log when a user aborts the New-User Signup.
  77.  
  78. Parameters:  None
  79. ~HandleInUse
  80.     Displayed when a user enters a handle that is already in use inside
  81. TOP.  Not used if users are not allowed to enter or change their handles.
  82.  
  83. Parameters:  None
  84. ~EnterNewPW
  85.     Prompt for the user to enter a new password.  Used when the users
  86. changes his or her password.  A colour setting at the end is recommended,
  87. and will be the colour used to echo back the password "mask" character (*
  88. by default), and a space at the end is also recommended.
  89.  
  90. Parameters:  None
  91. ~ConfirmPW
  92.     Prompt for the user to confirm the newly entered password by entering
  93. it a second time.  Used when the users changes his or her password.  A
  94. colour setting at the end is recommended, and is used to echo back the
  95. password "mask" character (* by default).  A space at the end is also
  96. recommended.
  97.  
  98. Parameters:  None
  99. ~PWNoMatch
  100.     Displayed if the password the user enters to confirm a changed password
  101. does not match the one originally entered.  Used when a user changes their
  102. password.
  103.  
  104. Parameters:  None
  105. ~GenderPrompt
  106.     Prompts the user for their new gender.  This is used when the user
  107. first signs in to TOP, and also when the user is changing their gender (if
  108. gender changes are permitted).  NOTE:  AS MENTIONED, THIS IS _ALWAYS_ USED
  109. IN THE NEW-USER SIGNON PROCEDURE, SO DON'T NEGLECT IT JUST BECAUSE YOU HAVE
  110. GENDER CHANGES DISABLED!  A space at the end is recommended.  Unlike most
  111. prompts, you will NOT need a colour setting here, because the text
  112. displayed once the user selects a gender, the language item for that gender
  113. will be displayed, and these items usually (and should) have their own
  114. colour settings.
  115.  
  116. Parameters:  None
  117. ~GenderKeys
  118.     These are the keys used to select a gender.  This is used when the user
  119. first signs in to TOP, and also when the user is changing their gender (if
  120. gender changes are permitted).  NOTE:  AS MENTIONED, THIS IS _ALWAYS_ USED
  121. IN THE NEW-USER SIGNON PROCEDURE, SO DON'T NEGLECT IT JUST BECAUSE YOU HAVE
  122. GENDER CHANGES DISABLED!
  123.  
  124.     The first character is the key to select the Male gender, and the second
  125. character is the key that selects the Female gender.  If this item is longer
  126. than two characters, all other characters will be ignored.
  127.  
  128. Parameters:  None
  129. ~Female
  130.     This is simply the word "Female".  It should include colour codes if
  131. desired.
  132.  
  133. Parameters:  None
  134. ~Male
  135.     This is simply the word "Male".  It should include colour codes if desired.
  136.  
  137. Parameters:  None
  138. ~EnterDescPrompt
  139.     Prompts the user to enter a short description of themselves.  This is used
  140. when a new user signs into TOP.  A space at the end is recommended
  141.  
  142. Parameters:  None
  143.