Squashed 'src/resources/extension-subtrees/orange-book/' content from commit d39d268a9

git-subtree-dir: src/resources/extension-subtrees/orange-book
git-subtree-split: d39d268a93a8e14518b59a2be05893f0a8943aef

Author: gordonwoodhull

README.md

@@ -0,0 +1,48 @@
+# Orange Book Format Extension for Quarto
+
+A Quarto format extension that provides Typst book support using the [orange-book](https://typst.app/universe/package/orange-book) package.
+
+## Installation
+
+Orange-book will be bundled with Quarto 1.9 and will be the default extension for Typst book projects.
+
+However, if you want to explicitly install and use this extension
+
+```bash
+quarto add quarto-ext/orange-book
+```
+
+## Usage
+
+In your `_quarto.yml`:
+
+```yaml
+project:
+  type: book
+
+format: orange-book-typst
+```
+
+## Features
+
+- Transforms book parts into `#part[...]` calls for proper orange-book formatting
+- Handles appendix sections with `#show: appendices.with(...)`
+- Chapter-based numbering for equations, callouts, and cross-references
+- Integrates with Quarto's brand system for colors and logos
+
+## Requirements
+
+- Quarto >= 1.9.17
+- The `orange-book` Typst package (automatically imported and bundled with [typst-gather](https://prerelease.quarto.org/docs/advanced/typst/typst-gather.html))
+
+## How It Works
+
+This extension:
+
+1. Provides template partials (`typst-show.typ`, `numbering.typ`) that configure the orange-book package
+2. Includes a Lua filter (`orange-book.lua`) that transforms Quarto's book structure into orange-book-specific Typst commands
+3. Uses Quarto's `file_metadata` API to detect book item types (parts, chapters, appendices)
+
+## License
+
+MIT

_extensions/orange-book/_extension.yml

@@ -0,0 +1,14 @@
+title: Typst Orange Book Format
+author: Quarto
+version: 0.1.0
+quarto-required: ">=1.9.17"
+contributes:
+  formats:
+    typst:
+      template-partials:
+        - numbering.typ
+        - page.typ
+        - typst-show.typ
+      filters:
+        - path: orange-book.lua
+          at: post-quarto

_extensions/orange-book/numbering.typ

@@ -0,0 +1,38 @@
+// Chapter-based numbering for books with appendix support
+#let equation-numbering = it => {
+  let pattern = if state("appendix-state", none).get() != none { "(A.1)" } else { "(1.1)" }
+  numbering(pattern, counter(heading).get().first(), it)
+}
+#let callout-numbering = it => {
+  let pattern = if state("appendix-state", none).get() != none { "A.1" } else { "1.1" }
+  numbering(pattern, counter(heading).get().first(), it)
+}
+#let subfloat-numbering(n-super, subfloat-idx) = {
+  let chapter = counter(heading).get().first()
+  let pattern = if state("appendix-state", none).get() != none { "A.1a" } else { "1.1a" }
+  numbering(pattern, chapter, n-super, subfloat-idx)
+}
+// Theorem configuration for theorion
+// Chapter-based numbering (H1 = chapters)
+#let theorem-inherited-levels = 1
+
+// Appendix-aware theorem numbering
+#let theorem-numbering(loc) = {
+  if state("appendix-state", none).at(loc) != none { "A.1" } else { "1.1" }
+}
+
+// Theorem render function
+// Note: brand-color is not available at this point in template processing
+#let theorem-render(prefix: none, title: "", full-title: auto, body) = {
+  block(
+    width: 100%,
+    inset: (left: 1em),
+    stroke: (left: 2pt + black),
+  )[
+    #if full-title != "" and full-title != auto and full-title != none {
+      strong[#full-title]
+      linebreak()
+    }
+    #body
+  ]
+}

_extensions/orange-book/orange-book.lua

