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

Technical note on software lacks LaTeX source #149

Open
graeme-a-stewart opened this issue Aug 28, 2023 · 3 comments
Open

Technical note on software lacks LaTeX source #149

graeme-a-stewart opened this issue Aug 28, 2023 · 3 comments
Assignees

Comments

@graeme-a-stewart
Copy link
Member

The published version of the technical note on software project best practices is evidently generated from a LaTeX version of the document. However, all that is in GitHub is the original Markdown.

Can either of @hegner or @drbenmorgan remember how we did this change or where the LaTeX is?

I would propose that after accepting the recent change in #148 we just convert the master document to LaTeX (with pandoc) and consider the MD obsolete.

What do you think?

@hegner
Copy link
Member

hegner commented Aug 28, 2023

Thanks Graeme!
I approved your change. The diff'ing of Github was a bit confused by the newlines and reformatting. I hope I caught all your changes.
Why cannot we keep the current document and explain which pandoc command to use?

@graeme-a-stewart
Copy link
Member Author

The problem is that pandoc provides an incomplete LaTeX file (the first line is \section). It's like a snippet that you need to then insert into another LaTeX file. That seems like quite a faff, so instead of maintaining two files (the boilerplate and the markdown), it looked easier to just bite the bullet and say we have a LaTeX document as the master.

@hegner
Copy link
Member

hegner commented Aug 30, 2023

I see. Does this help?
https://github.com/HSF/documents/blob/master/HSF-TN/templates/pandoc_example.md

Maybe I should make that more explicit in the README

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

No branches or pull requests

3 participants