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

Proposal: Pull all macros into a custom documentclass #2256

Closed
godbyk opened this issue Jul 11, 2018 · 4 comments
Closed

Proposal: Pull all macros into a custom documentclass #2256

godbyk opened this issue Jul 11, 2018 · 4 comments

Comments

@godbyk
Copy link
Contributor

godbyk commented Jul 11, 2018

I propose consolidating much of the preamble of std.tex and the contents of the layouts.tex, styles.tex, macros.tex, and tables.tex files (and perhaps a few others) into a new std.cls document class.

This would make it easier for proposals to reuse the same macros and format as the standard and streamline integration of accepted proposals into the standard.

I'm happy to do the work on this if it sounds like a good idea.

Thoughts?

@tkoeppe
Copy link
Contributor

tkoeppe commented Jul 11, 2018

For what it's worth, most proposals are probably easier to process (and live-edit in session) as HTML than in LaTeX, and our Standard LaTeX environment isn't really suited to formatting diffs and edit instructions. Finally, I hate "finished proposals" that are "incorrekt and incomplet"!

@jensmaurer jensmaurer added the decision-required A decision of the editorial group (or the Project Editor) is required. label Jul 16, 2018
@zygoloid
Copy link
Member

zygoloid commented Nov 6, 2018

Baseline assumption:

  • proposals aren't going to be written in .tex; as @tkoeppe points out, it's easier to maintain small proposals in HTML
  • TSes are going to start by forking the standard sources, and don't care whether we use a document class or individual macro and style definitions

So the people who'd be benefitting from this would largely be the people maintaining the draft itself. @godbyk, what advantages are there to us of converting from .tex files to a document class? How does that affect the maintenance of our macros and style rules?

@godbyk
Copy link
Contributor Author

godbyk commented Dec 1, 2018

@zygoloid The primary advantage is just in the organization. All the formatting/style code then lives in a single file instead of being scattered across half a dozen files. It also helps us separate content from presentation.

I did some initial work consolidating the files and code into a std.cls document class. Doing this cleans up the std.tex file considerably. It also pulls out a lot of previously hidden variables and places them up front in std.tex so they're easier to update (e.g., document numbers, editor info).

(Note that the std.cls file is a bit messy right now as I essentially just moved large swaths of code into it. This isn't a final product, just an exploratory experiment.)

@jensmaurer
Copy link
Member

Editorial meeting:

  • Some people have a lot of experience with LaTeX, others have less so.
  • The real work is abstracting away the differences between the IS and the TSes (cover page, title etc)
  • Add instructions to wiki how to add an ISO-conforming cover page (also for TS). But that changes rather often.
  • Clean up std.tex.
  • Total maintenance cost goes up with .cls file; consider the cover sheet. Maintenance in .cls file is much harder due to lots of special formatting.
    -> Thanks for sharing. We say "no" to this.

@jensmaurer jensmaurer removed the decision-required A decision of the editorial group (or the Project Editor) is required. label Sep 10, 2019
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

4 participants