ape:0.4.4 (#4014)

Co-authored-by: Ana Gelez <[email protected]>

Author: gris-chat

packages/preview/ape/0.4.4/README.md

@@ -0,0 +1,116 @@
+# Ape for Typst
+
+Tired of documents that look like they were formatted by a troop of baboons? Try Ape for Typst!
+
+**Ape** is a Typst package designed to help you structure and style academic documents, such as course notes, reports, and theses. It offers a set of pre-configured layouts and utilities to make your documents look professional with minimal effort.
+
+> **Note:** This package is primarily designed with French conventions in mind (e.g., specific shortcuts and default text in some functions), but it can be used for documents in other languages as well.
+
+## Getting Started
+
+To use **Ape**, initialize your document using the `doc` function:
+```typst
+#import "@preview/ape:0.4.4": *
+#show: doc.with(
+  title: "My Course Title",
+  authors: ("Author Name",),
+  lang: "en", // Defaults to "fr"
+  style: "numbered",
+  title-page: true,
+  outline: true,
+)
+
+= Introduction
+Your content goes here...
+```
+
+*Exemple :*
+![Exemple 1](exemples/Exemple1.png)
+
+
+## Configuration
+
+The `doc` function accepts several parameters to customize your document:
+
+| Parameter | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `title` | `string` | `"Titre"` | The main title of the document. |
+| `authors` | `array` | `()` | A list of author names. |
+| `lang` | `string` | `"fr"` | The document language (e.g., "en", "fr"). |
+| `style` | `string` | `"numbered"` | Global style of the document (see below). |
+| `maths-style` | `string` | `"normal"` | Style for math environments (`"normal"` or `"colored"`). |
+| `title-page` | `boolean` | `false` | Whether to generate a dedicated title page. |
+| `outline` | `boolean` | `false` | Whether to generate a table of contents. |
+| `smallcaps` | `boolean` | `true` | Whether to use small caps in headers/titles. |
+
+### Available Styles
+- **`numbered`**: A structured layout with numbered sections, suitable for reports and books.
+- **`colored`**: A colorful design often used for course notes.
+- **`plain`**: A simple, minimalist layout.
+- **`presentation`**: A layout optimized for slides/presentations.
+
+## Features
+
+### Formatting Tools
+
+*   **`para(name, content)`**: Creates a labeled paragraph.
+    ```typst
+    #para("Note", [This is a side note.])
+    ```
+*   **`arrow-list(..items)`**: Creates a list with arrow bullets.
+    ```typst
+    #arrow-list[First item][Second item]
+    ```
+*   **`inbox(content)`**: Creates a simple boxed container.
+    *   Variants: `inbox2`, `inbox3`, `inbox4` offer different border and background styles.
+
+### Math Environments
+
+Ape provides environments for common mathematical structures. Their appearance changes based on the `maths-style` configuration.
+
+*   `def(title, content)`: Definition
+*   `prop(title, content)`: Property
+*   `theorem(title, content)`: Theorem
+*   `lemme(title, content)`: Lemma
+*   `corollaire(title, content)`: Corollary
+*   `remarque(title, content)`: Remark
+*   `exemple(title, content)`: Example
+*   `exercice(title, content)`: Exercise
+*   `demo(content)`: Proof (Démonstration)
+
+```typst
+#def("Linear Algebra")[ 
+  A vector space is...
+]
+```
+
+### Shortcuts & Utilities
+
+*   **Physics Notations**:
+    *   `dt`, `dx`, `dtheta`
+    *   `grad` 
+    *   `ar(x)` -> $vec{x}$ (Arrow)
+    *   `nar(x)` -> $||vec{x}||$ (Norm of arrow)
+
+*   **Math Sets & Operators**:
+    *   `Im`, `Ker`, `Vect`, `dim`, `card`
+    *   `GL` (General Linear Group), `SO` (Special Orthogonal Group)
+    *   `Union`, `Inter` (Big union/intersection)
+
+### Plotting & Figures
+
+Ape integrates with `cetz` for drawing and plotting.
+
+*   **`plotting(functions, ...)`**: A high-level wrapper to plot functions easily.
+    ```typst
+    #plotting(
+      (
+        (fn: x => x * x, domain: (-2, 2), stroke: blue),
+      ),
+      axis-style: "school-book"
+    )
+    ```
+*   **Drawing Utilities**:
+    *   `point(coordinates)`
+    *   `spring(start, end, ...)`
+    *   `base(origin, name1, name2, angle)`

packages/preview/ape/0.4.4/document/apply-style.typ

@@ -0,0 +1,32 @@
+#import "styles/numbered.typ": *
+#import "styles/colored.typ": *
+#import "styles/plain.typ": *
+#import "styles/presentation.typ": *
+#import "styles/book.typ": *
+
+#let apply-style(style, title, authors, content) = {
+  set heading(numbering: "I)1)a)i)")
+
+  if style == "numbered" or style == "numbered-book" {
+    return numbered(content, style)
+  } else if style == "book" {
+    return book(content)
+  } else if style == "colored" {
+    return colored(content)
+  } else if style == "plain" {
+    return plain(content)
+  } else if style == "presentation" {
+    return presentation(content, title, authors)
+  } else {
+    return numbered(content)
+  }
+}
+
+#let get-small-title(style, title, authors) = {
+  if (style == "numbered-book") {
+    style = "numbered"
+  }
+  import "styles/" + style + ".typ" as current-style
+
+  return current-style.get-small-title(title, authors)
+}

