cgit.sxemacs.org Git - packages/blob - xemacs-packages/xslide/README.TXT

   1 This package contains an Emacs major mode for editing XSL stylesheets.
   2 The current revision is 0.2.2, dated 4 August 2003.
   3
   4 The xslide home page is http://www.menteith.com/xslide/
   5
   6 xslide source code is also available at
   7 http://www.sourceforge.net/projects/xslide/.
   8
   9 The xslide mailing list is xslide-list@lists.sourceforge.net.  See
  10 https://lists.sourceforge.net/lists/listinfo/xslide-list/.
  11
  12 * MANIFEST
  13
  14 File                    Contents
  15
  16 README.TXT              The file you are reading
  17 ChangeLog               Log of changes since xslide 0.2
  18 Makefile                Makefile for byte-compiling
  19 NEWS                    Summary of what's new or changed about xslide
  20 TODO                    List of sample things to do next
  21 dot_emacs               Some things for your .emacs file
  22 xslide.el               Base file for the XSL major mode
  23 xslide-abbrev.el        Abbreviations for XSL mode
  24 xslide-data.el          Data about XSL elements and formatting objects
  25 xslide-font.el          Font lock keywords for XSL stylesheets
  26 xslide-initial.xsl      Default initial stylesheet inserted in empty buffers
  27 xslide-process.el       Procedures for processing XSL stylesheets
  28
  29 Note that make-regexp.el, which was used by earlier version of xslide,
  30 is not required by xslide 0.2 or later.
  31
  32 Note that "xslide" is pronounced as one word, similar to "slide".  It
  33 is not spelled out as "x-s-l-i-d-e".
  34
  35
  36 * FEATURES
  37
  38  - XSL customization group for setting some variables
  39
  40  - Initial stylesheet inserted into empty XSL buffers;
  41
  42  - "Template" menu for jumping to template rules, named templates, key
  43    declarations, and attribute-set declarations in the buffer;
  44
  45  - `xsl-process' function that runs an XSL processor and collects the
  46    output;
  47
  48  - Predefined command line templates and error regexps for Java and
  49    Windows executable versions of both XT and Saxon;
  50
  51  - Font lock highlighting so that the important information stands
  52    out;
  53
  54  - `xsl-complete' function for inserting element and attribute names;
  55
  56  - `xsl-insert-tag' function for inserting matching start- and
  57     end-tags;
  58
  59  - Automatic completion of end-tags;
  60
  61  - Automatic indenting of elements with user-definable indentation
  62    step;
  63
  64  - `xsl-if-to-choose' converts <xsl:if> to <xsl:choose> with
  65    nested <xsl:when>; and
  66
  67  - Comprehensive abbreviations table to further ease typing.
  68
  69 xsl-mode was tested using Emacs 21.2.1 and XEmacs 21.4.
  70
  71
  72 * BUG REPORTS/ENCHANCEMENTS
  73
  74 I would be glad to accept bug reports and, especially, enhancements.
  75 Use `xsl-submit-bug-report' for bug reports.
  76
  77 Bug reports and enhancement requests can also be logged on the
  78 SourceForge site.
  79
  80
  81 * INSTALLATION
  82
  83 1. Unzip the distribution.
  84
  85    This should extract the files listed in the manifest above.
  86
  87    The files have DOS-style line breaks.  You may need to use "unzip
  88    -a" or "gunzip -a" to convert the line ends in the files to your
  89    local convention.
  90
  91 2. Copy the .el files to your emacs site-lisp directory (e.g.,
  92    /usr/local/lib/emacs/site-lisp) or some other directory that is on
  93    your Emacs load path.
  94
  95 3. Byte-compile the .el files, if you want.
  96
  97    If you byte-compiled a previous version of the files, you must
  98    byte-compile the new files (or remove the old .elc files) so that
  99    autoload loads the correct versions.
 100
 101    If there are any byte compiler warning, ignore them.  They probably
 102    can't be avoided with code that is run on multiple Emacs versions
 103    [1].
 104
 105    There are two easy ways to byte-compile the .el files:
 106
 107    a. Byte-compile from within Emacs:
 108
 109       Load xslide.el (M-x load-file RET xslide.el) then byte
 110       compile the .el files using C-0 M-x byte-recompile-directory and
 111       supplying the path name of the directory containing the .el
 112       files.
 113
 114    or
 115
 116    b. Byte-compile using the provided Makefile:
 117
 118       First, review the values of EMACS and SHELL in the Makefile.
 119       Second, run 'make' without arguments to byte-compile the files.
 120
 121 4. Add the elisp code in dot_emacs to your .emacs file.  Uncomment any
 122    portions that you want to also use.
 123
 124 5. Restart Emacs (or, if it's easier for you, evaluate the code that
 125    you just added to your .emacs file).
 126
 127 6. When you visit a file with an extension of .xsl or .fo, xsl-mode
 128    will automatically be loaded.
 129
 130 7. To find out more about xsl-mode, type C-h m from within an XSL
 131    file.
 132
 133 8. To customize xsl-mode font-lock colours, etc., browse the `Xsl'
 134    Customize group after loading xsl-mode.
 135
 136
 137 Notes:
 138 [1] Originally noted by the VM mail reader by Kyle Jones.
 139
 140 -----
 141 $Id: README.TXT,v 1.7 2003/08/04 21:24:09 tonygraham Exp $