Opened 11 years ago

Closed 11 years ago

Last modified 11 years ago

#9027 closed enhancement (fixed)

Explain Sage and tex interactions in the tutorial

Reported by: rbeezer Owned by: mvngu
Priority: minor Milestone: sage-4.5.2
Component: documentation Keywords: latex
Cc: jhpalmieri, mvngu Merged in: sage-4.5.2.alpha1
Authors: Rob Beezer Reviewers: John Palmieri
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by jhpalmieri)

There are a variety of ways to use latex in Sage, which often leads to some confusion. This new section of the tutorial will present an overview and the basics of usage from a users perspective. However, doctests might also help developers understand how to make changes related to various aspects of tex support.

To the release manager, merge

  • trac_9027_tutorial_latex_v4.patch
  • trac_9027-reviewer.patch

Attachments (7)

trac_9027_tutorial_latex_v1.patch (8.0 KB) - added by rbeezer 11 years ago.
trac_9027_tutorial_latex_v2.patch (20.5 KB) - added by rbeezer 11 years ago.
trac_9027_tutorial_latex_v3.patch (25.0 KB) - added by rbeezer 11 years ago.
trac_9027-reviewer.patch (22.6 KB) - added by jhpalmieri 11 years ago.
apply on top of v3 patch
trac_9074-tkz-graph-latex-v4.patch (134.8 KB) - added by rbeezer 11 years ago.
Stand-alone, apply before reviewer patch
trac_9027_doctesting.patch (4.5 KB) - added by rbeezer 11 years ago.
Apply after reviewer patch
trac_9027_tutorial_latex_v4.patch (24.6 KB) - added by rbeezer 11 years ago.
Stand-alone v4 patch, apply before reviewer patch

Download all attachments as: .zip

Change History (22)

Changed 11 years ago by rbeezer

comment:1 Changed 11 years ago by rbeezer

  • Cc mvngu added
  • Status changed from new to needs_work

Version 1 patch is incomplete, but should build with just a handful of errors, and contains initial sections followed by a rough outline for contents of subsequent section.

Changed 11 years ago by rbeezer

comment:2 Changed 11 years ago by rbeezer

Version 2 patch has about 80% of the content I'd like to add. So general comments about direction or scope are welcome. I'll then be adding the missing sections, filling in doctests, links to methods, etc.

comment:3 follow-up: Changed 11 years ago by jhpalmieri

Hi Rob,

Here are some comments.

  • Overall, it looks good. It seems to cover all of the points I would want it to. I also think it makes sense to include this material in the tutorial.
  • In general, make it more clear just how much of this is automatic? (for example the png conversion discussed at line 237 and nearby)
  • how much do we care about consistency between `\TeX` and tex, `\LaTeX` and latex?

typos:

  • line 7: intensley synergetic --> intensely synergistic
  • line 24: constructiing
  • line 100: Effecting --> Affecting
  • line 173: mathbb? This might be mathbf unless you use a .. link:: directive to link it to the previous examples. same issue on lines 183, 188, etc.
  • line 235: Typset
  • line 240: this class --> This class
  • line 240: wwwhat
  • line 240: To actual see --> To actually see
  • line 262 and following, the sentence starting "So all of these components need". Change to "So you should make sure that up-to-date versions of these are available"
  • line 311: "::math" --> ".. math::"
  • line 318: there is a section in the tutorial on sagetex, so you should refer to that.

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

Replying to jhpalmieri:

Hi John,

Thanks for all the comments, suggestions and fixes. I'm away doing this Sage workshop this week, but expect to get back to this next week sometime.

Rob

Changed 11 years ago by rbeezer

comment:5 Changed 11 years ago by rbeezer

  • Status changed from needs_work to needs_review

