Commits

Robert Mařík committed 594a041

Added README file.

  • Participants
  • Parent commits 8fea7f1

Comments (0)

Files changed (1)

+###############################################################################
+#   Sage: Open Source Mathematical Software
+#       Copyright (C) 2009-2010 Wilfried Huss <huss@finanz.math.tugraz.at>
+#       Copyright (C) 2009-2010 Robert Marik <marik@mendelu.cz>
+#  Distributed under the terms of the GNU General Public License (GPL),
+#  version 2 or any later version.  The full text of the GPL is available at:
+#                  http://www.gnu.org/licenses/
+###############################################################################
+
+Program sws2tex
+---------------
+
+The program sws2tex converts worksheet written in computer algebra
+system Sage (http://www.sagemath.org) from sws file into a LaTeX file
+and compiles the LaTeX file into nice formatted PDF.
+
+The features include:
+* conversion of font types, colors and faces. Syntax highlight.
+* conversion of tables, hyperlinks and images (including external
+  images, excluding 3D images rendered by jmol plugin)
+* customizing several options (language of the document, author's
+  name, table of contents, ignoring unknown HTML tags, handling hidden
+  input cells) in command line parameters or in a configuration file
+* the sws file is attached to the resulting PDF and hence the
+  worksheet can be restored from the PDF file easily
+
+The script attempts to parse Sage and HTML constructions using
+Python's HTMLParser module.
+
+Installation
+------------
+No special installation is necessary. Simply download the files
+included in sws2tex distribution from
+http://bitbucket.org/whuss/sws2tex/ and put the scripts to your
+desired location.
+
+You may want to customize the file .sws2tex_example, rename to
+.sws2tex and put into your home directory. You need working Sage and
+LaTeX installation. If the worksheet contains links to external
+images, the images are downloaded by using wget utility.
+
+Usage
+-----
+Run the file sws2tex.py to see command line parameters and a list of
+available options and switches.
+
+You may want to use the file conversion.sws to test most of the
+supported features.
+
+
+Reporting bugs
+--------------
+Use the "Issues" capability at http://bitbucket.org/whuss/sws2tex/ or
+report problems to email addresses of the authors.
+
+
+Acknowledgment
+--------------
+The second author (Robert Marik) s supported by the grant 18/2006 of
+the Fund for Development of Czech Universities (FRVS, project "Using
+open source software in teaching mathematics").