Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial pretext conversion #359

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

cfcurtis
Copy link

I've copied over what I can from our version's conversion. Since more work needs to be done before this is ready for deployment, it should probably be merged into a new branch instead of master.

Known issues:

  • pretext/missing_files.txt has a list of the files that did not automatically convert from xml
  • something odd is going on with generated assets, they work for the runestone target but not others (despite having the same directories configured)
  • Front and back matter likely needs cleaning up
  • I haven't actually tested most of the exercises, but they seem to be behaving with spot checks (other than the trace issue related to generated assets)

@oscarlevin
Copy link

I would love to take the next step with converting to Pretext. I think merging, either to main or a new branch would be the next step?

@bnmnetp
Copy link
Member

bnmnetp commented Aug 11, 2023

Since all of the pretext files are in the pretext folder, we can have parallel source trees on master. Here are the challenges that we face that I would like some comment on.

  1. This PR is not a complete conversion. I'm not even sure. if it includes an initial conversion of all chapters? I think so but maybe @cfcurtis can clarify.
  2. I'm also not clear on how much, if any, hand fixing @cfcurtis and company have done on the files in this PR.
  3. @presnick and company have changes they are preparing to PR to the rst source. I don't know how extensive those are or how much trouble it would be to manually apply those changes to the converted PreTeXt.

If no hand fixing has been done, then re-running the converter is not really a problem. However if there has been some manual fixing of converter shortfalls then re-running gets trickier.

The sooner we can answer these questions and get on a path to calling PreTeXt the one true source for this book, the easier it will be.

@presnick
Copy link
Collaborator

presnick commented Aug 11, 2023 via email

@bnmnetp
Copy link
Member

bnmnetp commented Aug 11, 2023

Converting additional materials should not be too bad. You can run the conversion script on individual chapters or pages.

@cfcurtis
Copy link
Author

@bnmnetp It's been a while so I don't remember too much, but I don't think there was a lot of hand fixing. I did create placeholder files for the ones that failed to convert so that the TOC references didn't need to be changed, but not a lot more (maybe some of the pretext configuration stuff was done manually?).

I wouldn't be offended if you wanted to just reject this PR and start with a fresh version, especially after significant RST changes :)

@presnick
Copy link
Collaborator

presnick commented Aug 12, 2023 via email

@bnmnetp
Copy link
Member

bnmnetp commented Aug 13, 2023

Thanks @cfcurtis I just merged a bunch of nice updates from @presnick and @soney.

@oscarlevin I think you should run the conversion from this point, and I'll close this PR. Happy to schedule a mini hackathon to help with the conversion. If that would be useful. Otherwise proceed at your own pace and let me know if you run into problems.

Brad

@oscarlevin
Copy link

@bnmnetp, that sounds good to me. Let me see if I can figure things out, and I'll reach out if I have questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants