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

Document .dtx vs. .cls #108

Open
koppor opened this issue Jul 10, 2023 · 3 comments
Open

Document .dtx vs. .cls #108

koppor opened this issue Jul 10, 2023 · 3 comments
Milestone

Comments

@koppor
Copy link
Member

koppor commented Jul 10, 2023

This template uses the .dtx procedure to generate the files such as lni.cls. PRs, however, touch the files directly (e.g., #104). In case such a PR is merged, the template distribution process undoes the changes.

Example:

-  \vskip -27pt% Abstand vor dem Titel
+  \vskip -24pt% Abstand vor dem Titel

We should document explain how the whole system works (https://tex.stackexchange.com/q/344530/9075; https://www.texdev.net/tags/#dtx), put make it optional to contributors. After a PR, the maintainers have to adapt the .dtx.

Alternatively, we could remove the generated files from the .dtx. This, however, would make the whole package inconsistent with "typical" .dtx usage.

CC @csware

@sieversMartin
Copy link
Member

If we stick to the dtx-approach, this should be the file to be edited. The CONTRIBUTING.md should clearly state this IMHO.
Maybe we could then establish a workflow/check for a pull request, which tests for changes in the dtx file, calls latex lni.ins and then merges the files. Is that even possible @koppor?

@koppor
Copy link
Member Author

koppor commented Nov 7, 2023

Sure, we can do a merge.

And then manually "backporting" to .dtx?

@sieversMartin
Copy link
Member

Well, no. I thought of getting contributors to only modify the dtx file :-)

@koppor koppor added this to the v1.9 milestone Nov 8, 2023
@sieversMartin sieversMartin modified the milestones: v1.9, v2.0 Jul 23, 2024
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

2 participants