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

Math macros/guidelines #13

Open
uschwes opened this issue Jan 20, 2015 · 7 comments
Open

Math macros/guidelines #13

uschwes opened this issue Jan 20, 2015 · 7 comments

Comments

@uschwes
Copy link

uschwes commented Jan 20, 2015

Do we have math macros and guidelines somewhere?

@pfankhauser
Copy link
Contributor

I assume you talk about the LaTeX template for the report. There's some math definitions in the ASL preamble but that's all. Feel free to add whatever is needed.

@uschwes
Copy link
Author

uschwes commented Jan 22, 2015

Yes, I mean the latex reports. Do you know whether we have written down a styleguide for math notation somewhere? Like vectors small/bold and so on...
Do you think it would make sense to add macros for students so it's clear from the very beginning how we want equations to look like?

@pfankhauser
Copy link
Contributor

The report follows the notation as defined in isomath (examples). So as long \vec and \mat are correctly used, there should be little confusion. We also given an example in the template under "2.6 Mathematische Formeln".

Do you think there's something that should be defined additionally? Feel free to add anything that might help.

@pfankhauser
Copy link
Contributor

@uschwes do you think this is sufficiently covered? If so, I will close this issue.

@uschwes
Copy link
Author

uschwes commented Mar 10, 2015

Should we put a link to the isomath example into our math section to stress that we want to follow that convention?
It might be overlooked easily.

@pfankhauser
Copy link
Contributor

Sorry for not following up, feel free to add a link or any more information.

@uschwes
Copy link
Author

uschwes commented Aug 4, 2016

Haha, me too :-)
I hope I can make a proposal at some point how to help students avoid common mistakes.
This might include a section on negative examples and the usage of e.g. siunitx, acro,...
Maybe we can converge on some minimum set of guidelines.

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

2 participants