home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / packages / dmacro-2.0 / README < prev    next >
Encoding:
Text File  |  1991-11-15  |  3.7 KB  |  95 lines
  1. Name:        Dynamcic Macro
  2. Version:     2.0
  3. Released:    November 1991
  4. Description: A program for creating structured text in Emacs.
  5. Author:      Wayne Mesard, WMesard@Oracle.com
  6.  
  7. WHAT IT IS:
  8. ----------
  9. Dynamic Macro ("DM") is a facility for inserting structured text in
  10. Emacs.  In addition to straight textual substitution (already available
  11. through Emacs' Abbrev mode) DM will insert time- and date-stamps, your
  12. name and user-id, the current file name, a file's contents, the results
  13. of a shell command and anything else you can think of.  It can prompt
  14. the user for strings.  It can also position the cursor within the
  15. expanded text, and indent the expansion in whatever way is appropriate
  16. to the current major mode.  DM will also allow you to bind dmacros to
  17. keys and automatically insert dmacros in new files.
  18.  
  19. A development team can use a common dmacro table with standardized
  20. comment block and code dmacros as a way of enforcing a coding standard.
  21.  
  22. You can insert blocks of text like these:
  23.  
  24.    -------------------------------     -------------------------------
  25.    NAME                                for (var = 0; var < p; ++var)
  26.      myfile.c                          {
  27.    NOTES                                 m
  28.                                        } /* for */
  29.    HISTORY
  30.      WMesard - 12/24/91: Created.
  31.    -------------------------------     -------------------------------
  32.    where the user, file and date       where "p" and "m" indicate the position
  33.    info are automatically filled       of the point and mark, and "var" is
  34.    in at insertion time.               supplied by the user at insertion time.
  35.  
  36.  
  37. RELEASE NOTES:
  38. --------------
  39. There are many new features in this release, including:
  40.    o Dmacro Builder - an interactive program for defining dmacros.  
  41.    o insert-dmacro command - the main interface to DM (bound to C-c d).
  42.    o Wrapping commands - wrap a dmacro around the current line or region.
  43.    o A user's manual.
  44.    o Loads of new functions and functionality for use in dmacros.
  45.  
  46. If you have a copy of Template 2.0beta, you should replace it with this
  47. version.  There have been several enhancements and bug fixes.
  48.  
  49.  
  50. CONTENTS:
  51. --------
  52. This distribution package contains the following:
  53.    README             This file
  54.    dmacro.el          The Dmacro program
  55.    dmacro-bld.el      A tool for creating new dmacros interactively
  56.    dm-c.el            Some useful dmacros for C programmers
  57.    dm-elisp.el          Some useless dmacros for Emacs Lisp programmers
  58.    dm-compat.el       Some code to make Template v1.5 files work (more or
  59.                          less) with Dmacro v2.0
  60.    dmacro.texinfo     User's manual in TexInfo format
  61.  
  62.  
  63. DOCUMENTATION:
  64. -------------
  65. The user's manual can be printed (using the "TeX" text formatter) or
  66. read on-line (in Emacs' "Info" document browser).  For information about
  67. printing the manual, type the following in Emacs:
  68.  
  69. >>    <Control-h> i d m texinfo <Return> printing hardcopy <Return>
  70.  
  71. For information about creating and installing an on-line Info file type:
  72.  
  73. >>    <Control-h> i d m texinfo <Return> creating <Return>
  74.  
  75. to learn about the command texinfo-format-buffer.  After reading that type:
  76.  
  77. >>    m installing <Return>
  78.  
  79. See your SysAdmin or local Emacs wizard if you get stuck.
  80.  
  81.  
  82. LIBRARY OF DMACROS
  83. ------------------
  84. I have been asked by several people to solicit macros from others and
  85. include them in future distributions.  If you build any cool dynamic macros
  86. that you want to share with the world, please send them to me via email.
  87. Especailly in demand are macros for C, C++, LaTeX, Emacs Lisp and SQL.
  88.  
  89.  
  90. SUPPORT
  91. -------
  92. Questions, problems, suggestions should be sent to me at
  93. WMesard@Oracle.com.  Bug reports and enhancement requests are always
  94. welcome.  Be sure to mention the version of Dmacro that you're using.
  95.