Version 3 patch is now ready for review. This takes into account all of John's comments above, but likely introduces a few new typos (though I'd like to think not). Two comments:

  1. graphviz otional spkg is broken (#7438) so I can't learn that right now, a section on that could be added later.
  1. I had a tentative section about using TeX in documentation. I think I might write more for the developer's guide (linking back to this) and I can include the documentation stuff there. So I dropped that.

comment:6 Changed 11 years ago by jhpalmieri

  • Reviewers set to John Palmieri

The most recent patch doesn't apply cleanly, because macros.tex is no longer part of the Sage distribution.

Also, if you do sage -docbuild tutorial html -j to build using jsMath, then jsMath doesn't know about the command \LaTeX, and this causes problems. I also couldn't get `\mbox{\TeX}`{}shop to work right, either. So I'm attaching a reviewer's patch which changes \mbox{\LaTeX} to the plain-text LaTeX, and similarly for TeX. I've also added a few links.

Changed 11 years ago by jhpalmieri

apply on top of v3 patch

comment:7 follow-up: Changed 11 years ago by jhpalmieri

Oh, there were also a few doctest failures: I think the examples don't get run in order, so the latex preamble was not empty when it was supposed to be, for example. My patch fixes those (I think).

comment:8 follow-up: Changed 11 years ago by jhpalmieri

See also #9300. How's your French?

comment:9 in reply to: ↑ 8 Changed 11 years ago by rbeezer

Replying to jhpalmieri:

See also #9300. How's your French?

Possibly passable enough to review, but not good enough to create. ;-)

Thanks for the fixes and changes. I'll look them over soon - busy with out-of-town guests right at the moment.

<joke>
You know the seasons in the Pacific Northwest, don't you?

10 months of rain and two months of visitors. ;-)
</joke>

Changed 11 years ago by rbeezer

Stand-alone, apply before reviewer patch

Changed 11 years ago by rbeezer

Apply after reviewer patch

comment:10 in reply to: ↑ 7 Changed 11 years ago by rbeezer

Replying to jhpalmieri:

v4 patch removes the changes to macros.tex so will now apply cleanly.

reviewer patch looks good to me, so that's a positive review on that.

doctesting patch makes a few more changes to make random-order doctesting work properly. The general strategy is to clean-up on finishing a block (rather than always initializing on starting a block). There are a few report of macros, preamble etc on starting a block, but that is to illustrate, rather than check.

Apply three patches in this order: v4, reviewer, doctesting. This all applies, builds (documentation) and passes tests (in random order!). I'll make a mega-patch once final.

Oh, there were also a few doctest failures: I think the examples don't get run in order, so the latex preamble was not empty when it was supposed to be, for example. My patch fixes those (I think).

comment:11 follow-up: Changed 11 years ago by jhpalmieri

Hi Rob,

It looks like trac_9074-tkz-graph-latex-v4.patch belongs on #9074 instead of here. Can you move it there? Is there a new version of the patch for this ticket?

Changed 11 years ago by rbeezer

Stand-alone v4 patch, apply before reviewer patch

comment:12 in reply to: ↑ 11 Changed 11 years ago by rbeezer

Replying to jhpalmieri:

Hi Rob,

It looks like trac_9074-tkz-graph-latex-v4.patch belongs on #9074 instead of here. Can you move it there? Is there a new version of the patch for this ticket?

Ooh, that's bad. The #9074 patch is already there where it belongs. These two v4 patches were next to each other in my local storage, thus......

The real 9027 v4 patch is here now, sorry for the confusion. I've never been able to delete files. Do I need some extra privileges, or can you trash 9074-v4 for me? Thanks.

Rob

comment:13 follow-up: Changed 11 years ago by jhpalmieri

  • Description modified (diff)
  • Status changed from needs_review to positive_review

Looks good to me.

To the release manager, merge

  • trac_9027_tutorial_latex_v4.patch
  • trac_9027-reviewer.patch

comment:14 in reply to: ↑ 13 Changed 11 years ago by ddrake

  • Merged in set to sage-4.5.2.alpha1
  • Resolution set to fixed
  • Status changed from positive_review to closed

Replying to jhpalmieri:

Looks good to me.

To the release manager, merge

  • trac_9027_tutorial_latex_v4.patch
  • trac_9027-reviewer.patch

Merged in 4.5.2.alpha1.

comment:15 Changed 11 years ago by mpatel

Please see #9607 for a potentially related doctest failure.

Note: See TracTickets for help on using tickets.