APEXCalculus / APEXCalculusPTX

In-progress conversion of APEX Calculus to PreTeXt
6 stars 20 forks source link

Edits in Chapters 1-4 #311

Open APEXCalculus opened 2 months ago

APEXCalculus commented 2 months ago

Mostly the edits are the shifts in figures. Other edits are made too, changing some wording in places. (Some key ideas, definitions, asides are edited.)

sean-fitzpatrick commented 2 months ago

I'm having some trouble tracking all of the changes.

(Also, the copied versions had a lot of new, extraneous whitespace that made it hard to compare.)

APEXCalculus commented 2 months ago

Yes, I am sure this pull request is a mess, much of it due to my status as a git noob. I can redo it in a cleaner way if necessary. Problems I foresaw once I committed:

  1. There is too much in this one pull request. I should do one per chapter. Or per section if better.
  2. Yes, apex.ptx is changed and I didn't mean to commit that.
  3. I made changes that I wasn't sure were good, so I commented out old stuff in case we wanted to refer back to the original. I forgot that git handles that kind of issue well; I am too used to doing things on my own.

Is it better if this pull request is cancelled and I:

Sorry for the trouble.

sean-fitzpatrick commented 2 months ago

I can't complain about large pull requests, considering some of the ones I have sent!

Only start over if it's easier for you.

Otherwise, if you can revert the apex.ptx and chapter files, and clean up some of the whitespace, I should be able to work through the rest.

APEXCalculus commented 2 months ago

I didn't officially "revert" apex.ptx and chapter files back to the original, but I did restore them to their original state and re-committed them in commit "fixes apex.ptx and chptrs 1 & 2": (https://github.com/APEXCalculus/APEXCalculusPTX/commit/7be3a907a38f699990e098607f7ef9f32144885e)

I edited sections to remove most content that I commented out in "fixes sections": (https://github.com/APEXCalculus/APEXCalculusPTX/commit/f2add7028f2d90afbf6f2c7cd83c8328c9198a72)

If I need to adopt a more git-official method, let me know.

One of the most confusing forms of edits is where certain figures needed to be moved before/after certain paragraphs so that they appear on the proper page. So if it looks like I deleted figures, it's because of that.

sean-fitzpatrick commented 2 months ago

I added a few other changes to the section on basic derivative rules.

The pagebreak element should probably not go inside a paragraph, etc.

A couple of questions for you about changes to the placement of figures, changes to vshifts, etc.:

  1. When you move a figure, will the new location still make sense if the figure is inline? We only put figures in the margin for PDF output. Probably 95% of students (or more) use the HTML version of the book. Very few are interested in PDF. We get only a handful of orders for print copies every year in our bookstore. So I think it's important not to change anything that compromises the HTML output.
  2. Are you using the verison with or without the QR codes for videos? If the new locations overlap with the QR codes, and there isn't room for me to move the QR codes so they fit, I'll have to do the figure placement all over again.

(I could use versioning for this, and have one set of vshifts for videos, and one for no videos, but it would require duplicating half the figures in the book, so I can put one in the video component, with one vshift, and another in the novideo component, with a different vshift.)

APEXCalculus commented 2 months ago
  1. I wasn't sure where the pagebreak command should go. It seemed to me that this command and the enlargethispage command acted differently; one seemed to work better inside a paragraph and one didn't. But I could be wrong, and I'm fine leaving them both outside of paragraphs.

  2. Ugh, no, I hadn't thought of the inline nature of the graphics. I'll have to go back and look at instances where I moved them. I think I only moved them from one side of a paragraph/thm/def to the other, but I could be wrong. This was only done when there was an automatic pagebreak occurring, and maybe I can work around it by inserting a pagebreak command.

  3. Ugh, no, I wasn't looking at the version with the QR codes. I can restart from Chptr 1 and put the codes in and see how things fit around them.

This is for sure a stress-test of PreTeXt. There are several competing desires for content and its placement. My school may be backward, but few of my students (and colleagues) use the website and most use a printed text, though some prefer the pdf. That's why my focus is always on the printed version.

On Thu, Aug 1, 2024 at 1:03 PM Sean Fitzpatrick @.***> wrote:

I added a few other changes to the section on basic derivative rules.

The pagebreak element should probably not go inside a paragraph, etc.

A couple of questions for you about changes to the placement of figures, changes to vshifts, etc.:

  1. When you move a figure, will the new location still make sense if the figure is inline? We only put figures in the margin for PDF output. Probably 95% of students (or more) use the HTML version of the book. Very few are interested in PDF. We get only a handful of orders for print copies every year in our bookstore. So I think it's important not to change anything that compromises the HTML output.
  2. Are you using the verison with or without the QR codes for videos? If the new locations overlap with the QR codes, and there isn't room for me to move the QR codes so they fit, I'll have to do the figure placement all over again.

(I could use versioning for this, and have one set of vshifts for videos, and one for no videos, but it would require duplicating half the figures in the book, so I can put one in the video component, with one vshift, and another in the novideo component, with a different vshift.)

— Reply to this email directly, view it on GitHub https://github.com/APEXCalculus/APEXCalculusPTX/pull/311#issuecomment-2263540808, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABT5OF2N7SPR47PVYQASEALZPJS4PAVCNFSM6AAAAABLYV5S5CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENRTGU2DAOBQHA . You are receiving this because you authored the thread.Message ID: @.***>

sean-fitzpatrick commented 2 months ago

I think a page break should go between paragraphs, the same as it does in LaTeX.

If the enlarge page command works better elsewhere, that's ok. (In LaTeX I don't think I've ever put it in without line breaks on either side of it.)

Have your students been given the option of the online version of the book? I can understand preferring a hard copy, but I'd be surprised if anyone chose electronic PDF over HTML.

I think people in some places are being pushed to move to HTML to comply with accessibility requirements. But you also get nice perks like interactive features. (The built in search works really well, too.)

sean-fitzpatrick commented 1 month ago

I've just figured out that you're not intentionally adding most of the whitespace changes. Your text editor is set to use tabs for indentation, and your tabs are equivalent to 8 spaces.

Can you change your settings to use 2 spaces for indentation instead of a tab? If you make that change and save your files, it should fix most of the whitespace problems, I think.

If you are using VSCode, use Ctrl+Shift+p to bring up the command pallette. Type 'indent' into the box. You'll see one line that says "Indent using spaces", which will let you change the setting going forward. (There is also a place you can click on the bottom-right panel to do this.) Another line will say "Convert tabs to spaces". This will make sure there are no tab characters.

sean-fitzpatrick commented 1 month ago

I made a few changes that were easy to make myself. An earlier comment explains how to fix the whitespace. There are a few inline comments for things that need your attention.

Other than that, I think this is OK, pending confirmation that the changes are compatible with the HTML output and including video QR codes.

APEXCalculus commented 1 month ago

I fixed my tab / 2 spaces issue -- I think. We'll see how it looks going forward.

Alex-Jordan commented 1 month ago

About the font/smallcaps/init issue. If there is nothing better to do for PTX at large at this time, you could use the custom XSL that this project already has to change how an init is translated. And just not use small caps.

sean-fitzpatrick commented 1 month ago

I think I will override the default (which seems questionable, IMO -- I've never seen something like PDF in small caps).

I got the Latte font working on my computer, but I don't want our PDF build to depend on installing some font from source from an 8 year old software repo. Probably Greg doesn't want that, either.