packages/preview/ape/0.4.4/document/code-display.typ

@@ -0,0 +1,55 @@
+#import "../tools/miscellaneous.typ": content-to-string
+
+#let code-display(content) = {
+  // Code
+  show raw: it => context {
+    if ("py", "python", "ocaml", "ml", "sql").contains(it.lang) {
+      let breakableVar = false
+      let lines = (..it.lines,)
+
+
+      // Remove empty lines at the beginning and end
+      while lines.len() > 0 and content-to-string(lines.first()).trim() == "" {
+        let _ = lines.remove(0)
+      }
+      while lines.len() > 0 and content-to-string(lines.last()).trim() == "" {
+        let _ = lines.remove(-1)
+      }
+
+      if (lines.len() >= 15) {
+        breakableVar = true
+      }
+
+
+      block(
+        clip: true,
+        radius: calc.min(9pt, 4pt + 2pt * lines.len()),
+        stroke: text.fill.lighten(50%) + 0.5pt,
+        align(
+          center,
+          block(
+            breakable: breakableVar,
+            grid(
+              columns: (measure([#lines.len()]).width + 10pt, 20fr),
+              column-gutter: 0pt,
+              inset: ((left: 5pt, right: 5pt, rest: 3pt), (left: 10pt, rest: 3pt)),
+              align: (horizon + left, left),
+              fill: (text.fill.lighten(75%), text.fill.lighten(88%)),
+              [],
+              [],
+              ..for i in range(lines.len()) {
+                let l = lines.at(i)
+                (str(i + 1), l.body)
+              },
+              [],
+              [],
+            ),
+          ),
+        ),
+      )
+    } else {
+      it
+    }
+  }
+  content
+}

packages/preview/ape/0.4.4/document/doc.typ

@@ -0,0 +1,108 @@
+#import "outline.typ": *
+#import "apply-style.typ": *
+#import "header-footer.typ": *
+#import "front-pages.typ": *
+#import "../tools/shortcuts.typ": *
+#import "code-display.typ": *
+#import "quote-display.typ": *
+#import "../tools/formatting.typ": *
+#import "../tools/date.typ": *
+#import "../maths/maths-style.typ": maths-style-state, maths-num-state
+
+= Documents
+
+
+/*
+Labels :
+- <title>
+- <section>
+- <subsection>
+*/
+
+/*
+Style :
+- Numbered
+- Colored
+- Plain
+*/
+
+/*
+Maths style : 
+- normal
+- colored
+- boxed
+*/
+
+/*
+Maths numbering :
+- normal
+- separate
+- none
+*/
+
+
+#let doc(
+  lang: "fr",
+  title: "Titre",
+  authors: (),
+  style: "numbered",
+  maths-style: "normal",
+  maths-num: "normal",
+  title-page: false,
+  outline: false,
+  local-outline: false,
+  outline-max-depth: 5,
+  smallcaps: true,
+  content,
+) = context {
+  set page(margin: 1.5cm)
+  set text(lang: lang, font: "New Computer Modern")
+  maths-style-state.update(maths-style)
+  maths-num-state.update(maths-num)
+  
+  show: apply-style.with(style, title, authors)
+
+  let (first-real-pages, custom-outline) = get-outline(lang, smallcaps, outline-max-depth)
+
+
+  if (first-real-pages.len() == 0) {
+    first-real-pages.push(0)
+  }
+
+  
+  show: shows-shortcuts
+  show: code-display
+  show: quote-display
+
+  // Pre-set
+  show table: it => {
+    block(clip: true, radius: 0.75em, stroke: it.stroke, it)
+  }
+  show image: it => {
+    align(center, it)
+  }
+
+  // content
+  set par(justify: true)
+   
+  if (style != "presentation") {
+    show: header-footer.with(style, smallcaps, first-real-pages, title, authors)
+    
+    front-pages(style, smallcaps, title, title-page, authors, outline, local-outline, custom-outline)
+     
+
+    set table(inset: 10pt, stroke: 0.4pt + text.fill.lighten(20%), align: center + horizon, fill: (x, y) => if (x == 0)
+      or (y == 0) { text.fill.lighten(90%) })
+
+    set grid(column-gutter: 10pt, align: horizon)
+
+    
+    counter(heading).update(0)
+    content
+  }else{
+    title-slide()
+    counter(heading).update(0)
+    content
+  }
+}
+

packages/preview/ape/0.4.4/document/front-pages.typ

@@ -0,0 +1,75 @@
+#import "apply-style.typ": get-small-title
+#import "outline.typ": get-local-outline
+
+#let front-pages(style, small-caps, title, title-page, authors, outline, local-outline, custom-outline) = {
+  let sc(c) = {
+    if small-caps == true {
+      return smallcaps(c)
+    } else {
+      return c
+    }
+  }
+
+  if title-page {
+    align(
+      center + horizon,
+      [
+
+        #{
+          if type(title) == str {
+            par(leading: 2em, spacing: 3em, text(size: 5em, hyphenate: false, (strong(title))))
+          } else {
+            par(leading: 1.7em, text(size: 5em, hyphenate: false, (strong(title.at(1)))))
+            par(leading: 1em, spacing: 3em, text(size: 3.25em, hyphenate: false, (title.at(0))))
+          }
+        }
+        #v(1em)
+
+        #{
+          if type(authors) == array {
+            if authors.len() > 0 {
+              [
+                #text(size: 1.55em, sc(authors.at(0)))
+                \
+              ]
+            }
+            if authors.len() > 1 {
+              [
+                #text(size: 1.55em, authors.slice(1).map(sc).join(" - "))
+              ]
+            }
+          } else {
+            [
+              #text(size: 1.55em, sc(authors))
+            ]
+          }
+        }
+
+      ],
+    )
+
+    pagebreak()
+    if outline {
+      custom-outline
+      pagebreak()
+    }
+    
+    get-small-title(style, title, authors)
+    if local-outline {
+      get-local-outline()
+    }
+    
+  } else {
+    if outline {
+      custom-outline
+      pagebreak()
+    }
+
+    get-small-title(style, title, authors) 
+    
+    if local-outline {
+      get-local-outline()
+    }
+    v(20pt)
+  }
+}