modernize repo - Githubissues

Rdeisenroth commented 3 months ago

Hi, as the maintainer of AlgoTeX which builds upon this project, i'd like to contribute some of the features back into upstream, as i will likely no longer be able to maintain AlgoTeX in this capacity after this semester. This PR focuses mainly on general repository improvements rather than LaTeX-features. This PR will feature:

[X] editorconfig
[X] latexindent settings
- These might need improvements, as they mess up a few times
[X] pre-commit config
[X] improved gitignore
[X] default settings for vscode
[x] dockerfile
[ ] ~devcontainer to make working locally easier~
[x] github check action
[x] github docker build action
[ ] ~possibly: action for automated ctan publishing~
[ ] ~possibly: nix flake~

I will finish this PR in the coming weeks.

TeXhackse commented 3 months ago

Hi, first of all thanks.

General thing, I don't have actions in here because of the logo issue. The svg you use is having different sizes… I will give it a try. I use the example-image within the tests.

That's why there is a drone runner building pipelines and this is actually a sparse checkout to that. I know it's weird. I just was a bit afraid the syntax extensions I added to docstrip would confuse people too much. Probably I should add that here as well. I think about it. As the refactoring is almost finished it should be okay.

In any way… you build that on top of main the structure of this repo is changing with the refactoring. I will have a look and probably merge that to existing files in the core repo. But I will try to finish the documentation first, hope that's okay for you. It already takes too long.

General: I am not sure if I should include editor specific things… Maybe you can explain to me why I should.

TeXhackse commented 3 months ago

Concerning nix flake: There is a generic setup for theDependency Printer I already use locally which is to be in the refactoring thing. I prepared a generic nix flake to work with thise dependency files: https://gitlab.com/islandoftex/texmf/depp-nix-flake-example

TeXhackse commented 3 months ago

@Rdeisenroth It's offtopic, but would it be useful if we add a link to your repo in the README/docs? as some kind of related work? Or is it used that kind of group internally that everyone knows how to find it?

You use some of the TUDa-CI internals, which I was not expecting. I just added your project to my refactoring testing pipeline. I will probably add a PR about issues I face there. Just that you are warned.

Rdeisenroth commented 3 months ago

The svg you use is having different sizes…

Ah that's on me, i usually grab it from Wikipedia, which has the exact same dimensions but i thought i'd update it to the official site. You're right, it has different dimensions. I'll change it back to the link i use for AlgoTeX. Providing a docker image and devcontainer with everything setup including the Logo is a huge timesaver, as a full installation of TeXLive on Windows takes around ~40 Minutes and even on linux it is non-trivial to get all the correct dependencies.

But I will try to finish the documentation first, hope that's okay for you. It already takes too long.

Sure, no need to rush. I documented some of the "regular" features in AlgoTeX too, feel free to copy if you find something useful.

General: I am not sure if I should include editor specific things… Maybe you can explain to me why I should.

Are you talking about the .gitignore or the .vscode directory?

For the .gitignore: it doesn't hurt and these are some of the most popular editors.
For the .vscode directory specifically: Opening the project with default settings and the LaTeX-Workshop extension installed, latexindent doesn't correctly detect the config and some of the TeX-Files that use ambiguous extensions (*.def, *.cfg) are not recognized. The idea here is just to make the dev-setup more convenient by suggesting the correct extension and settings. VSCode is by far the most popular editor (which i also personally use ;)) so i think it makes sense to provide reasonable default settings.

Rdeisenroth commented 3 months ago

@Rdeisenroth It's offtopic, but would it be useful if we add a link to your repo in the README/docs? as some kind of related work? Or is it used that kind of group internally that everyone knows how to find it?

Sure, i would like that. This template is currently mostly used by the Tudalgo group, but i'd love to see more people use my project. :D Additionally, i maintain my "Hausübungs-Template", which is also based on TUDa-CI and it will probably be the version i maintain after this semester. (though the code is not as clean, as it was intended for personal use only)

You use some of the TUDa-CI internals, which I was not expecting. I just added your project to my refactoring testing pipeline. I will probably add a PR about issues I face there. Just that you are warned.

Sure

Rdeisenroth commented 3 months ago

Okay, i don't think i will add more features for now.

TeXhackse commented 3 months ago

Okay. I will add a suggestion for the reference in a MR and tag you there. Just that you know.

I am on a conference this week, so not sure how fast I will be with this, but will keep you updated.

Rdeisenroth commented 2 months ago

So i experimented a little with inkscape and managed to extract the logo almost exactly from the corporate design book: Diff at 300 dpi: tuda_logo_diff_300_dpi Diff at 3000 dpi: tuda_logo_diff_3000_dpi

I also converted the dockerfile into a multi stage build, as the inkscape and rsvg-convert versions of debian are too old. Other than increasing the dpi of the inkscape command, i don't think we could possibly get any closer to the original logo with publicly available materials. I realize that this is still just a hacky workaround and not exactly the original logo, but this time we at least have the exact dimensions

tudace / tuda_latex_templates

modernize repo #482