SageTeX / sagetexpackage.dtx

Diff from to

sagetexpackage.dtx

 %<latex>\ProvidesPackage{sagetex}
 %<python>__version__ = """
 %<*latex|python>
-  [2009/07/27 v2.2.3 embedding Sage into LaTeX documents]
+  [2009/12/30 v2.2.3 embedding Sage into LaTeX documents]
 %</latex|python>
 %<python>"""
 %<*driver>
 % filename, including it into your document, and so on. In
 % \autoref{sec:usage}, we will see what what we can do with \ST.
 %
-%
 % \section{Installation}
 % \label{sec:installation}
 % \changes{v2.0}{2009/01/14}{Fixed up installation section, final
 %
 % \newcommand{\sageroot}{\$SAGE\_ROOT}
 %
-% new installation section FIXME FIXME FIXME
-% 
-% \ST needs two parts to work: a Python module known to Sage, and a
-% \LTX package known to \TeX. As of Sage version 4.3.1, \ST comes
-% included with Sage, so you only need to make sagetex.sty, the \LTX
-% package, known to \TeX. Full details of this are in the Sage
-% Installation guide at http://sagemath.org/doc/installation/ in the
-% obviously-named section ``Make \ST known to \TeX''. Here's a brief
-% summary of how to do that:
+% \ST needs two parts to work: a Python module known to Sage, and a \LTX
+% package known to \TeX. These two parts need to come from the same
+% version of \ST to guarantee that everything works properly. As of Sage
+% version 4.3.1, \ST comes included with Sage, so you only need to make
+% \texttt{sagetex.sty}, the \LTX package, known to \TeX. Full details of
+% this are in the Sage Installation guide at
+% \href{http://sagemath.org/doc/installation/}{\texttt{sagemath.org/doc/installation/}}
+% in the obviously-named section ``Make \ST known to \TeX''. Here's a
+% brief summary of how to do that:
 %
 % \begin{itemize}
+% \item Copy \texttt{sagetex.sty} to the same directory as your
+%   document. This always works, but requires lots of copies of
+%   \texttt{sagetex.sty} and is prone to version skew.
 %
-% \item Copy sagetex.sty to the same directory as your document. This
-% always works, but requires lots of copies off sagetex.sty and is prone
-% to version skew.
+% \item Use the environment variable \texttt{TEXINPUTS} to tell \TeX{}
+%   to search the directory containing \texttt{sagetex.sty}; in the bash
+%   shell, you can do
+%   \begin{quotation}
+%     \texttt{export TEXINPUTS=\sageroot/local/share/texmf//:}
+%   \end{quotation}
+%   You should replace \texttt{\sageroot} with the location of your Sage
+%   installation.
 %
-% \item Set the environment variable TEXINPUTS to
-% ``\sageroot/local/share/texmf//:'', where \sageroot refers to the
-% location of your Sage install.
-%
-% \item Copy the above directory to your home directory with a command
-% like ``cp -R \sageroot/local/share/texmf ~/''. 
-%
+% \item Copy the directory containing \texttt{sagetex.sty} to your home
+%   directory with a command like
+%   \begin{quotation}
+%     \texttt{cp -R \sageroot/local/share/texmf \textasciitilde/}
+%   \end{quotation}
+%   where again you replace \texttt{\sageroot} with the location of your
+%   Sage installation.
 % \end{itemize}
 %
-% I prefer using TEXINPUTS, as it guarantees that both Sage and \TeX are
-% using synchronized code.
+% I prefer using \texttt{TEXINPUTS}, as it guarantees that both Sage and
+% \TeX{} are synchronized and doesn't require you to copy any files.
+%
+% Note that along with \texttt{sagetex.sty}, this documentation, an
+% example file, and other useful scripts are all located in the
+% directory \texttt{\sageroot/local/share/texmf}.
 %
 % \subsection{\ST and \TeX Live}
 %
 % the \LTX package from \TeX Live and the Python module from Sage, they
 % may not work together if they are from different versions of \ST.
 % Because of this, I strongly recommend using \ST only from what is
-% included with Sage and ignoring what's included with \TeX Live. 
+% included with Sage and ignoring what's included with \TeX Live.
 %
 % \subsection{Using \TeX Shop}
 % \label{sec:using-texshop}
 % at the top of your document, then \TeX Shop will automatically run Sage
 % for you when compiling your document.
 %
-% Note that you will need to make |sagetex.sty| and |sagetex.py| known
-% to \LTX and Sage using any of the methods described above (although
-% note that \TeX Shop includes copies of these files for you). You also
-% might need to edit the |sage.engine| script to reflect the location of
-% your Sage installation.
+% Note that you will need to make sure that \LTX can find |sagetex.sty|
+% using any of the methods above. You also might need to edit the
+% |sage.engine| script to reflect the location of your Sage
+% installation.
 %
 % \subsection{Other scripts included with \ST}
 % \label{sec:inst-other-scripts}
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.