search

ryankeleti / ega

amateur translation project of Grothendieck's EGA.
https://ryankeleti.com/ega
321 stars 34 forks source link

Create style guide #141

Closed ryankeleti closed 3 years ago

ryankeleti commented 4 years ago

I think it would be helpful to have a (more or less) definitive TeX/translation style guide. By no means am I suggesting that this guide is the best style (and I want it to be open for modification by everyone), but I think it would be helpful to

  1. Alert contributors to available TeX commands.
  2. Maintain a consistent code style across the project.
  3. Avoid translation inconsistencies.
  4. Remove barrier of entry for new contributors.
  5. Reduce formatting-only commits.

I will get started on one, and please give input into what I should add. I think I will make it a single Markdown file, but am open to using the built in GitHub wiki should the file get too large.

I am also interested in using/making a TeX formatter of sorts, but that comes after the style guide.

federerfanatic commented 4 years ago

Perhaps setting up some kind of dictionary file/database that perhaps also be used to train software to aid in translations?

ryankeleti commented 4 years ago

Style guide started at STYLE.md.

thosgood commented 4 years ago

seems like a great idea. maybe worth mentioning something about line breaks too? I've been opting for line breaks at each new sentence (and also at semicolons in big sentences), because I think that's what we agreed on a while back

(I also didn't realise that we weren't labelling proofs... good to know!)

ryankeleti commented 4 years ago

5e25d41b58395b35267081b18ef9cdf7c334681f line break info added