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

Add sections as single files #30

Closed
webmiche opened this issue Nov 3, 2022 · 7 comments · Fixed by #33
Closed

Add sections as single files #30

webmiche opened this issue Nov 3, 2022 · 7 comments · Fixed by #33

Comments

@webmiche
Copy link
Contributor

webmiche commented Nov 3, 2022

In this template, we basically write all the text in the paper.tex file. This has the downside that one has to skim through a lot of text when wanting to find a particular section to work on.

In my thesis template, I had a folder Chapters that contained single files for each section (i.e. 01-intro.tex, 06-conclusion.tex), which all were imported into the equivalent of paper.tex in this template. Not sure how you feel about it, but to me, this structure is easier to work on.

Tagging some people to get their opinions: @tobiasgrosser @bollu @math-fehr @Superty @Dinistro

@Dinistro
Copy link
Contributor

Dinistro commented Nov 4, 2022

I know that other groups do exactly that, but I'm not sure if there are some issues with this approach.

@Superty
Copy link
Contributor

Superty commented Nov 4, 2022

I am definitely in favour of putting the content of the paper into a different file from all the boilerplate. Personally I prefer to keep all sections in one file though, mostly because I'm used to it and I can jump to section as easily as jumping to file in my editor. Also sometimes I want to make a nice transition from one section to another which is slightly easier when viewing both in the same file. But I suppose it's easy enough to decide this per-project!

@tobiasgrosser
Copy link
Collaborator

tobiasgrosser commented Nov 12, 2022

I would agree that it might make sense to put the boilerplate into a separate file. With respect to factoring out subsections into separate files, that is a subjective choice. I personally like to keep everything in a single file, as I typically navigate by searching to the term that I am interested in. That works best for me if everything is in a single file. I know that @goens likes to have multiple files and other groups indeed split papers up. I guess you do not use use search to navigate to a section or have an editor that supports folding?

@tobiasgrosser
Copy link
Collaborator

I am happy to arrange a brainstorming how we can improve this template given that the deadline is now over.

@tobiasgrosser
Copy link
Collaborator

I moved some of the builerplate into separate .tex files. See #33. Does that seem like a step into the right direction?

@math-fehr
Copy link
Contributor

To me, this makes a lot of sense!
I prefer having the boilerplate extracted from the main file, rather than having a single file for each section.
Having a single file for each section makes it harder to quickly move in the code!

@webmiche
Copy link
Contributor Author

That's certainly a step in the right direction. As the consensus seems to be that most people prefer one file for the entire text, I guess we can leave this as is after merging #33. I agree that adding files for each section can be done on a per-project basis, if anyone prefers that.

@webmiche webmiche linked a pull request Nov 23, 2022 that will close this issue
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

Successfully merging a pull request may close this issue.

5 participants