sage-mode / SPKG.txt

= sage-mode =

== Description ==

sage-mode provides Emacs Lisp that helps you use Sage in GNU Emacs.
Inspiration was provided by ipython.el originally.

== License ==

Copyright (C) 2007, 2008, 2009, 2010, 2011  Nick Alexander

Author: Nick Alexander <ncalexander [at] gmail.com>

sage-mode is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

sage-mode is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with sage-mode; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.

== SPKG Maintainers ==

 * Ivan Andrus

== Upstream Contact ==

 * Maintainer: Ivan Andrus <darthandrus [at] gmail.com>
 * Bitbucket mercurial repository: [[http://bitbucket.org/gvol/sage-mode]]

== Dependencies ==

 * sage
 * GNU Emacs (with python.el, not python-mode.el) Currently the newest
   python.el (which is a rewrite by fgallina) is not fully supported.


== Special Update/Build Instructions ==

;; Start .emacs


;; After installation of the spkg, you must add something like the
;; following to your .emacs:

(add-to-list 'load-path "$SAGE_DATA/emacs")
(require 'sage "sage")
(setq sage-command "$SAGE_ROOT/sage")

;; If you want sage-view to typeset all your output and have plot()
;; commands inline, uncomment the following line and configure sage-view:
;; (require 'sage-view "sage-view")
;; (add-hook 'sage-startup-after-prompt-hook 'sage-view)
;; You can use commands like
;; (add-hook 'sage-startup-after-prompt-hook 'sage-view-disable-inline-output)
;; (add-hook 'sage-startup-after-prompt-hook 'sage-view-disable-inline-plots)
;; to enable some combination of features.

;; Also consider running (customize-group 'sage) to see more options.

;; End .emacs


== Changelog ==

=== sage-mode-0.7 (Nick Alexander, 2011-10-07) ===
* Fix a bug reported by Ivan Andrus regarding font-lock and
triple-quoted strings.

* sage-mode is now hosted on bitbucket for easy viewing and cloning:
browse to [[http://bitbucket.org/gvol/sage-mode]].

=== sage-mode-0.6 (Nick Alexander, 2009-05-11) ===
* `sage-run' no longer waits for a sage: prompt by default.  This can cause
problems if `sage-startup-after-prompt-hook' is non-trivial, but doesn't lock
up emacs busy waiting for the prompt.

* `sage-send-doctest' now works with multiline tests and one line function
definitions.

* `sage-rerun' now exits from the debugger if it sees the debugger prompt, and
`sage-build' with a prefix argument (build and run sage) should no longer hang.

* `pyrex-mode' is now autoload-ed and the default for pyx, pxi, and pxd files.

* `next-error' now jumps between top-level errors, avoiding lower level source
files.  Lower level source files are still hyperlinked.

* `sage-test' with a prefix argument now offers to test without rebuilding.

* Now `sage-send-doctest' and `sage-send-region' are bound in *Help* buffer.

* `sage-send-{buffer, region doctest}' now either automatically
(`sage-quit-debugger-automatically') or after a prompt quit the debugger
before sending input to the sage slave.

* In the debugger, very short history items are not remembered.  (No more
looping through u/d in the history.)

* *sage-test* buffers now search for test status rather than relying on the
exit codes that incorrectly say tests failed all the time.

* SPKG.txt and spkg-install now print paths in the install instructions.

* C-u RET no longer sends input to the sage slave with output to
*sage-output*.  Use `sage-move-output-to-buffer' instead, or
`comint-write-output' to save to a file.

=== sage-mode-0.5.4 (Nick Alexander, 2009-03-13) ===
* Fixed errors in `sage-build' and `sage-test' autoloads; made sage-mode.el
provide 'sage-mode.

=== sage-mode-0.5.3 (Nick Alexander, 2009-03-12) ===
* Updated `sage-view' to new version.

* Completely reworked keymaps and added preliminary menus.

* Completely reworked customize interface and added autoload interface
through `sage.el' and autogenerated `sage-load.el'.

* Added some documentation and additional customization options.

=== sage-mode-0.5.2 (Nick Alexander, 2009-02-19) ===
* Made individual parts of `sage-view' toggleable, fixed bugs with plots and
multiple outputs.

=== sage-mode-0.5.1 (Nick Alexander, 2009-02-11) ===
* Added `sage-startup-hook' and made `sage-view' actually usable.

=== sage-mode-0.5 (Nick Alexander, 2009-01-31) ===
* Incorporated Matthias Meulien's sage-view.el.  To enable, try sage-view or
  (add-hook 'inferior-sage-mode-hook 'sage-view).

* Added sage-rerun to restart sage and made C-u C-c C-b (sage-build with a
  prefix argument) build and restart sage.

=== sage-mode-0.4 (Nick Alexander, 2008-06-16) ===
I honestly can't remember.

=== sage-mode-0.3 (Nick Alexander, 2008-06-15) ===
Add sage-build command. Make sage-default-test-* more robust, and add
`sage-send-all-doctest-lines-in-file'.

* sage-build.el: new module for building (sage-build) and running
(sage-build with prefix argument) sage.

* sage-test.el (sage-send-all-doctest-lines): new function. Runs all
sage: doctest lines in a file in sequence. Use with pdb to reproduce
errors found only after sage -t.

* sage-test.el (sage-default-test-command,
sage-default-test-new-command): cleaned up to use sage-build.

=== sage-mode-0.2 (Nick Alexander, 2008-06-14) ===
First alpha version, for Mike Hansen to use and test.

=== sage-mode-0.1 (Nick Alexander) ===
First internal version.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.