prinzipien:0.1.1

packages/preview/prinzipien/0.1.1/LICENSE.txt

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN 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/prinzipien/0.1.1/README.md

@@ -0,0 +1,128 @@
+# prinzipien
+
+[![Typst Universe](https://img.shields.io/badge/Typst_Universe-prinzipien-239dad?logo=typst&logoColor=white)](https://typst.app/universe/package/prinzipien)
+[![License: BSL-1.0](https://img.shields.io/badge/license-BSL--1.0-blue.svg)](LICENSE.txt)
+[![Built with Touying](https://img.shields.io/badge/built_with-touying-f9ab1a)](https://touying-typ.github.io/)
+
+Prinzipien is a [Typst](https://typst.app) theme for
+[Touying](https://touying-typ.github.io/) presentations, built on the design
+principles of Jean-luc Doumont's _Trees, maps, and theorems_: **one message per
+slide**. Each slide states a single, full-sentence message as its title, set
+flush against a wide left margin, and a single accent colour — with tints
+derived from it — does all the visual work.
+
+- **One message per slide** — the slide title is a full sentence stating the takeaway.
+- **A wide, Doumont-style left margin** that structures every slide.
+- **A single accent colour**, with tints derived automatically for emphasis and de-emphasis.
+- **Automatic overview slides** — `preview`, section `transition`s, and `review` build a map of your points.
+- **Batteries included** — a title slide, appendix numbering, and logo support.
+- **Configured in one place** — aspect ratio, margin width, colours, and logo.
+
+## Showcase
+
+![Four slides from the demo deck: a title slide with a logo, an overview map in the accent colour, a content slide flush against the wide margin, and a slide with labels in the margin beside an image.](assets/showcase.png)
+
+The slides above come from the `examples/demo.typ` deck, which relies on the
+theme's defaults; `examples/full-demo.typ` exercises every configuration option.
+Both live in the [source repository](https://github.com/Entze/prinzipien).
+
+## Installation
+
+Prinzipien is published on
+[Typst Universe](https://typst.app/universe/package/prinzipien), so no manual
+installation is required. To start a new presentation from the bundled template:
+
+```sh
+typst init @preview/prinzipien
+```
+
+Or import the theme into an existing document:
+
+```typ
+#import "@preview/prinzipien:0.1.1": *
+```
+
+### Requirements
+
+- Typst 0.15.0 or newer.
+- The Noto Sans and Noto Sans Mono fonts (bundled with Typst). Override them
+  with your own `set text(font: ..)` rules after the theme's show rule if you
+  prefer different fonts.
+
+## Usage
+
+Apply the theme with a show rule, then write one message per slide as a
+level-2 heading:
+
+```typ
+#import "@preview/prinzipien:0.1.1": *
+
+#show: prinzipien-theme.with(
+  config-info(
+    title: [One sentence to remember],
+    author: [Ada Lovelace],
+    date: datetime.today(),
+  ),
+)
+
+#title-slide()
+
+== Give every slide a full-sentence message
+
+The heading carries the takeaway; the body only supports it.
+```
+
+Highlight the words that matter with `#alert[..]`, mark the main points of your
+talk with `#point[..]`, and let `#preview()` / `#review()` build the overview
+maps automatically. See [`template/main.typ`](template/main.typ) for a complete
+starting point, and the `examples/` directory in the
+[repository](https://github.com/Entze/prinzipien) for fuller decks.
+
+### Configuration
+
+`prinzipien-theme` takes a handful of options, all with sensible defaults:
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `aspect-ratio` | `"16-9"` | Slide aspect ratio (`"16-9"` or `"4-3"`). |
+| `margin` | `33%` | Width of the reserved left margin (a ratio of the slide width, or a length). |
+| `background` | `#ffffff` | Background colour. |
+| `foreground` | `#221f21` | Text (foreground) colour. |
+| `accent` | `#f9ab1a` | The one accent colour. |
+| `suppressed` | `#7a7d80` | Colour for muted / de-emphasised content. |
+| `accent-tint` | `auto` | Tint of the accent, used behind `#alert`; derived from `accent` by default. |
+| `logo-square` | `auto` | Square logo shown beside the slide title; derived from `config-info`'s `logo` by default. |
+
+## Contributing
+
+Contributions are welcome. This repository uses
+[mise](https://mise.jdx.dev) to pin tool versions and
+[hk](https://hk.jdx.dev) to run formatters and checks:
+
+```sh
+mise install               # install the pinned tools (Typst, hk, typstyle, ..)
+mise exec -- hk run fix     # format and auto-fix
+mise exec -- hk run check   # run checks that cannot be auto-fixed
+mise exec -- hk run lint    # verify package-submission compliance
+```
+
+Please run the formatters before opening a pull request, and open an issue for
+larger changes first. Bug reports and feature requests go to the
+[issue tracker](https://github.com/Entze/prinzipien/issues).
+
+## Authors and Acknowledgment
+
+- **Lukas Grassauer** — author and maintainer (<lukas@grassauer.eu>).
+
+Prinzipien builds on [Touying](https://touying-typ.github.io/) and follows the
+design principles of Jean-luc Doumont's _Trees, maps, and theorems_ (2009).
+
+Parts of this project — code, examples, and documentation — were written with
+the assistance of an AI coding agent (Anthropic's Claude Code) under the
+author's direction and review. If you would like to audit the prompts see
+[`plans`](plans/).
+
+## License
+
+Distributed under the Boost Software License 1.0 (BSL-1.0).
+See [`LICENSE.txt`](LICENSE.txt) for the full text.

packages/preview/prinzipien/0.1.1/examples/demo.bib

@@ -0,0 +1,8 @@
+@book{doumont2009,
+  author    = {Doumont, Jean-luc},
+  title     = {Trees, Maps, and Theorems: Effective Communication for
+               Rational Minds},
+  publisher = {Principiae},
+  address   = {Kraainem, Belgium},
+  year      = {2009},
+}

packages/preview/prinzipien/0.1.1/examples/demo.typ

@@ -0,0 +1,141 @@
+// A small but complete deck following Doumont's canonical structure:
+// attention getter -> need -> task -> main message -> preview ->
+// points with transitions -> review -> conclusion -> close,
+// plus backmatter (Q&A, references).
+
+#import "../lib.typ": *
+
+// Placeholder wordmark standing in for a real logo image.
+#let acme-logo = box({
+  box(
+    width: .8em,
+    height: .8em,
+    baseline: 12.5%,
+    fill: rgb("#f9ab1a"),
+    radius: .15em,
+  )
+  h(.35em)
+  text(weight: "bold")[ACME]
+})
+
+#show: prinzipien-theme.with(
+  config-info(
+    title: [Effective slides carry one message each],
+    author: [John Doe],
+    date: datetime.today(),
+    logo: acme-logo,
+  ),
+)
+
+#title-slide()
+
+// Attention getter.
+== A slide everyone has seen: six bullets, none remembered
+
+Think of the last talk you attended — which slide can you still recall?
+
+// Need: the gap between actual and desired situation.
+== Audiences forget slides that compete with their own titles
+
+Listeners keep one sentence per slide at most; \
+decks offer them ten.
+
+// Task.
+== This deck walks through a design that fixes the mismatch
+
+Every device shown here is from Doumont's
+_Trees, maps, and theorems_ @doumont2009.
+
+// Main message: the one sentence to remember.
+== State one message per slide, and design everything around it
+
+The rest of this deck develops three points that make it work.
+
+// Preview: the map of the body.
+#preview()
+
+#point(substatement: [Everything is set flush against it])[
+  A wide left margin structures the slide
+]
+
+== The content sits flush against the margin edge
+
+All sizes derive from a small set of shared dimensions.
+
+== The margin holds labels \ for the image on the right
+
+#slide(margin-content: [
+  #set text(size: .7em)
+  #v(2em)
+  A label in the margin
+
+  #v(4em)
+  Another label, further down
+])[
+  // Placeholder for an image, drawn in tints of the accent colour.
+  #rect(
+    width: 100%,
+    height: 80%,
+    fill: tint(rgb("#f9ab1a"), saturation: 15%),
+    stroke: none,
+    align(center + horizon, circle(radius: 3em, fill: tint(rgb("#f9ab1a")))),
+  )
+]
+
+== The margin and the content areas share one horizon
+
+#slide(margin-content: block(
+  width: 100%,
+  height: 40%,
+  fill: tint(rgb("#f9ab1a")),
+  stroke: rgb("#221f21") + 1pt,
+  align(center + horizon)[margin \ (accent tint)],
+))[
+  #block(
+    width: 100%,
+    height: 80%,
+    fill: rgb("#f9ab1a"),
+    stroke: rgb("#221f21") + 1pt,
+    align(center + horizon)[content \ (accent)],
+  )
+]
+
+#point(substatement: [Tints of it are enough for everything else])[
+  One accent colour marks what matters
+]
+
+== The accent colour carries the emphasis
+
+Use #alert[one accent colour] only, plus tints derived from it.
+
+#point(substatement: [One full sentence, optimally broken])[
+  The message is the slide title
+]
+
+== A full sentence makes the takeaway explicit
+
+The audience reads the title and knows what to remember.
+
+// Review: the map again, leading to the conclusion.
+#review()
+
+// Conclusion: what it means to the audience.
+== One message per slide is a design decision, not a writing tip
+
+Margin, colour, and title only work because they serve the message.
+
+// Close.
+== Your next deck can start from this template
+
+Take the structure, keep your message, drop the bullets.
+
+// Backmatter: numbered with roman numerals, excluded from the total.
+#show: appendix
+
+== Questions are welcome
+
+Ask away — or write to john\@example.org.
+
+== References
+
+#bibliography("demo.bib", title: none)

packages/preview/prinzipien/0.1.1/examples/full-demo.bib

@@ -0,0 +1,27 @@
+@book{doumont2009,
+  author    = {Doumont, Jean-luc},
+  title     = {Trees, Maps, and Theorems: Effective Communication for
+               Rational Minds},
+  publisher = {Principiae},
+  address   = {Kraainem, Belgium},
+  year      = {2009},
+}
+
+@article{miller1956,
+  author  = {Miller, George A.},
+  title   = {The Magical Number Seven, Plus or Minus Two: Some Limits on
+             Our Capacity for Processing Information},
+  journal = {Psychological Review},
+  volume  = {63},
+  number  = {2},
+  pages   = {81--97},
+  year    = {1956},
+}
+
+@online{touying,
+  author = {{Touying contributors}},
+  title  = {Touying: A Powerful Package for Creating Presentation Slides
+            in Typst},
+  url    = {https://github.com/touying-typ/touying},
+  year   = {2024},
+}