2.6 Logging of SAGE sessions

Module: sage.misc.log

TODO: Pressing "control-D" can mess up the I/O sequence because of a known bug.

You can create a log of your SAGE session as a web page and/or as a latex document. Just type log_html() to create an HTML log, or log_dvi() to create a dvi (latex) log. Your complete session so far up until when you type the above command will be logged, along with any future input. Thus you can view the log system as a way to print or view your entire session so far, along with a way to see nicely typeset incremental updates as you work.

If L=log_dvi() or L=log_html() is a logger, you can type L.stop() and L.start() to stop and start logging.

The environment variables BROWSER and DVI_VIEWER determine which web browser or dvi viewer is used to display your running log.

For both log systems you must have a tex system installed on your computer. For HTML logging, you must have the convert command, which comes with the free ImageMagick tools.

Note: The HTML output is done via Latex and png images right now, sort of like how latex2html works. Obviously it would be interesting to do something using MathML in the long run.

Author Log:

Module-level Functions

update( )

Class: Log

class Log
This is the base logger class. The two classes that you actually instantiate are derived from this one.
Log( self, [dir=None], [debug=False], [viewer=None])

Functions: dir,$  $ start,$  $ stop

dir( self)

Return the directory that contains the log files.

start( self)

Start the logger. To stop use the stop function.

stop( self)

Stop the logger. To restart use the start function.

Special Functions: __repr__,$  $ _input_log_name,$  $ _latex_,$  $ _plain_text,$  $ _update,$  $ _update_plain,$  $ _write

Class: log_dvi

class log_dvi
Create a running log of your SAGE session as a nicely typeset dvi file.

Easy usage: \code{log_dvi()}

TODO: Pressing "control-D" can mess up the I/O sequence because of a known bug.

Use L=log_dvi([optional directory]) to create a dvi log. Your complete session so far up until when you type the above command will be logged, along with any future input. Thus you can view the log system as a way to print or view your entire session so far, along with a way to see nicely typeset incremental updates as you work.

If L is a logger, you can type L.stop() and L.start() to stop and start logging.

The environment variable DVI_VIEWER determines which web browser or dvi viewer is used to display your running log.

You must have a latex system installed on your computer and a dvi viewer.

Functions: view

Special Functions: __repr__,$  $ _build,$  $ _filename,$  $ _footer,$  $ _get_input,$  $ _get_output,$  $ _header,$  $ _init,$  $ _title

Class: log_html

class log_html
Create a running log of your SAGE session as a web page.

Easy usage: \code{log_html()}

TODO: Pressing "control-D" can mess up the I/O sequence because of a known bug.

Use L=log_html([optional directory]) to create an HTML log. Your complete session so far up until when you type the above command will be logged, along with any future input. Thus you can view the log system as a way to print or view your entire session so far, along with a way to see nicely typeset incremental updates as you work.

If L is a logger, you can type L.stop() and L.start() to stop and start logging.

The environment variable WEB_BROWSER determines which web browser or dvi viewer is used to display your running log.

You must have a tex system installed on your computer, and you must have the convert command, which comes with the free ImageMagick tools.

Functions: view

Special Functions: __repr__,$  $ _build,$  $ _filename,$  $ _footer,$  $ _get_input,$  $ _get_output,$  $ _header,$  $ _init,$  $ _title

Class: log_html_mathml

class log_html_mathml
Create a running log of your SAGE session as a mathml web page.

Easy usage: \code{log_html_mathml()}

TODO: Pressing "control-D" can mess up the I/O sequence because of a known bug.

Functions: view

Special Functions: __repr__,$  $ _build,$  $ _filename,$  $ _init

See About this document... for information on suggesting changes.