typographix-polytechnique-reports:0.1.6 (typst#1479)

Author: remigerme

packages/preview/typographix-polytechnique-reports/0.1.6/.gitignore

@@ -0,0 +1,7 @@
+*.pdf
+!guide.pdf
+
+.vscode
+
+# For macOS users
+.DS_Store

packages/preview/typographix-polytechnique-reports/0.1.6/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to the package or template
+
+You can simply fork this repo and work on it on your own. Feel free to PR if this repo is still active !
+
+If you plan to distribute your version of the package, please make sure you pay respect to both [Typst packages guidelines](https://github.com/typst/packages?tab=readme-ov-file#submission-guidelines) and [École polytechnique corporate identity](https://www.polytechnique.edu/presse/kit-media).
+
+## Pushing to Typst packages
+
+Check out [Typst packages repo](https://github.com/typst/packages) to learn more about packages release pipeline.
+
+I personally suggest the following steps :
+
+- fork the Typst packages repo
+- in the root directory, for every `x.y.z` version (if the `main` branch currently contains the `x.y.z` release) :
+
+    ```bash
+    git subtree add --prefix=packages/preview/typographix-polytechnique-reports/x.y.z [email protected]:remigerme/typst-polytechnique.git main
+    ```
+
+    You may need to pull sometimes (if the release wasn't fully ready) :
+
+    ```bash
+    git subtree pull --prefix=packages/preview/typographix-polytechnique-reports/x.y.z [email protected]:remigerme/typst-polytechnique.git main
+    ```
+
+- PR your fork to publish the package.
+
+You do not need to squash the commit history at anytime because Typst packages will do it on merge.

packages/preview/typographix-polytechnique-reports/0.1.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Rémi Germe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/preview/typographix-polytechnique-reports/0.1.6/README.md

@@ -0,0 +1,35 @@
+# Typst Polytechnique package
+
+A Typst package for Polytechnique student reports.
+
+For a short introduction to Typst features and detailled information about the package, check the [guide](https://github.com/remigerme/typst-polytechnique/blob/main/guide.pdf) (available from the repo only).
+
+## Usage
+
+If you want to use it on local, make sure you have the font "New Computer Modern Sans" installed.
+
+Define variables at the top of the template :
+
+```typc
+#let title = "Rapport de stage en entreprise sur plusieurs lignes automatiquement"
+#let subtitle = "Un sous-titre pour expliquer ce titre"
+#let logo = image("path/to/my-logo.png")
+#let logo-horizontal = true
+#let short-title = "Rapport de stage"
+#let authors = ("Rémi Germe")
+#let date-start = datetime(year: 2024, month: 06, day: 05)
+#let date-end = datetime(year: 2024, month: 09, day: 05)
+#let despair-mode = false
+
+#set text(lang: "fr")
+```
+
+These variables will be used for PDF metadata, default cover page and default header.
+
+## Contributing
+
+Contributions are welcomed ! See [contribution guidelines](CONTRIBUTING.md).
+
+## Todo
+
+- [ ] heading not at the end of a page : might be tricky

packages/preview/typographix-polytechnique-reports/0.1.6/assets/README.md

@@ -0,0 +1,20 @@
+# Assets
+
+## Licensing
+
+Use the assets accordingly with [École polytechnique corporate identity](https://www.polytechnique.edu/en/press-room).
+
+## Generation
+
+Typst currently only supports `svg` integration. I generated `svg` assets using inkscape to convert `eps` files to `svg`, and remplaced colors to use colors from École polytechnique corporate identity.
+
+```bash
+for f in *.eps; do inkscape --export-type=svg $f; done
+sed -i 's/2e6886/00677f/' filet-court.svg
+sed -i 's/a62125/ce0037/' filet-long.svg
+sed -i 's/dae0e5/ccd8df/' armes.svg
+sed -i 's/0d355c/01426a/' logo-x.svg
+sed -i 's/1e3f6a/01426a/' logo-x-ip-paris.svg
+```
+
+Note : macOS users need to add an empty string `''` after `-i` flag : `sed -i '' 's/.../.../' file.svg'` or install `gnu-sed` and use it instead of macOS provided `sed`.

packages/preview/typographix-polytechnique-reports/0.1.6/assets/armes.svg

@@ -0,0 +1,14 @@
+@article{example-turing,
+    author = {TURING, A. M.},
+    title = "{I.—COMPUTING MACHINERY AND INTELLIGENCE}",
+    journal = {Mind},
+    volume = {LIX},
+    number = {236},
+    pages = {433-460},
+    year = {1950},
+    month = {10},
+    issn = {0026-4423},
+    doi = {10.1093/mind/LIX.236.433},
+    url = {https://doi.org/10.1093/mind/LIX.236.433},
+    eprint = {https://academic.oup.com/mind/article-pdf/LIX/236/433/30123314/lix-236-433.pdf},
+}

packages/preview/typographix-polytechnique-reports/0.1.6/assets/example.bib

@@ -0,0 +1,108 @@
+/***********************/
+/* TEMPLATE DEFINITION */
+/***********************/
+
+/* HANDLING DATE DISPLAY */
+
+#let translate_month(month) = {
+  // Construction mapping for months
+  let t = (:)
+  let fr-month-s = ("Janv.", "Févr.", "Mars", "Avr.", "Mai", "Juin",
+    "Juill.", "Août", "Sept.", "Oct.", "Nov.", "Déc.")
+  let fr-months-l = ("Janvier", "Février", "Mars", "Avril", "Mai", "Juin",
+    "Juillet", "Août", "Septembre", "Octobre", "Novembre", "Décembre")
+  for i in range(12) {
+    let idate = datetime(year: 0, month: i + 1, day: 1)
+    let ml = idate.display("[month repr:long]")
+    let ms = idate.display("[month repr:short]")
+    t.insert(ml, fr-months-l.at(i))
+    t.insert(ms, fr-month-s.at(i))
+  }
+
+  // Translating month
+  let fr_month = t.at(month)
+  fr_month
+}
+
+#let display-date(date, short-month) = {
+  context {
+    // Getting adapted month string
+    let repr = if short-month { "short" } else { "long" }
+    let month = date.display("[month repr:" + repr + "]")
+
+    // Translate if necessary
+    if text.lang == "fr" {
+      month = translate_month(month)
+    }
+
+  // Returns month and year
+  [#month #str(date.year())]
+  }
+}
+
+
+/* MAIN COVER DEFINITION */
+
+#let cover(title, author, date-start, date-end, subtitle: none, logo: none, short-month: false, logo-horizontal: true) = {
+  set page(background: move(dx: 0pt, dy: -13%, image("assets/armes.svg")))
+  set text(font: "New Computer Modern Sans", hyphenate: false, fill: rgb(1, 66, 106))
+  set align(center)
+
+  v(1.8fr)
+
+  set text(size: 24pt, weight: "bold")
+  upper(title)
+
+  v(1.5fr)
+
+  if subtitle != none {
+    set text(size: 20pt)
+    subtitle
+  }
+
+  v(1.5fr)
+  
+  set text(size: 18pt, weight: "regular")
+  display-date(date-start, short-month); [ \- ]; display-date(date-end, short-month)
+
+  image("assets/filet-court.svg")
+
+  set text(size: 16pt)
+  smallcaps(author)
+
+  v(1fr)
+
+  let logo-height = if (logo-horizontal) { 20mm } else { 30mm }
+  let path-logo-x = if (logo-horizontal) { "assets/logo-x-ip-paris.svg" } else { "assets/logo-x.svg" }
+
+  set image(height: logo-height)
+
+  if (logo != none) {
+    grid(
+      columns: (1fr, 1fr), align: center + horizon,
+      logo, image(path-logo-x)
+    )
+  } else {
+    grid(
+      columns: (1fr), align: center + horizon,
+      image(path-logo-x)
+    )
+  }
+
+}
+
+
+/********************/
+/* TESTING TEMPLATE */
+/********************/
+
+#set text(lang: "fr")
+
+#cover(
+  [A very long title over multiple lines automatically],
+  "Jane Doe",
+  datetime.today(),
+  datetime.today(),
+  subtitle: "Je n'ai pas de stage mais je suis détendu",
+  logo-horizontal: true,
+)