Opened 11 years ago

Closed 7 years ago

#13261 closed defect (invalid)

Update SageTeX documentation on use with TeXShop

Reported by: justin Owned by: mvngu
Priority: major Milestone: sage-duplicate/invalid/wontfix
Component: documentation Keywords: TeX, SageTeX
Cc: Merged in:
Authors: Reviewers: Dan Drake
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by justin)

Section 2.3 of the SageTeX documentation ("Using TeXShop") is incomplete. It mentions the "%!TEX" string, but more details are either necessary or potentially helpful.

I have modified sagetex.dtx and attached an updated .spkg.

Attachments (1)

sagetex-2.3.3.p3.spkg (456.4 KB) - added by justin 11 years ago.
New .spkg containing modified sagetex.dtx

Download all attachments as: .zip

Change History (18)

Changed 11 years ago by justin

Attachment: sagetex-2.3.3.p3.spkg added

New .spkg containing modified sagetex.dtx

comment:1 Changed 11 years ago by justin

Description: modified (diff)
Keywords: TeX SageTeX added
Status: newneeds_review
Type: PLEASE CHANGEdefect

comment:2 Changed 11 years ago by iandrus

You should probably report this upstream as well.

comment:3 in reply to:  2 ; Changed 11 years ago by justin

Replying to iandrus:

You should probably report this upstream as well.

Just checked the upstream site, but I don't see a way to report bugs. Am I missing something obvious?

comment:4 in reply to:  3 Changed 11 years ago by ddrake

Replying to justin:

Just checked the upstream site, but I don't see a way to report bugs. Am I missing something obvious?

I don't know "obvious" it is, but I read sage-devel, so mentioning it there is as good as "reporting upstream". :) You can also email me directly.

I can pull a diff out of your spkg. I'll try to get to this later this week.

comment:5 Changed 11 years ago by jdemeyer

Please fill in your real name as Author.

comment:6 Changed 11 years ago by justin

Authors: justinJustin C. Walker

comment:7 Changed 10 years ago by kcrisman

Status: needs_reviewneeds_work

The changes apparently were done in the source itself, not with a patch, there is no SPKG.txt change, Mercurial change, etc., so this needs work. Notwithstanding that I'm sure the change itself is good - I struggled quite a while with exactly this issue a little over a year ago, so it's needed!

comment:8 Changed 10 years ago by kcrisman

Here's the patch from the spkg.

  • src/sagetex.dtx

    diff -Naur sagetex-2.3.3.p3/src/sagetex.dtx sagetex-2.3.3.p2/src/sagetex.dtx
    old new  
    384384%
    385385% Starting with version 2.25,
    386386% \href{http://www.uoregon.edu/~koch/texshop/}{\TeX Shop} includes
    387 % support for \ST. You must move the file |sage.engine| from
     387% support for \ST. If you move the file |sage.engine| from
    388388% |~/Library/TeXShop/Engines/Inactive/Sage| to
    389 % |~/Library/TeXShop/Engines| in order for \TeX Shop to typeset a
    390 % file using \ST. Once the file |sage.engine| is placed in the
    391 % |Engines| directory, \TeX Shop should be restarted so that it recognizes
    392 % the new engine.
    393 
    394 % The engine is invoked in one of two ways.  The first is by selecting
    395 % it in the pulldown menu to the right of the "Typeset" button.  The
    396 % second is by putting the following line
    397      |%!TEX TS-program = sage|
    398 % with the first 12 lines at the beginning of the .tex file in question.
    399 %  Note that, in this line, there must be exactly one space on either
    400 % side of the "=".  Either method assures that \TeX Shop will
    401 % automatically run Sage for you when compiling your document. Note that
    402 % the |"%TEX"| string is only useful when typesetting with \TeX Shop.
     389% |~/Library/TeXShop/Engines| and put the line
     390% \begin{quotation}
     391%   |%!TEX TS-program = sage|
     392% \end{quotation}
     393% at the top of your document, then \TeX Shop will automatically run Sage
     394% for you when compiling your document.
    403395%
    404396% Note that you will need to make sure that \LTX can find |sagetex.sty|
    405 % using any of the methods above. Unless you installed Sage in /Applications,
    406 % you will need to edit the |sage.engine| script to reflect the location of
    407 % your Sage installation.
     397% using any of the methods above. You also might need to edit the
     398% |sage.engine| script to reflect the location of your Sage
     399% installation.
    408400%
    409401% \subsection{Other scripts included with \ST}
    410402% \label{sec:inst-other-scripts}

I wonder whether we should still keep the part about the pulldown menu; it's not in this patch, but why couldn't it be?

comment:9 Changed 9 years ago by jdemeyer

Milestone: sage-5.11sage-5.12

comment:10 Changed 9 years ago by vbraun_spam

Milestone: sage-6.1sage-6.2

comment:11 Changed 9 years ago by vbraun_spam

Milestone: sage-6.2sage-6.3

comment:12 Changed 8 years ago by vbraun_spam

Milestone: sage-6.3sage-6.4

comment:13 Changed 7 years ago by kcrisman

See also #18951, which is probably the same.

comment:14 Changed 7 years ago by ddrake

Strangely, the above patch is in SageTeX. Original commit: https://github.com/dandrake/sagetex/commit/4f59c587; that is current: https://github.com/dandrake/sagetex/blob/master/sagetex.dtx#L381.

I propose this ticket be closed.

comment:15 Changed 7 years ago by kcrisman

Okay, seems reasonable. I'll think more about #18951 - the problem is that a lot of that ticket came from someone experiencing problems that I couldn't verify since I wasn't on site, so it's possible there was some other issue, as you say.

comment:16 Changed 7 years ago by kcrisman

Authors: Justin C. Walker
Milestone: sage-6.4sage-duplicate/invalid/wontfix
Reviewers: Dan Drake
Status: needs_workpositive_review

comment:17 Changed 7 years ago by vbraun

Resolution: invalid
Status: positive_reviewclosed
Note: See TracTickets for help on using tickets.