home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / CLIPPER / MISC / CPM1.ZIP / CPMEMO.1
Encoding:
Text File  |  1987-04-30  |  2.8 KB  |  79 lines
  1. Clipper Project                                    From: Howard Kapustein
  2. Memo #1: Syntax for contributed UDFs               Date: 4/29/87
  3.  
  4. To: All
  5.  
  6.     This is the format recommended for UDF contributions to the Clipper
  7. Project (CP). For those of you that don't know what CP is, it's a
  8. compilation of information about Clipper by programmers for programmers.
  9. Anyone can contribute, but please make sure contributions give credit
  10. where credit is due. If you write a function or find a bug and would 
  11. like to contribute to CP, merely upload it to The BOSS dBBS (201) 568-7293
  12. and send me a message. Make sure you include your name, address and phone
  13. number (for ease in contacting you if need be) as well as documentation,
  14. source code, and any other files necessary (.dbf, .ntx, etc.) Also,
  15. if your contribution is not written in Clipper (Assembler, C, etc.)
  16. please include an executable version, instructions explaining how to
  17. turn the source code into executable code and any other pertinent
  18. information (what compiler was used, etc.)
  19.     Contributions can be UDFs, bugs, workarounds, tips, procedures
  20. (i.e. light bar menu source code,) stand alone utilities, etc.
  21. The only requirement is that the contribution regard Clipper.
  22.     Remember, include your name, address and phone number with all
  23. contributions so you can receive your due credit.
  24.  
  25.  
  26.  
  27. Format for UDF contributions:
  28.  
  29.     Definitions:  All words preceded by a # should be replaced as follows:
  30.  
  31.         #source:  what language is the source code written in
  32.                   (Assembler, Clipper, C, etc.)
  33.  
  34.        #version: what version of the UDF is this?
  35.  
  36.           #name: the name of the function
  37.  
  38.        #clipver: What version of Clipper is this usable by?
  39.  
  40.                        W: usable only by the Winter'85 Clipper
  41.                        A: usebale only by the Autumn'86 Clipper
  42.                  (blank): no restrictions
  43.  
  44.     #callsyntax: what the calling line would look like
  45.  
  46.     #parameters: TYPE variable description
  47.  
  48.                  where TYPE is one of the following:
  49.  
  50.                     <expC> = character string
  51.                     <expN> = numeric
  52.                     <expL> = logical
  53.                     <expD> = date
  54.  
  55.  
  56. ════════════════════════════════════════════════════════════════
  57. #source #version                    #name() FUNCTION    #clipver
  58. ________________________________________________________________
  59.  
  60.         SYNTAX: #callsyntax
  61.  
  62.     PARAMETERS: #parameters
  63.  
  64.        RETURNS: return value
  65.  
  66.        PURPOSE: explanation
  67.  
  68.          NOTES: warnings, flaws, etc.
  69.  
  70.        EXAMPLE: several examples
  71.  
  72.        CREDITS: author, contributors, etc.
  73.                 include name, address and phone number
  74.  
  75.  
  76.  
  77.  
  78. For some samples, check out the documentation for my library,
  79. HKLIB01.DOC, included in the file HKLIB01.ARC.