search

UC-Davis-CS-Tutoring / Study-Guides

Study Guides for various undergraduate CS classes taught at UC Davis
MIT License
0 stars 0 forks source link

TeX Stylistic/Formatting Changes for the 20 Study Guide #8

Closed matthewsot closed 5 years ago

matthewsot commented 5 years ago

I'm proposing the following changes/standardizations to the TeX source for the 20 Study Guide, and if they're agreed upon, might also start a "TeX style" document somewhere to standardize them. These are mostly things that I have found make the source or compiled document easier to read, but I could be wrong or not totally understanding the effect of something, so feel free to correct me or give other opinions!

  1. Remove or replace manual breaks where unnecessary (ex. \par and \), as this is something LaTeX can handle automatically (see https://en.wikibooks.org/wiki/LaTeX/Paragraph_Formatting#Manual_breaks and the \parskip package for extra spacing between paragraphs). Additionally, I find that replacing "Text \ [newline] More text" with "Text [newline] [newline] More text" makes the source significantly more readable.
  2. Replace the \indent'd symbol lists with LaTeX description lists (see https://wiki.contextgarden.net/Description "This is useful for making lists of definitions and other sorts of descriptions"). We might also want to try and find a better formatting for these -- maybe something that aligns the definitions with each other instead of being sort of jagged as they are now. Also some of the ones with equals signs in them look somewhat awkward, ex. "$S = {1,2,3,4} =$ An example of a set in roster form.", where the "=" is referring to the entire equality before it, not just the individual things being compared.
  3. Replacing most of the other lists and definitions and such with custom environments, letting us standardize and change their formatting more simply in the future and making the TeX more readable.
  4. Some math functions like log and lcm should not be in italics

Those are the main three for now, I will add comments as I see other possible edits.

matthewsot commented 5 years ago

Closed as of #10