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:  sageduplicate/invalid/wontfix 
Component:  documentation  Keywords:  TeX, SageTeX 
Cc:  Merged in:  
Authors:  Reviewers:  Dan Drake  
Report Upstream:  N/A  Work issues:  
Branch:  Commit:  
Dependencies:  Stopgaps: 
Description (last modified by )
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)
Change History (18)
Changed 11 years ago by
Attachment:  sagetex2.3.3.p3.spkg added 

comment:1 Changed 11 years ago by
Description:  modified (diff) 

Keywords:  TeX SageTeX added 
Status:  new → needs_review 
Type:  PLEASE CHANGE → defect 
comment:3 followup: 4 Changed 11 years ago by
comment:4 Changed 11 years ago by
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 sagedevel, 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:6 Changed 11 years ago by
Authors:  justin → Justin C. Walker 

comment:7 Changed 10 years ago by
Status:  needs_review → needs_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
Here's the patch from the spkg.

src/sagetex.dtx
diff Naur sagetex2.3.3.p3/src/sagetex.dtx sagetex2.3.3.p2/src/sagetex.dtx
old new 384 384 % 385 385 % Starting with version 2.25, 386 386 % \href{http://www.uoregon.edu/~koch/texshop/}{\TeX Shop} includes 387 % support for \ST. You mustmove the file sage.engine from387 % support for \ST. If you move the file sage.engine from 388 388 % ~/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 TSprogram = 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 TSprogram = 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. 403 395 % 404 396 % 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 of407 % your Sageinstallation.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. 408 400 % 409 401 % \subsection{Other scripts included with \ST} 410 402 % \label{sec:instotherscripts}
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
Milestone:  sage5.11 → sage5.12 

comment:10 Changed 9 years ago by
Milestone:  sage6.1 → sage6.2 

comment:11 Changed 9 years ago by
Milestone:  sage6.2 → sage6.3 

comment:12 Changed 8 years ago by
Milestone:  sage6.3 → sage6.4 

comment:14 Changed 7 years ago by
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
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
Authors:  Justin C. Walker 

Milestone:  sage6.4 → sageduplicate/invalid/wontfix 
Reviewers:  → Dan Drake 
Status:  needs_work → positive_review 
comment:17 Changed 7 years ago by
Resolution:  → invalid 

Status:  positive_review → closed 
New .spkg containing modified sagetex.dtx