home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / RADIST.ZIP / FILEINFO.RAD < prev    next >
Text File  |  1997-07-02  |  7KB  |  158 lines
  1. Specifications and information for using the FILE_ID.DIZ file in any
  2. archive/file which is distributed by RADIST <RAD> the RemoteAccess File
  3. Distribution Network.
  4.  
  5. Originally prepared primarily for use by ASP (Association of Shareware
  6. Professionals) Author members and edited for use by authors of software
  7. to be distributed by the RADIST <RAD> the RemoteAccess File Distribution
  8. Network.
  9.  
  10. Original text: FILEID.TXT v1.7 by Richard Holler [CIS 73567,1547]
  11. Last Revision 03/11/93
  12. FILEINFO.RAD v1.0 Edited 11/01/95 by Ronnie Toth [1:135/71 - Fidonet
  13. rtoth@sunshine.com - InterNet]
  14.  
  15. FILE_ID.DIZ INFORMATION
  16. -!---------------------
  17. Basically, the FILE_ID.DIZ file is a straight text file which contains a
  18. description of your program, and is used for online file descriptions on
  19. BBS systems.  We recommend that the FILE_ID.DIZ file be used in all of
  20. your distribution archives.
  21.  
  22. This text file contains a description of the FILE_ID.DIZ file.
  23.  
  24. WHY SHOULD YOU USE FILE_ID.DIZ?
  25. -!-----------------------------
  26. The use of this file will insure that the online description of your
  27. program will be in your own words (and who better to describe your
  28. program than yourself?), and that it will remain the same no matter how
  29. many different people upload your file to various BBS systems.
  30.  
  31. As more and more BBS software makes use of this file, you can be assured
  32. that your own description will replace such online descriptions as "Cool
  33. Program" or "OK utility, but needs better ..."
  34.  
  35. BACKGROUND
  36. -!--------
  37. FILE_ID.DIZ was created by Clark Development for use with their
  38. PCBDescribe utility, as a means for BBS callers to upload a file without
  39. having to manually type in a file description.  It also ensures that the
  40. online description is always the same regardless of the number of
  41. different BBS systems the file is posted on.  It has since been accepted
  42. more-or-less as the "standard" archive file description.  (The "DIZ"
  43. actually stands for Description In Zip).
  44.  
  45. DESCRIPTION
  46. -!---------
  47. The FILE_ID.DIZ file is nothing more than a straight ASCII text file
  48. which contains the full description of the archived file containing it.
  49. It can be used by the RemoteAccess BBS software to describe your program
  50. and should be placed *INSIDE* your distribution archive file.
  51.  
  52. RemoteAccess software will "look" inside the archive file.  If a
  53. FILE_ID.DIZ file is found, it will replace any existing online file
  54. description with the text contained in FILE_ID.DIZ.  It is an excellent
  55. method for making sure that your program files are described the way
  56. that "you" want them described.  Even sysops whose software can't
  57. automatically use the FILE_ID.DIZ file have found it to be an excellent
  58. source for manually adding their file descriptions.
  59.  
  60. STRUCTURE
  61. -!-------
  62. The file consists of straight ASCII text, up to 10 lines of text, each
  63. line being no more than 45 characters long.  It should NOT contain any
  64. blank lines, any form of centering or formatting, or any HI-ASCII or
  65. ANSI characters. (i.e. it should ONLY contain alpha & numeric
  66. characters).
  67.  
  68. We recommended that it consist of 5 basic parts:
  69.  
  70.    1. the proper name of your program
  71.    2. the version number
  72.    3. the version(s) of RemoteAccess that the program is written for
  73.    4. the description separator
  74.    5. the description
  75.  
  76. All of the above parts should be separated by a single "space".
  77.  
  78. PROGRAM NAME: To set it apart from the rest, it is recommended that you
  79. use ALL CAPS for the program name.
  80.  
  81. VERSION NUMBER: The version number should be in the form of "v12.34".
  82.  
  83. REMOTEACCESS VERSION IDENTIFIER: The version(s) of RemoteAccess should
  84. be in the form "RA2.xx" if only for use with any version 2 RemoteAccess
  85. or "RA1.xx/2.xx" if able to be used with both versions of RemoteAccess.
  86.  
  87. DESCRIPTION SEPARATOR: To separate the actual description text, insert a
  88. simple "-" (dash/minus) character after the RemoteAccess identifier (or
  89. version number), and in front of the description text.
  90.  
  91. DESCRIPTION: You should attempt to FULLY describe your product,
  92. including its most important functions and features.  Be sure to include
  93. anything which will separate your program from it's competition.
  94.  
  95. You should try to use the first 2 lines of the text to give a basic
  96. description of your program.  This is helpful for sysops who are not
  97. using the full FILE_ID.DIZ in the FDB and the FILES.BBS file limits them
  98. to less than 10 lines, 45 characters.  Sysops who are limited to using
  99. shorter descriptions can simply use the 1st two lines and truncate the
  100. rest.  Thus, you can basically still supply your own description if the
  101. FILE_ID.DIZ is not used in the RemoteAccess FDB description.
  102.  
  103. The remaining lines of text can be used to elaborate on the programs
  104. features, enhancements from the prior version, information concerning
  105. multi-file sets.  It is advisable that you create your FILE_ID.DIZ file
  106. so that the file can be truncated to various line lengths without
  107. destroying it's usefulness.
  108.  
  109. EXAMPLE
  110. -!-----
  111. MY PROGRAM v1.23 (RA2.xx) - A program which
  112. will do anything for anybody.  Will run in
  113. only 2k of memory.  Can be run from the
  114. command line, or installed as a TSR.
  115. Completely menu-driven.  Version 1.23 reduces
  116. the previous 4k memory requirements, and adds
  117. an enhanced graphical user interface.  Also,
  118. MY PROGRAM now contains Windows and DESQview support.
  119. Coming soon - an OS/2 version.
  120. From Do-It-All Software, Inc.  $15.00
  121.  
  122. MULTIPLE DISK INFO
  123. -!----------------
  124. Please note that if your distribution archive requires multiple archive
  125. files, you should create a separate, specific FILE_ID.DIZ file for each
  126. archive. This can be utilized to describe the various contents of each
  127. archive, and to identify each disk in the set. For example, the
  128. FILE_ID.DIZ file for disk #1 could contain:
  129.  
  130.    "MY PROGRAM v1.23 (RA2.xx) Program Executable
  131.     Files - Disk 1 of 2"
  132.     [followed by detailed description text]
  133.  
  134. while the FILE_ID.DIZ file for disk #2 could contain:
  135.  
  136.    "MY PROGRAM v1.23 (RA2.xx) Documentation Files -
  137.     Disk 2 of 2"
  138.     [followed by more detailed description text]
  139.  
  140. Optionally, you could also create a "complete" FILE_ID.DIZ file for the
  141. first disk, which would fully describe the program in detail, and
  142. identify it as Disk 1 of x. Then, for each remaining file in the set,
  143. simply include the Program Name, version number, RA identifier, and the
  144. disk number (i.e. "MY PROGRAM v1.23 (RA2.xx) Disk 2 of x").
  145.  
  146. ADDITIONAL INFO
  147. -!-------------
  148. Please don't be tempted to use fancy graphic or ANSI sequences in the
  149. FILE_ID.DIZ file, as there is still processing software that will not
  150. allow this, and will render your FILE_ID.DIZ file useless or stop
  151. distribution at that point.  Also, don't be tempted to simply copy your
  152. program description file to FILE_ID.DIZ.  Attempting to "format" your
  153. FILE_ID.DIZ file (i.e line centering, right & left justification, etc)
  154. may also cause unexpected results.
  155.  
  156. <*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*>
  157.  
  158.