@@ -0,0 +1,69 @@
+-- orange-book.lua
+-- Orange-book specific part and appendix handling for Typst books
+
+local function is_typst_book()
+  local file_state = quarto.doc.file_metadata()
+  return quarto.doc.is_format("typst") and
+         file_state ~= nil and
+         file_state.file ~= nil
+end
+
+local header_filter = {
+  Header = function(el)
+    local file_state = quarto.doc.file_metadata()
+
+    if not is_typst_book() then
+      return nil
+    end
+
+    if file_state == nil or file_state.file == nil then
+      return nil
+    end
+
+    local file = file_state.file
+    local bookItemType = file.bookItemType
+
+    if el.level ~= 1 or bookItemType == nil then
+      return nil
+    end
+
+    -- Handle parts
+    if bookItemType == "part" then
+      return pandoc.RawBlock('typst', '#part[' .. pandoc.utils.stringify(el.content) .. ']')
+    end
+
+    -- Handle appendices
+    if bookItemType == "appendix" then
+      -- First appendix triggers the show rule with localized "Appendices" title
+      if file.bookItemNumber == 1 or file.bookItemNumber == nil then
+        -- Get localized title from language settings
+        local language = quarto.doc.language
+        local appendicesTitle = (language and language["section-title-appendices"]) or "Appendices"
+
+        -- Use hide-parent: true to work around orange-book bug where unnumbered headings
+        -- (like Bibliography) trigger duplicate "Appendices" TOC entries.
+        local appendixStart = pandoc.RawBlock('typst',
+          '#show: appendices.with("' .. appendicesTitle .. '", hide-parent: true)')
+
+        -- If this is the synthetic "Appendices" divider heading (has .unnumbered class),
+        -- emit our own Appendices heading for TOC display
+        if el.classes:includes("unnumbered") then
+          local appendicesHeading = pandoc.RawBlock('typst',
+            '#heading(level: 1, numbering: none)[' .. appendicesTitle .. ']')
+          return {appendixStart, appendicesHeading}
+        end
+
+        return {appendixStart, el}
+      end
+    end
+
+    return nil
+  end
+}
+
+-- Combine with file_metadata_filter so book metadata markers are parsed
+-- during this filter's document traversal (needed for bookItemType, etc.)
+return quarto.utils.combineFilters({
+  quarto.utils.file_metadata_filter(),
+  header_filter
+})

_extensions/orange-book/page.typ

@@ -0,0 +1,15 @@
+#set page(
+  paper: $if(papersize)$"$papersize$"$else$"us-letter"$endif$,
+$if(margin-geometry)$
+  // Margins handled by marginalia.setup in typst-show.typ AFTER book.with()
+$elseif(margin)$
+  margin: ($for(margin/pairs)$$margin.key$: $margin.value$,$endfor$),
+$else$
+  margin: (x: 1.25in, y: 1.25in),
+$endif$
+  numbering: $if(page-numbering)$"$page-numbering$"$else$none$endif$,
+  columns: $if(columns)$$columns$$else$1$endif$,
+)
+// Logo is handled by orange-book's cover page, not as a page background
+// NOTE: marginalia.setup is called in typst-show.typ AFTER book.with()
+// to ensure marginalia's margins override the book format's default margins

_extensions/orange-book/typst-gather.toml

@@ -0,0 +1,17 @@
+# typst-gather configuration
+# Run: quarto call typst-gather
+
+destination = "typst/packages"
+
+discover = ["numbering.typ", "page.typ", "typst-show.typ"]
+
+# Preview packages are auto-discovered from imports.
+# Uncomment to pin specific versions:
+# [preview]
+# cetz = "0.4.1"
+
+# Local packages (@local namespace) must be configured manually.
+# Found @local imports:
+#   @local/orange-book:0.7.1 (in typst-show.typ)
+[local]
+orange-book = "/Users/gordon/src/tb-work/templates/orange-book"

_extensions/orange-book/typst-show.typ

