alexandria:0.2.2 (#3641)

Author: SillyFreak

packages/preview/alexandria/0.2.2/.gitignore

@@ -0,0 +1 @@
+target/

packages/preview/alexandria/0.2.2/CHANGELOG.md

@@ -0,0 +1,109 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+<details>
+<summary>Migration guide from v0.1.x</summary>
+
+<!-- Write migration guide here -->
+
+</details>
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+## [0.2.2] - 2025-12-12
+
+### Added
+- Math markup embedded in references is now rendered correctly
+- Alexandria now supports footnote bibliography styles
+
+### Changed
+- Improvements in the manual thanks to [alyst](https://github.com/alyst/)
+- Update the Hayagriva version used by the plugin from 0.8.1 to 0.9.1, fixing various bugs and bringing Alexandria in line with Typst 0.14.
+  - Automated tests no longer run on 0.12 and 0.13 since bugfixes between Hayagriva 0.8 and 0.9 mean that older Typst and new Alexandria no longer match exactly. Alexandria should still be compatible with Typst 0.12+.
+- Errors while parsing a bibliography file now contain more detailed information on the location of the error. The messages are in line with what the native bibliography reports, except that the error is reported inside the package, not in the bibliography file.
+
+## [0.2.1] - 2025-07-08
+
+### Changed
+- update the Hayagriva version used by the plugin from 0.8.0 to 0.8.1, fixing various bugs
+
+## [0.2.0] - 2025-04-23
+
+### Added
+- `citegroup` added, which allows creating collapsed citations
+
+### Changed
+- the structure in which config data is stored has changed: the state now has `prefixes.at(..).citations` instead of `prefixes.citations.at(..)`. If you use the (internal) functions of the `alexandria.hayagriva` module directly, this is a BREAKING change.
+- `get-citation-index()` is now `get-citation-info()` and returns a dictionary with `index` and `group`. If you use the (internal) functions of the `alexandria.hayagriva` module directly, this is a BREAKING change.
+- serialization inside the plugin has been simplified
+- during serialization, link bodies are no longer wrapped into text elements. If you use the (internal) functions of the `alexandria.hayagriva` module directly, this is a BREAKING change.
+
+### Fixed
+- links now don't span whole citations, but only the parts that would be links in vanilla Typst
+- `cite(form: none)` is now supported
+
+## [0.1.3] - 2025-03-13
+
+### Added
+- Hayagriva's "transparent" content is now supported, enabling citation supplements
+
+### Changed
+- `get-bibliography` now accepts `auto` as a parameter if there is only one bibliography
+
+### Fixed
+- citations' supplements (such as `[1, p. 42]` instead of `[1]`) are no longer ignored
+
+## [0.1.2] - 2025-03-08
+
+### Added
+- support for `bytes` as a bib or csl file parameter, to be up-to-date with Typst 0.13's `bibliography()` API
+
+## [0.1.1] - 2025-02-12
+
+### Added
+- `load-bibliography` that stores bib data for later retrieval
+- `get-bibliography` that retrieves the data
+- `render-bibliography` that renders the bib data
+- add details (type, title, author, ...) to data available for bibliography users
+- add support for custom CSL styles loaded from files
+
+### Fixed
+- fixed a deprecation warning when running Typst 0.13
+- split bibliographyx into load, get and render parts
+
+## [0.1.0] - 2025-02-06
+
+### Added
+
+- plugin for rendering references and citations
+- Typst wrapper for
+  - collecting citations
+  - calling the plugin
+  - processing its results (rendering structured data into styled content)
+- Tests for IEEE and APA references in English and German (APA tests are deactivated to to something that's probably a Typst bug)
+
+
+[Unreleased]: https://github.com/SillyFreak/typst-alexandria/compare/v0.2.2...HEAD
+[0.2.2]: https://github.com/SillyFreak/typst-alexandria/releases/tag/v0.2.2
+[0.2.1]: https://github.com/SillyFreak/typst-alexandria/releases/tag/v0.2.1
+[0.2.0]: https://github.com/SillyFreak/typst-alexandria/releases/tag/v0.2.0
+[0.1.3]: https://github.com/SillyFreak/typst-alexandria/releases/tag/v0.1.3
+[0.1.2]: https://github.com/SillyFreak/typst-alexandria/releases/tag/v0.1.2
+[0.1.1]: https://github.com/SillyFreak/typst-alexandria/releases/tag/v0.1.1
+[0.1.0]: https://github.com/SillyFreak/typst-alexandria/releases/tag/v0.1.0

packages/preview/alexandria/0.2.2/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2024 Clemens Koza
+
+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/alexandria/0.2.2/README.md

@@ -0,0 +1,38 @@
+# Alexandria
+
+This package provides an alternative to the built-in bibliography to allow a single document to have multiple bibliographies.
+
+This package currently has a few limitations, mostly around how styling applies differently between the built-in bibliography and Alexandria.
+
+## Getting Started
+
+To add this package to your project, use this:
+
+```typ
+#import "@preview/alexandria:0.2.2": *
+
+#show: alexandria(prefix: "x:", read: path => read(path))
+
+...
+
+#bibliographyx(
+  "bibliography.bib",
+  // title: auto is not yet supported so it needs to be specified
+  title: "Bibliography",
+)
+```
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="./thumbnail-dark.svg">
+  <img src="./thumbnail-light.svg">
+</picture>
+
+## Usage
+
+See the [manual](docs/manual.pdf) for details.
+
+## License
+
+Parts of the Rust plugin that interfaces with the [Hayagriva](https://github.com/typst/hayagriva) citation library are based on [typst-library's `bibliography.rs`](https://github.com/typst/typst/blob/26e65bfef5b1da7f6c72e1409237cf03fb5d6069/crates/typst-library/src/model/bibliography.rs). Likewise, the example bibliographies are taken or adapted from [typst-dev-assets' `works.bib`](https://github.com/typst/typst-dev-assets/blob/1dba4bea22e5e19597fbf5f321b047ff7626e2d0/files/bib/works.bib). Both are licensed from Typst's authors under the Apache License 2.0.
+
+The example CSL style [`ieee.csl`](https://github.com/citation-style-language/styles/blob/fd6cb3e81762055d107839c3c288c359985f81c8/ieee.csl) is taken from the [CSL project](https://citationstyles.org/) who provide it under the [Creative Commons Attribution-ShareAlike 3.0 Unported license](https://creativecommons.org/licenses/by-sa/3.0/).

packages/preview/alexandria/0.2.2/docs/manual.pdf

@@ -0,0 +1,83 @@
+#let _p = plugin("alexandria.wasm")
+
+#let names = {
+  // Typst 0.13: `cbor.decode` is deprecated, directly pass bytes to `cbor` instead
+  let decode = if sys.version < version(0, 13, 0) { cbor.decode } else { cbor }
+
+  decode(_p.names())
+}
+
+#let read(
+  sources,
+  full,
+  style,
+  locale,
+  citations,
+) = {
+  // Typst 0.13: `cbor.decode` is deprecated, directly pass bytes to `cbor` instead
+  let decode = if sys.version < version(0, 13, 0) { cbor.decode } else { cbor }
+
+  let config = cbor.encode((sources: sources, full: full, style: style, locale: locale, citations: citations))
+  decode(_p.read(config))
+}
+
+#let render(body, keys: none, ..transparent-contents) = {
+  assert.eq(transparent-contents.named().len(), 0, message: "no named arguments allowed")
+  let transparent-contents = transparent-contents.pos()
+  let formatted(fmt) = it => {
+    set text(style: "italic") if fmt.font-style == "italic"
+    // TODO this is an absolute weight and not an offset
+    set text(weight: "bold") if fmt.font-weight == "bold"
+    set text(weight: "light") if fmt.font-weight == "light"
+    if fmt.font-variant == "small-caps" {
+      it = smallcaps(it)
+    }
+    if fmt.text-decoration == "underline" {
+      it = underline(it)
+    }
+    if fmt.vertical-align == "sup" {
+      it = h(0pt, weak: true) + super(it)
+    } else if fmt.vertical-align == "sub" {
+      it = h(0pt, weak: true) + sub(it)
+    }
+    it
+  }
+
+  let inner(body) = {
+    if type(body) == array {
+      body.map(inner).join()
+    } else if "text" in body {
+      let body = body.text
+      show: formatted(body)
+      body.text
+    } else if "elem" in body {
+      let body = body.elem
+      show: it => {
+        if "entry" in body.meta {
+          assert.ne(keys, none, message: "Alexandria: internal error: citation keys are missing")
+          assert(body.meta.entry < keys.len(), message: "Alexandria: internal error: unmatched key in citegroup")
+          let entry = keys.at(body.meta.entry)
+          it = link(entry, it)
+        }
+        it
+      }
+      // TODO handle body.display when present
+      inner(body.children)
+    } else if "link" in body {
+      let body = body.link
+      show: formatted(body)
+      link(body.url, body.text)
+    } else if "markup" in body {
+      eval(body.markup, mode: "math")
+    } else if "transparent" in body {
+      let body = body.transparent
+      show: formatted(body)
+      assert(body.cite-idx < transparent-contents.len(), message: "Alexandria: internal error: unmatched transparent content")
+      transparent-contents.at(body.cite-idx)
+    } else {
+      set text(red)
+      repr(body)
+    }
+  }
+  inner(body)
+}

packages/preview/alexandria/0.2.2/gallery/example.pdf

@@ -0,0 +1,13 @@
+#let locale() = {
+  let locale = text.lang
+  if text.region != none { locale += "-" + text.region }
+  locale
+}
+
+#let csl-to-string(csl) = {
+  if type(csl) in (str, bytes) { return csl }
+
+  let csl = repr(csl).slice(1, -1)
+  assert.ne(csl, "..", message: "only named CSL styles can be converted to strings")
+  csl
+}