diff options
Diffstat (limited to 'templates')
| -rw-r--r-- | templates/latex/.envrc | 9 | ||||
| -rw-r--r-- | templates/latex/.gitignore | 8 | ||||
| -rw-r--r-- | templates/latex/.licensure.yml | 155 | ||||
| -rw-r--r-- | templates/latex/LICENSE | 171 | ||||
| -rw-r--r-- | templates/latex/LICENSE.spdx | 7 | ||||
| -rw-r--r-- | templates/latex/README.md | 10 | ||||
| -rwxr-xr-x | templates/latex/build.sh | 15 | ||||
| -rw-r--r-- | templates/latex/cog.toml | 24 | ||||
| -rw-r--r-- | templates/latex/content/static/title.tex | 14 | ||||
| -rw-r--r-- | templates/latex/flake.lock | 210 | ||||
| -rw-r--r-- | templates/latex/flake.nix | 126 | ||||
| -rw-r--r-- | templates/latex/headers/preamble.tex | 291 | ||||
| -rw-r--r-- | templates/latex/headers/preamble_local.tex | 0 | ||||
| -rw-r--r-- | templates/latex/lpm.toml | 19 | ||||
| -rw-r--r-- | templates/latex/main.tex | 44 | ||||
| -rw-r--r-- | templates/latex/references/reference.bib | 0 | ||||
| -rwxr-xr-x | templates/latex/scripts/extract_text_from_all.sh | 7 | ||||
| l--------- | templates/latex/scripts/renew_copyright_header.sh | 1 | ||||
| l--------- | templates/latex/treefmt.nix | 1 | ||||
| -rwxr-xr-x | templates/latex/update.sh | 3 |
20 files changed, 1115 insertions, 0 deletions
diff --git a/templates/latex/.envrc b/templates/latex/.envrc new file mode 100644 index 0000000..3bc1085 --- /dev/null +++ b/templates/latex/.envrc @@ -0,0 +1,9 @@ +use flake || use nix +watch_file flake.nix + +PATH_add ./scripts + +if on_git_branch; then + echo && git status --short --branch && + echo && git fetch --verbose +fi diff --git a/templates/latex/.gitignore b/templates/latex/.gitignore new file mode 100644 index 0000000..539b891 --- /dev/null +++ b/templates/latex/.gitignore @@ -0,0 +1,8 @@ +# build +/result +/build + +/resources.local + +# dev env +.direnv diff --git a/templates/latex/.licensure.yml b/templates/latex/.licensure.yml new file mode 100644 index 0000000..551ddfc --- /dev/null +++ b/templates/latex/.licensure.yml @@ -0,0 +1,155 @@ +--- +# Regexes which if matched by a file path will always be excluded from +# getting a license header +excludes: + - .*lock + - \.git/.* + - LICENSE.spdx + - COPYING + - COPYING.LESSER + - .*\.(rst|txt|pdf) +# Definition of the licenses used on this project and to what files +# they should apply. +# +# No default license configuration is provided. This section must be +# configured by the user. +licenses: + # Either a regex or the string "any" to determine to what files this + # license should apply. It is common for projects to have files + # under multiple licenses or with multiple copyright holders. This + # provides the ability to automatically license files correctly + # based on their file paths. + # + # If "any" is provided all files will match this license. + - files: any + # + # The license identifier, a list of common identifiers can be + # found at: https://spdx.org/licenses/ but existence of the ident + # in this list it is not enforced unless auto_template is set to + # true. + ident: CC-BY-SA-4.0 + # + # A list of authors who hold copyright over these files + authors: + # Provide either your full name or company name for copyright purposes + - name: Benedikt Peetz + # Optionally provide email for copyright purposes + email: "benedikt.peetz@b-peetz.de" + + # The template that will be rendered to generate the header before + # comment characters are applied. Available variables are: + # - [year]: substituted with the current year. + # - [name of author]: Substituted with name of the author and email + # if provided. If email is provided the output appears as Full + # Name <email@example.com>. If multiple authors are provided the + # list is concatenated together with commas. + template: | + <TODO> 2024 - [year] (C) by [name of author] + SPDX-License-Identifier: CC-BY-SA-4.0 + + <TODO> is licensed under a + Creative Commons Attribution-ShareAlike 4.0 International License. + + You should have received a copy of the license along with this + work. If not, see <https://creativecommons.org/licenses/by-sa/4.0/>. + + + # If auto_template is true then template is ignored and the SPDX + # API will be queried with the ident value to automatically + # determine the license header template. auto_template works best + # with licenses that have a standardLicenseHeader field defined in + # their license info JSON, if it is not then we will use the full + # licenseText to generate the header which works fine for short + # licenses like MIT but can be quite lengthy for other licenses + # like BSD-4-Clause. The above default template is valid for most + # licenses and is recommended for MIT, and BSD licenses. Common + # licenses that work well with the auto_template feature are GPL + # variants, and the Apache 2.0 license. + # + # Important Note: this means the ident must be a valid SPDX identifier + # auto_template: true + + # If true try to detect the text wrapping of the template, and unwrap it + unwrap_text: false + +# Define type of comment characters to apply based on file extensions. +comments: + # The extensions (or singular extension) field defines which file + # extensions to apply the commenter to. + - extensions: + - js + - go + # The commenter field defines the kind of commenter to + # generate. There are two types of commenters: line and block. + # + # This demonstrates a line commenter configuration. A line + # commenter type will apply the comment_char to the beginning of + # each line in the license header. It will then apply a number of + # empty newlines to the end of the header equal to trailing_lines. + # + # If trailing_lines is omitted it is assumed to be 0. + commenter: + type: line + comment_char: "//" + trailing_lines: 1 + + - extensions: + - rs + - tri + - css + - cpp + - c + - h + # This demonstrates a block commenter configuration. A block + # commenter type will add start_block_char as the first character + # in the license header and add end_block_char as the last character + # in the license header. If per_line_char is provided each line of + # the header between the block start and end characters will be + # line commented with the per_line_char + # + # trailing_lines works the same for both block and line commenter + # types + commenter: + type: block + start_block_char: "/*\n" + end_block_char: "*/\n" + per_line_char: "*" + trailing_lines: 1 + + - extension: + - html + - md + commenter: + type: block + start_block_char: "<!--\n" + end_block_char: "-->\n" + trailing_lines: 1 + + - extensions: + - el + - lisp + commenter: + type: line + comment_char: ";;;" + trailing_lines: 1 + + - extensions: + - tex + commenter: + type: line + comment_char: "%" + trailing_lines: 1 + + # The extension string "any" is special and so will match any file + # extensions. Commenter configurations are always checked in the + # order they are defined, so if any is used it should be the last + # commenter configuration or else it will override all others. + # + # In this configuration if we can't match the file extension we fall + # back to the popular '#' line comment used in most scripting + # languages. + - extension: any + commenter: + type: line + comment_char: '#' + trailing_lines: 1 diff --git a/templates/latex/LICENSE b/templates/latex/LICENSE new file mode 100644 index 0000000..dbb2b35 --- /dev/null +++ b/templates/latex/LICENSE @@ -0,0 +1,171 @@ +Creative Commons Attribution-ShareAlike 4.0 International + + Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. + +Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors. + +Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. + +Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public. + +Creative Commons Attribution-ShareAlike 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. + +Section 1 – Definitions. + + a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + + e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. + + i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights under this Public License. + + k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + + 4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. + + 5. Downstream recipients. + + A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. + + B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply. + + C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. + + 6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this Public License. + + 3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified form), You must: + + A. retain the following if it is supplied by the Licensor with the Licensed Material: + + i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + + v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + + B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and + + C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. + + 3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. + + b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply. + + 1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; + + b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and + + c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + + a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. + + b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. + + c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + + a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + + c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. + + d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. + +Section 8 – Interpretation. + + a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. + + c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. + + d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. + diff --git a/templates/latex/LICENSE.spdx b/templates/latex/LICENSE.spdx new file mode 100644 index 0000000..20d2ea0 --- /dev/null +++ b/templates/latex/LICENSE.spdx @@ -0,0 +1,7 @@ +SPDXVersion: SPDX-2.3 +DataLicense: CC0-1.0 +Creator: TODO +PackageName: TODO +PackageOriginator: TODO +PackageHomePage: TODO +PackageLicenseDeclared: CC-BY-SA-4.0 diff --git a/templates/latex/README.md b/templates/latex/README.md new file mode 100644 index 0000000..466604a --- /dev/null +++ b/templates/latex/README.md @@ -0,0 +1,10 @@ +# TODO + +Some text about the project. + +## Licence +This document is licensed under a +Creative Commons Attribution-ShareAlike 4.0 International License. + +You should have received a copy of the license along with this +work. If not, see <https://creativecommons.org/licenses/by-sa/4.0/>. diff --git a/templates/latex/build.sh b/templates/latex/build.sh new file mode 100755 index 0000000..1932138 --- /dev/null +++ b/templates/latex/build.sh @@ -0,0 +1,15 @@ +#!/usr/bin/env sh + +# if no parameter is given, use 'dst' as destination directory +if [ -z "$1" ]; then + dst=build +else + dst="$1" +fi + +# find all directories which are not the destination dir or inside it +find . -type d -not -name "$dst" -not -path "./$dst/*" -printf '%P\n' | while IFS= read -r dir +do + mkdir --parents "$dst/$dir" +done +latexmk -outdir="$dst" -file-line-error -pdflatex -recorder ./main.tex diff --git a/templates/latex/cog.toml b/templates/latex/cog.toml new file mode 100644 index 0000000..500ed32 --- /dev/null +++ b/templates/latex/cog.toml @@ -0,0 +1,24 @@ +tag_prefix = "v" +branch_whitelist = ["main", "prime"] +ignore_merge_commits = false + +pre_bump_hooks = [ + "nix flake check", # verify the project builds + "./scripts/renew_copyright_header.sh", # update the license header in each file + "flake_version_update --version v{{version}} --input-file flake.nix", # update the version in the flake.nix file + "nix fmt", # format +] +post_bump_hooks = [ + "git push", + "git push origin v{{version}}", # push the new tag to origin +] + +[bump_profiles] + +[changelog] +path = "NEWS.md" +template = "remote" +remote = "TODO" +repository = "TODO" +owner = "TODO" +authors = [{ signature = "Benedikt Peetz", username = "bpeetz" }] diff --git a/templates/latex/content/static/title.tex b/templates/latex/content/static/title.tex new file mode 100644 index 0000000..e4a833d --- /dev/null +++ b/templates/latex/content/static/title.tex @@ -0,0 +1,14 @@ +% LTeX: language=en-GB + +\maketitle + +\tableofcontents +\vspace*{\fill} +\makeatletter +Copyright \textcopyright{} \@authors{} \@years{}\\ +\ \\ +This work is licensed under the terms of the CC BY-SA 4.0 licence. +The licence text can be found online at \url{http://creativecommons.org/licenses/by-sa/4.0/legalcode}. +\ +\makeatother +\clearpage diff --git a/templates/latex/flake.lock b/templates/latex/flake.lock new file mode 100644 index 0000000..e095a79 --- /dev/null +++ b/templates/latex/flake.lock @@ -0,0 +1,210 @@ +{ + "nodes": { + "crane": { + "inputs": { + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1711681752, + "narHash": "sha256-LEg6/dmEFxx6Ygti5DO9MOhGNpyB7zdxdWtzv/FCTXk=", + "owner": "ipetkov", + "repo": "crane", + "rev": "ada0fb4dcce4561acb1eb17c59b7306d9d4a95f3", + "type": "github" + }, + "original": { + "owner": "ipetkov", + "repo": "crane", + "type": "github" + } + }, + "flake-compat": { + "flake": false, + "locked": { + "lastModified": 1696426674, + "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=", + "owner": "edolstra", + "repo": "flake-compat", + "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, + "flake-utils": { + "inputs": { + "systems": [ + "systems" + ] + }, + "locked": { + "lastModified": 1710146030, + "narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "flake_version_update": { + "inputs": { + "flake-utils": [ + "flake-utils" + ], + "nixpkgs": [ + "nixpkgs" + ], + "systems": [ + "systems" + ] + }, + "locked": { + "lastModified": 1685288691, + "narHash": "sha256-oP6h34oJ8rm6KlUpyZrX+ww3hnoWny2ecrEXxkU7F3c=", + "ref": "refs/heads/prime", + "rev": "e9a97e01eca780bd16e1dbdbd8856b59558f4959", + "revCount": 5, + "type": "git", + "url": "https://codeberg.org/soispha/flake_version_update.git" + }, + "original": { + "type": "git", + "url": "https://codeberg.org/soispha/flake_version_update.git" + } + }, + "lpm": { + "inputs": { + "crane": [ + "crane" + ], + "flake-compat": [ + "flake-compat" + ], + "flake-utils": [ + "flake-utils" + ], + "nixpkgs": [ + "nixpkgs" + ], + "rust-overlay": [ + "rust-overlay" + ], + "systems": [ + "systems" + ] + }, + "locked": { + "lastModified": 1711915832, + "narHash": "sha256-5vFraJ2xnDvuEI2zeUbre8amzVDLAneODNNdJb6HSZk=", + "ref": "refs/heads/prime", + "rev": "67f3079cd49deb116ba215244e7a1a1575a71ede", + "revCount": 10, + "type": "git", + "url": "https://codeberg.org/Soispha/lpm.git" + }, + "original": { + "type": "git", + "url": "https://codeberg.org/Soispha/lpm.git" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1711715736, + "narHash": "sha256-9slQ609YqT9bT/MNX9+5k5jltL9zgpn36DpFB7TkttM=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "807c549feabce7eddbf259dbdcec9e0600a0660d", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixpkgs-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "crane": "crane", + "flake-compat": "flake-compat", + "flake-utils": "flake-utils", + "flake_version_update": "flake_version_update", + "lpm": "lpm", + "nixpkgs": "nixpkgs", + "rust-overlay": "rust-overlay", + "systems": "systems", + "treefmt-nix": "treefmt-nix" + } + }, + "rust-overlay": { + "inputs": { + "flake-utils": [ + "flake-utils" + ], + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1711851236, + "narHash": "sha256-EJ03x3N9ihhonAttkaCrqxb0djDq3URCuDpmVPbNZhA=", + "owner": "oxalica", + "repo": "rust-overlay", + "rev": "f258266af947599e8069df1c2e933189270f143a", + "type": "github" + }, + "original": { + "owner": "oxalica", + "repo": "rust-overlay", + "type": "github" + } + }, + "systems": { + "locked": { + "lastModified": 1680978846, + "narHash": "sha256-Gtqg8b/v49BFDpDetjclCYXm8mAnTrUzR0JnE2nv5aw=", + "owner": "nix-systems", + "repo": "x86_64-linux", + "rev": "2ecfcac5e15790ba6ce360ceccddb15ad16d08a8", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "x86_64-linux", + "type": "github" + } + }, + "treefmt-nix": { + "inputs": { + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1711803027, + "narHash": "sha256-Qic3OvsVLpetchzaIe2hJqgliWXACq2Oee6mBXa/IZQ=", + "owner": "numtide", + "repo": "treefmt-nix", + "rev": "1810d51a015c1730f2fe05a255258649799df416", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "treefmt-nix", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/templates/latex/flake.nix b/templates/latex/flake.nix new file mode 100644 index 0000000..ca4edeb --- /dev/null +++ b/templates/latex/flake.nix @@ -0,0 +1,126 @@ +{ + description = "TODO"; + + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; + + treefmt-nix = { + url = "github:numtide/treefmt-nix"; + inputs = { + nixpkgs.follows = "nixpkgs"; + }; + }; + flake_version_update = { + url = "git+https://codeberg.org/soispha/flake_version_update.git"; + inputs = { + systems.follows = "systems"; + nixpkgs.follows = "nixpkgs"; + flake-utils.follows = "flake-utils"; + }; + }; + lpm = { + url = "git+https://codeberg.org/Soispha/lpm.git"; + inputs = { + nixpkgs.follows = "nixpkgs"; + flake-compat.follows = "flake-compat"; + flake-utils.follows = "flake-utils"; + rust-overlay.follows = "rust-overlay"; + crane.follows = "crane"; + systems.follows = "systems"; + }; + }; + + # inputs for following + systems = { + url = "github:nix-systems/x86_64-linux"; # only evaluate for this system + }; + flake-compat = { + url = "github:edolstra/flake-compat"; + flake = false; + }; + flake-utils = { + url = "github:numtide/flake-utils"; + inputs = { + systems.follows = "systems"; + }; + }; + crane = { + url = "github:ipetkov/crane"; + inputs = { + nixpkgs.follows = "nixpkgs"; + }; + }; + rust-overlay = { + url = "github:oxalica/rust-overlay"; + inputs = { + nixpkgs.follows = "nixpkgs"; + flake-utils.follows = "flake-utils"; + }; + }; + }; + + outputs = { + self, + nixpkgs, + flake-utils, + treefmt-nix, + lpm, + flake_version_update, + ... + }: + flake-utils.lib.eachDefaultSystem (system: let + pkgs = nixpkgs.legacyPackages.${system}; + + # This version is set automatically on `cog bump --auto`; + version = "v1.0.0"; # GUIDING VERSION STRING + + # TODO reduce to the needed ones + texlive = pkgs.texlive.combined.scheme-full; + + treefmtEval = import ./treefmt.nix {inherit treefmt-nix pkgs;}; + + build = pkgs.stdenv.mkDerivation { + pname = "TODO"; + inherit version; + src = ./.; + + buildInputs = [ + texlive + ]; + + # Run local + preferLocalBuild = true; + allowSubstitutes = false; + + buildPhase = '' + # TODO: I have no idea, why calling it with `./build.sh` does not work <2024-03-20> + bash ./build.sh + ''; + + installPhase = '' + install -D ./build/main.pdf $out/TODO; + ''; + }; + in { + packages.default = build; + + checks = { + inherit build; + formatting = treefmtEval.config.build.check self; + }; + + formatter = treefmtEval.config.build.wrapper; + + devShells.default = pkgs.mkShell { + packages = with pkgs; [ + cocogitto + licensure + flake_version_update.packages."${system}".default + lpm.packages."${system}".default + texlive + + zathura + ]; + }; + }); +} diff --git a/templates/latex/headers/preamble.tex b/templates/latex/headers/preamble.tex new file mode 100644 index 0000000..bc8aa8a --- /dev/null +++ b/templates/latex/headers/preamble.tex @@ -0,0 +1,291 @@ +% This preamble assumes pdflatex +% derived from: +% https://github.com/gillescastel/lecture-notes/blob/929672a96abc27eaeb6fa58b1d277b3582d28532/group-theory/preamble.tex +% encodings +\usepackage[utf8]{inputenc} % use utf8 encoding +\usepackage[T1]{fontenc} % for 8bit font support +\usepackage{lmodern} % latin modern fonts, should be better than ae, aecompl +% \usepackage{ae,aecompl} % full T1 font support +% \usepackage{textcomp} % support for yen and so on, not needed since latex2e(2020) + +% references +\usepackage[british]{babel} % For English language support, with reformed orthography! +% \usepackage[brithish]{babel} % For English language support, with reformed orthography! +\usepackage{csquotes} % required by biblatex +% \usepackage{biber} % required by biblatex + +% \usepackage{biblatex-dw} +\usepackage[backend=biber, + style=footnote-dw, + % + pageref=true, + annotation=true, + library=true, + % + % style=numeric, + autocite=superscript, + % FIXME: Keep this here? <2024-03-20> + doi=true, + isbn=true, + loccittracker=true, + opcittracker=true + ]{biblatex} % For bibtex references +\addbibresource{resources/reference.bib} +% \renewcommand{\autocite}[1]{\footcite{#1}\supercite{#1}} +% \bibliography{res/reference} % Set the location of the references + +% dates, time +\usepackage[de-DE, showdow]{datetime2} % make handling dates easier + +% index +% \usepackage{index} % Helps to create an index TODO compare with other such packages +% \makeindex + +% math +\usepackage{amsmath} % extensive math commands +\usepackage{amsfonts} % more fonts for math (fracture, boldfaced and so on) +\usepackage{mathtools} % extension to amsmath, with more sensible defaults (eq numbers only when referenced) +\usepackage{amssymb} % more symbols, mostly redundant because already loaded by something else +\usepackage{mathrsfs} % support for the RSFS fonts (through \mathscr command) +\usepackage{cancel} % allows to cancel a part in math mode, for example to shorten a term +\usepackage{bm} % bold mode in math, but better than \boldsymbol command from ams. \bm +\usepackage[locale = DE]{siunitx} % For easy unit representation +\sisetup{per-mode = fraction} +\usepackage[version=4]{mhchem} % for \ce command + + + +% graphics and floats +\usepackage{float} % makes dealing with floats easier +\usepackage{graphicx} % allows for easy inclusion of graphics +\usepackage[shortlabels]{enumitem} % makes enumerate, itemize and description better +\usepackage{wrapfig} % Wraps text around figures with the \wrapfigure environment +\usepackage[dvipsnames]{xcolor} % colors and color mixing \color{red!30!green!40!blue} +\usepackage{pgfplots} % plots, 2D and 3D +\pgfplotsset{compat=1.18} % use version 1.13 +\usepackage{tikz} % Nice drawn graphics, for library see: https://tex.stackexchange.com/a/42664 +% \usetikzlibrary{intersections, angles, quotes, calc, positioning} +% \usetikzlibrary{arrows.meta} %TODO maybe deprecated? +% \usepackage{tikz-cd} % better commutative diagrams +% \usepackage{subcaption} % like caption package, but for subfigures +% \usepackage{booktabs} % better tables + + +% visuals +\usepackage{fancyhdr} % Text layout and margins, headers so on +\usepackage{microtype} % makes text better to read +\usepackage{multicol} % allows for multi-columns everywhere, with the "multicols" environment +\usepackage{emptypage} % no page numbers and headings on empty pages +% \usepackage[a4paper, left=2cm, right=2cm, top=2cm, bottom=2cm]{geometry} % For nice margins +% \usepackage{xspace} % Adds a space when it thinks it is necessary +\usepackage{blindtext} % blindtext + +% tikz style config +\tikzset{help_lines/.style={step=.5cm,gray!50,very thin}} + +% notes +% \usepackage{todonotes} + +% links +% \usepackage[hidelinks]{hyperref} % Links in the pdf +\usepackage[nospace]{varioref} +\usepackage[pdflang=de-DE]{hyperref} +% \hypersetup{ +% colorlinks, +% linkcolor={black}, +% citecolor={black}, +% urlcolor={blue!80!black} +% } + + +% \usepackage{stmaryrd} % for \lightning +% \newcommand\contra{\scalebox{1.1}{$\lightning$}} + +% number sets +\newcommand\N{\ensuremath{\mathbb{N}}} +\newcommand\R{\ensuremath{\mathbb{R}}} +\newcommand\Z{\ensuremath{\mathbb{Z}}} +\newcommand\Q{\ensuremath{\mathbb{Q}}} +\newcommand\C{\ensuremath{\mathbb{C}}} +\renewcommand\O{\ensuremath{\emptyset}} % replaces the Ø + +% readable limits +\let\svlim\lim{} +\renewcommand\lim{\svlim\limits} + +% aliases +\let\implies\Rightarrow{} +\let\impliedby\Leftarrow{} +\let\iff\Leftrightarrow{} + +\renewcommand\epsilon{\varepsilon} % I like the textual epsilon more +% \renewcommand\phi{\varphi} + +% horizontal rule +\newcommand\hr{ + \par\noindent\rule[0.5ex]{\linewidth}{0.5pt} + } + +% copyright: +\makeatletter +\DeclareRobustCommand\authors[1]{\gdef\@authors{#1}} +\DeclareRobustCommand\years[1]{\gdef\@years{#1}} +\makeatother + +% theorems +% packages: +\usepackage[framemethod=TikZ]{mdframed} +\mdfsetup{skipabove=1em,skipbelow=0em, innertopmargin=5pt, innerbottommargin=6pt} +\usepackage{amsthm} % math commands for theorems +\usepackage{thmtools} % improved theorems +\usepackage{environ} % for hiding of the solution env + +% styles: +% \renewcommand\qedsymbol{\ensuremath{\text{\textit{O.}}~\epsilon.~\delta.}} +\renewcommand\qedsymbol{\dots} +\theoremstyle{definition} +\declaretheoremstyle[ + headfont=\bfseries\sffamily\color{NavyBlue!80}, + bodyfont=\normalfont, + headpunct={:\\}, + qed=\qedsymbol, + mdframed={ + linewidth=2pt, + rightline=false, topline=false, bottomline=false, + linecolor=NavyBlue, backgroundcolor=NavyBlue!5, + }, + ]{thmexample} +\declaretheoremstyle[ + headfont=\bfseries\sffamily\color{RawSienna!80}, + bodyfont=\normalfont, + headpunct={:\\}, + qed=\qedsymbol, + mdframed={ + linewidth=2pt, + rightline=false, topline=false, bottomline=false, + linecolor=RawSienna, backgroundcolor=RawSienna!5, + }, + ]{thmexercise} +\declaretheoremstyle[ + headfont=\bfseries\sffamily\color{Violet!80}, + bodyfont=\normalfont, + headpunct={:\\}, + notebraces={f\"ur }{}, + qed=\qedsymbol, + mdframed={ + linewidth=2pt, + rightline=false, topline=false, bottomline=false, + linecolor=Violet, backgroundcolor=Violet!5, + }, + ]{thmsolution} +\declaretheoremstyle[ + headfont=\bfseries\sffamily\color{ForestGreen!80}, + bodyfont=\normalfont, + headpunct={:\\}, + qed=\qedsymbol, + mdframed={ + linewidth=2pt, + rightline=false, topline=false, bottomline=false, + linecolor=ForestGreen, backgroundcolor=ForestGreen!5, + }, + ]{thmdef} +\declaretheoremstyle[ + headfont=\bfseries\sffamily\color{RawSienna!70!black}, + bodyfont=\normalfont, + headpunct={:\\}, + qed=\qedsymbol, + mdframed={ + linewidth=2pt, + leftline=false, rightline=true, topline=false, bottomline=false, + linecolor=RawSienna, backgroundcolor=Red!5, + } + ]{thmtheorem} + +\declaretheorem[numbered=yes, style=thmdef, name=Definition]{definition} +\declaretheorem[numbered=no, style=thmexample,name=Beispiel]{eg} +\declaretheorem[numbered=no, style=thmexercise, name=Aufgabe]{ex} +\declaretheorem[numbered=yes, style=thmtheorem, name=Satz]{theorem} +% \declaretheorem[style=thmredbox, name=Proposition]{prop} +% \declaretheorem[style=thmredbox, name=Lemma]{lemma} +% \declaretheorem[style=thmredbox, numbered=no, name=Corollary]{corollary} + +% Solutions +\makeatletter +\@ifclasswith{report}{nosolutions} + {% + \NewEnviron{solution}[1][]{Eine L\"osung mit dem Name ("L\"osung für #1") wurde versteckt.\ \\ \par} + \newcommand\hdsolution[1]{L\"osung versteckt} + }{% + \declaretheorem[numbered=no, style=thmsolution, name=L\"osung]{replacementSolution} + + \NewEnviron{solution}[1][]{ + \vspace{-1em} + \begin{replacementSolution}[#1] + \ + \BODY + \end{replacementSolution} + } + \newcommand\hdsolution[1]{#1} + } +\makeatother + +\DTMnewdatestyle{margindate}{ + \renewcommand*\DTMdisplaydate[4]{ + \MakeLowercase{\DTMshortweekdayname{##4}}\space + \number##3\relax\space + \MakeLowercase{\DTMshortmonthname{##2}}\space + \DTMtwodigits{\DTMtwodigits{##1}} + } + \renewcommand*\DTMDisplaydate[4]{ + \DTMshortweekdayname{##4}\space + ##3\space + \DTMshortmonthname{##2}\space + \DTMtwodigits{\DTMtwodigits{##1}} + } + } + +\newcommand*\margindate[1]{ + \DTMsetdatestyle{margindate} + \marginpar{ + \small\textsf{\mbox{\DTMDate{#1}}} + }\relax + } + +\def\@lesson{}% +\newcommand{\lesson}[3]{ + \if\relax\detokenize{#3}\relax + \def\@lesson{Unterricht: #1}% + \else + % \def\@lesson{Unterricht #1: #3}% + \def\@lesson{#1: #3}% + \fi + \subsection*{\@lesson} + \margindate{#2} + } + +% \pagestyle{fancy} +% \fancyhf{} +% \fancyhead[LE, RO]{} +% \fancyhead[RO, LE]{\@lesson} +% \fancyhead[RE, LO]{} +% \fancyfoot[LE, RO]{\thepage} +% \fancyfoot[C]{\leftmark} + + +% Parameters +% \renewcommand{\sfdefault}{ptm} +% \pagenumbering{arabic} +% \setcounter{page}{2} +% \renewcommand{\thesection}{\Roman{section}} +% \renewcommand{\thesubsection}{\thesection.\Roman{subsection}} +% + +%% Footers and Headers +%\pagestyle{fancy} +%\fancyhf{} +%\renewcommand{\headrulewidth}{2pt} +%\renewcommand{\footrulewidth}{1pt} +%\renewcommand{\baselinestretch}{1.5} +%\fancyhead[L]{{\textbf{\titleset}}} +%\fancyhead[R]{\textbf{\course}} +%\fancyfoot[L]{\thepage} diff --git a/templates/latex/headers/preamble_local.tex b/templates/latex/headers/preamble_local.tex new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/templates/latex/headers/preamble_local.tex diff --git a/templates/latex/lpm.toml b/templates/latex/lpm.toml new file mode 100644 index 0000000..5a3565d --- /dev/null +++ b/templates/latex/lpm.toml @@ -0,0 +1,19 @@ +[last_chapter] +user_name = "static" +number = 0 + +[templates] +section = ''' +%! TEX root = ../../../main.tex +% LTeX: language=en-GB + +\section{REPLACMENT_SECTION_TITLE} % DATE +This is some text +''' + +chapter = ''' +%! TEX root = ../../main.tex +% LTeX: language=en-GB + +\chapter{REPLACEMENT_CHAPTER} +''' diff --git a/templates/latex/main.tex b/templates/latex/main.tex new file mode 100644 index 0000000..591e600 --- /dev/null +++ b/templates/latex/main.tex @@ -0,0 +1,44 @@ +% LTeX: language=en-GB +%\documentclass[a4paper, 12pt, nosolutions]{report} +% \documentclass[a4paper, 12pt, onecolumn]{report} +\documentclass[a4paper, 12pt, twocolumn]{scrartcl} + +\input{headers/preamble.tex} +\input{headers/preamble_local.tex} + +\title{\textbf{TODO}} +\author{Benedikt Peetz \\ +\href{mailto:benedikt.peetz@b-peetz.de}{benedikt.peetz@b-peetz.de}\\[1cm] +{\small Supervisor: TODO}} +\date{\DTMToday} + +% For the copyright section +\years{2024} +\authors{Benedikt Peetz} + +\makeatletter +\hypersetup{ + pdftitle={\@title}, + pdfsubject={}, + pdfauthor={\@authors}, + pdfkeywords={TODO}, + colorlinks, + linkcolor={black}, + citecolor={black}, + urlcolor={blue!80!black} +} +\makeatother + + +\includeonly{} + +\begin{document} + \onecolumn + \input{content/static/title} + \twocolumn + + % NEXT_CHAPTER + + \clearpage{} + \printbibliography\relax +\end{document} diff --git a/templates/latex/references/reference.bib b/templates/latex/references/reference.bib new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/templates/latex/references/reference.bib diff --git a/templates/latex/scripts/extract_text_from_all.sh b/templates/latex/scripts/extract_text_from_all.sh new file mode 100755 index 0000000..dd8818f --- /dev/null +++ b/templates/latex/scripts/extract_text_from_all.sh @@ -0,0 +1,7 @@ +#! /usr/bin/env sh + +grep 'INPUT ./' ./build/main.fls | uniq | sed 's/INPUT //' | while read -r file; do + if ! [ "$(basename "$file")" = preamble.tex ] && ! [ "$(basename "$file")" = gymnasium.png ]; then + printf "\n%% Filename: %s\n" "$file"; grep -v '^\s*%' "$file"; + fi; + done diff --git a/templates/latex/scripts/renew_copyright_header.sh b/templates/latex/scripts/renew_copyright_header.sh new file mode 120000 index 0000000..f286da9 --- /dev/null +++ b/templates/latex/scripts/renew_copyright_header.sh @@ -0,0 +1 @@ +../../../common/renew_copyright_header.sh \ No newline at end of file diff --git a/templates/latex/treefmt.nix b/templates/latex/treefmt.nix new file mode 120000 index 0000000..6a4fe7d --- /dev/null +++ b/templates/latex/treefmt.nix @@ -0,0 +1 @@ +../../treefmt.nix \ No newline at end of file diff --git a/templates/latex/update.sh b/templates/latex/update.sh new file mode 100755 index 0000000..49216b8 --- /dev/null +++ b/templates/latex/update.sh @@ -0,0 +1,3 @@ +#!/usr/bin/env sh + +nix flake update |