@@ -0,0 +1,61 @@
+#import "@local/orange-book:0.7.1": book, part, chapter, appendices
+
+#show: book.with(
+$if(title)$
+  title: [$title$],
+$endif$
+$if(subtitle)$
+  subtitle: [$subtitle$],
+$endif$
+$if(by-author)$
+  author: "$for(by-author)$$it.name.literal$$sep$, $endfor$",
+$endif$
+$if(date)$
+  date: "$date$",
+$endif$
+$if(lang)$
+  lang: "$lang$",
+$endif$
+  main-color: brand-color.at("primary", default: blue),
+  logo: {
+    let logo-info = brand-logo.at("medium", default: none)
+    if logo-info != none { image(logo-info.path, alt: logo-info.at("alt", default: none)) }
+  },
+$if(toc-depth)$
+  outline-depth: $toc-depth$,
+$endif$
+$if(lof)$
+  list-of-figure-title: "$if(crossref.lof-title)$$crossref.lof-title$$else$$crossref-lof-title$$endif$",
+$endif$
+$if(lot)$
+  list-of-table-title: "$if(crossref.lot-title)$$crossref.lot-title$$else$$crossref-lot-title$$endif$",
+$endif$
+$if(margin-geometry)$
+  padded-heading-number: false,
+$endif$
+)
+
+$if(margin-geometry)$
+// Configure marginalia page geometry for book context
+// Geometry computed by Quarto's meta.lua filter (typstGeometryFromPaperWidth)
+// IMPORTANT: This must come AFTER book.with() to override the book format's margin settings
+#import "@preview/marginalia:0.3.1" as marginalia
+
+#show: marginalia.setup.with(
+  inner: (
+    far: $margin-geometry.inner.far$,
+    width: $margin-geometry.inner.width$,
+    sep: $margin-geometry.inner.separation$,
+  ),
+  outer: (
+    far: $margin-geometry.outer.far$,
+    width: $margin-geometry.outer.width$,
+    sep: $margin-geometry.outer.separation$,
+  ),
+  top: $if(margin.top)$$margin.top$$else$1.25in$endif$,
+  bottom: $if(margin.bottom)$$margin.bottom$$else$1.25in$endif$,
+  // CRITICAL: Enable book mode for recto/verso awareness
+  book: true,
+  clearance: $margin-geometry.clearance$,
+)
+$endif$

_extensions/orange-book/typst/packages/local/orange-book/0.7.1/LICENSE

@@ -0,0 +1,14 @@
+MIT No Attribution
+
+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.
+
+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.

_extensions/orange-book/typst/packages/local/orange-book/0.7.1/README.md

@@ -0,0 +1,72 @@
+# orange-book
+A book template inspired by The Legrand Orange Book of Mathias Legrand and Vel https://www.latextemplates.com/template/legrand-orange-book.
+
+## Usage
+You can use this template in the Typst web app by clicking "Start from template"
+on the dashboard and searching for `orange-book`.
+
+Alternatively, you can use the CLI to kick this project off using the command
+```
+typst init @preview/orange-book
+```
+
+Typst will create a new directory with all the files needed to get you started.
+
+## Configuration
+This template exports the `book` function with the following named arguments:
+
+- `title`: The book's title as content.
+- `subtitle`: The book's subtitle as content.
+- `author`: Content or an array of content to specify the author.
+- `paper-size`: Defaults to `a4`. Specify a [paper size
+  string](https://typst.app/docs/reference/layout/page/#parameters-paper) to
+  change the page format.
+- `copyright`: Details about the copyright or
+  `none`.
+- `lowercase-references`: True to have references in lowercase (Eg. table 1.1)
+
+The function also accepts a single, positional argument for the body of the
+book.
+
+The template will initialize your package with a sample call to the `book`
+function in a show rule. If you, however, want to change an existing project to
+use this template, you can add a show rule like this at the top of your file:
+
+```typ
+#import "@preview/orange-book:0.7.0": book
+
+#show: book.with(
+  title: "Exploring the Physical Manifestation of Humanity’s Subconscious Desires",
+  subtitle: "A Practical Guide",
+  date: "Anno scolastico 2023-2024",
+  author: "Goro Akechi",
+  main-color: rgb("#F36619"),
+  lang: "en",
+  cover: image("./background.svg"),
+  image-index: image("./orange1.jpg"),
+  list-of-figure-title: "List of Figures",
+  list-of-table-title: "List of Tables",
+  supplement-chapter: "Chapter",
+  supplement-part: "Part",
+  part-style: 0,
+  copyright: [
+    Copyright © 2023 Flavio Barisi
+
+    PUBLISHED BY PUBLISHER
+
+    #link("https://github.com/flavio20002/typst-orange-template", "TEMPLATE-WEBSITE")
+
+    Licensed under the Apache 2.0 License (the “License”).
+    You may not use this file except in compliance with the License. You may obtain a copy of
+    the License at https://www.apache.org/licenses/LICENSE-2.0. Unless required by
+    applicable law or agreed to in writing, software distributed under the License is distributed on an
+    “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and limitations under the License.
+
+    _First printing, July 2023_
+  ],
+  lowercase-references: false
+)
+
+// Your content goes below.
+```