Typst Extra Docs

https://typst-community.github.io/extra-docs/
Admin
Typst is a markup-based typesetting system designed for creating documents with a modern syntax and...
Tokens:41,961
Snippets:666
Trust Score:8.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Basic Package Manifest Example

Source: https://typst-community.github.io/extra-docs/packages/manifest.html

This is a minimal example of a `typst.toml` file, showcasing the required `[package]` section with essential metadata.

```toml
[package]
name = "example"
version = "0.1.0"
entrypoint = "lib.typ"
authors = ["The Typst Project Developers"]
license = "MIT"
description = "Calculate elementary arithmetics with functions."

```

--------------------------------

### Basic Formattable String

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

A simple formattable string example demonstrating basic case-folding behavior.

```yaml
__
publisher: UN World Food Programme

```

--------------------------------

### Page Range Example

Source: https://typst-community.github.io/extra-docs/print.html

Demonstrates how to specify a page range using a numeric variable with a prefix and suffix.

```typst
__
page-range: S10-15  # Page S10 to 15
```

--------------------------------

### Article with Multiple Parents (Conference and Video)

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Demonstrates handling media published in multiple ways using a list for the 'parent' field. This example shows an article presented at a conference and also available as a video.

```yaml
wwdc-network:
    type: Article
    author:  ["Mehta, Jiten", "Kinnear, Eric"]
    title: Boost Performance and Security with Modern Networking
    date: 2020-06-26
    parent:
        - type: Conference
          title: World Wide Developer Conference 2020
          organization: Apple Inc.
          location: Mountain View, CA
        - type: Video
          runtime: "00:13:42"
          url: https://developer.apple.com/videos/play/wwdc2020/10111/

```

--------------------------------

### Import Package with Full Specification

Source: https://typst-community.github.io/extra-docs/print.html

Use the full package specification for imports in example files to ensure they are self-contained and compilable as is. This is a requirement for template files.

```typst
#import "@preview/my-package:1.0.0": my-function

```

```typst
#import "../lib.typ": my-function

```

--------------------------------

### Install Hayagriva CLI

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Install the Hayagriva Command Line Interface using Cargo. This command installs the CLI tool for use in your terminal.

```bash
cargo install hayagriva --features cli
```

--------------------------------

### Typst Document Configuration and Scripting Example

Source: https://typst-community.github.io/extra-docs/typst/index.html

This snippet demonstrates how to configure page settings, heading numbering, and generate dynamic content using Typst's scripting capabilities, including defining variables, functions, and creating tables.

```typst
#set page(width: 10cm, height: auto)
#set heading(numbering: "1.")

= Fibonacci sequence
The Fibonacci sequence is defined through the
recurrence relation $F_n = F_(n-1) + F_(n-2)$.
It can also be expressed in _closed form:_

$ F_n = round(1 / sqrt(5) phi.alt^n), quad
  phi.alt = (1 + sqrt(5)) / 2 $

#let count = 8
#let nums = range(1, count + 1)
#let fib(n) = (
  if n <= 2 { 1 }
  else { fib(n - 1) + fib(n - 2) }
)

The first #count numbers of the sequence are:

#align(center, table(
  columns: count,
  ..nums.map(n => $F_#n$),
  ..nums.map(n => str(fib(n))),
))
```

--------------------------------

### Correctly Handling Image Input in Typst Template

Source: https://typst-community.github.io/extra-docs/packages/resources.html

This example demonstrates the recommended approach for handling image assets in Typst templates. It accepts the image content directly as an argument, allowing for easier customization by the user.

```typst
#let cover-page(logo: image("logo.png"), title) = {
  logo
  heading(title)
}
```

--------------------------------

### Defining Private and Public Functions in a Package

Source: https://typst-community.github.io/extra-docs/packages/typst.html

This example shows how to define internal functions and expose only specific ones to the user. The `package.typ` defines both private and public functions, while `lib.typ` imports only the desired public function.

```typst
#let private(a, b) = a + b
#let public(a, b, c) = private(a, b) * private(b, c)
```

```typst
#import "package.typ": public
```

--------------------------------

### Generate References with Selector

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Use the --select argument with a custom Hayagriva selector to filter entries, for example, to include only those with a URL or DOI.

```bash
hayagriva literature.yaml --select "*[url] | *[doi]" reference
```

--------------------------------

### Filter Bibliography Entries with Selector Macro

Source: https://typst-community.github.io/extra-docs/print.html

Uses the `select!` macro to define and apply a selector to filter bibliography entries. This example filters for 'Article' type entries published in a 'journal' with a 'Periodical' parent.

```rust
__
use hayagriva::select;
use hayagriva::io::from_yaml_str;

let yaml = r#"
quantized-vortex:
    type: Article
    author: Gross, E. P.
    title: Structure of a Quantized Vortex in Boson Systems
    date: 1961-05
    page-range: 454-477
    doi: 10.1007/BF02731494
    parent:
        issue: 3
        volume: 20
        title: Il Nuovo Cimento
"#;

let entries = from_yaml_str(yaml).unwrap();
let journal = select!((Article["date"]) > ("journal":Periodical));
assert!(journal.matches(entries.nth(0).unwrap()));

```

--------------------------------

### Incorrectly Handling Image Path in Typst Template

Source: https://typst-community.github.io/extra-docs/packages/resources.html

This example shows an incorrect way to handle image paths in a Typst template. It uses a string path which can lead to issues when users try to customize the image.

```typst
#let cover-page(logo-path: "logo.png", title) = {
  image(logo-path)
  heading(title)
}
```

--------------------------------

### Timestamp Range

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Represents a range of timestamps, with the first indicating the start and the second the end. Double-quotes are necessary due to colons.

```yaml
__
time-range: "03:35:21-03:58:46"

```

--------------------------------

### Numeric Variable with Page Range

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Numeric variables can express a range using hyphens. This example shows a page range from S10 to S15.

```yaml
page-range: S10-15
```

--------------------------------

### Article in a Scientific Journal

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Example of an article published in a periodical. The 'parent' field specifies the journal details. Fields like 'title' can be used for both the article and its parent.

```yaml
kinetics:
    type: Article
    title: Kinetics and luminescence of the excitations of a nonequilibrium polariton condensate
    author: ["Doan, T. D.", "Tran Thoai, D. B.", "Haug, Hartmut"]
    serial-number:
        doi: "10.1103/PhysRevB.102.165126"
    page-range: 165126-165139
    date: 2020-10-14
    parent:
        type: Periodical
        title: Physical Review B
        volume: 102
        issue: 16
        publisher: American Physical Society

```

--------------------------------

### Typst CLI Help

Source: https://typst-community.github.io/extra-docs/print.html

Prints a list of available subcommands and options for the Typst CLI. Detailed usage for a specific subcommand can be accessed with `typst help <subcommand>`.

```bash
typst help
```

```bash
typst help watch
```

--------------------------------

### Responsive Image for Light and Dark Themes

Source: https://typst-community.github.io/extra-docs/print.html

Include this snippet in your README to display images that adapt to the user's preferred color scheme. Ensure 'example-light.png' and 'example-dark.png' are available in your package.

```html
<picture>
  <source media="(prefers-color-scheme: dark)" srcset="example-dark.png">
  <img alt="Example output" src="example-light.png">
</picture>
```

--------------------------------

### Typst CLI Help Commands

Source: https://typst-community.github.io/extra-docs/typst/index.html

Provides access to help information for the Typst CLI, including listing available subcommands and options, or displaying detailed usage for a specific subcommand.

```bash
# Prints available subcommands and options.
typst help
```

```bash
# Prints detailed usage of a subcommand.
typst help watch
```

--------------------------------

### Add Tool Configuration to Manifest

Source: https://typst-community.github.io/extra-docs/packages/manifest.html

Use the `[tool.<tool_name>]` section to attach Typst-specific configuration for third-party tools to the manifest.

```toml
[package]
# ...

[tool.mytool]
foo = "bar"

```

--------------------------------

### Build Typst CLI

Source: https://typst-community.github.io/extra-docs/typst/index.html

Clone the Typst repository and build the command-line interface (CLI) using Cargo. The optimized binary will be available in the target/release/ directory.

```bash
git clone https://github.com/typst/typst
cd typst
cargo build --release
```

--------------------------------

### YAML List Representation for Authors (Compact)

Source: https://typst-community.github.io/extra-docs/print.html

Demonstrates the compact YAML syntax for representing a list of authors using square brackets and double-quoted names.

```yaml
author: ["Omarova, Saule", "Steele, Graham"]
```

--------------------------------

### Include Images for Light and Dark Themes

Source: https://typst-community.github.io/extra-docs/packages/documentation.html

Use this HTML snippet in your README.md to include images that adapt to both light and dark themes. Specify separate image sources for each theme using the `<source>` tag with media queries.

```html
<picture>
  <source media="(prefers-color-scheme: dark)" srcset="example-dark.png">
  <img alt="Example output" src="example-light.png">
</picture>

```

--------------------------------

### Generate Template Thumbnail

Source: https://typst-community.github.io/extra-docs/packages/manifest.html

Command to compile a Typst document to a PNG thumbnail for template submissions. Adjust PPI and page count as needed.

```bash
typst compile -f png --pages 1 --ppi 250 main.typ thumbnail.png
```

--------------------------------

### Parse and Format Bibliography Entries

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Demonstrates parsing a YAML bibliography string and then formatting entries into citations and a bibliography using CSL styles and locale files.

```rust
use hayagriva::io::from_yaml_str;

let yaml = r#"
crazy-rich:
    type: Book
    title: Crazy Rich Asians
    author: Kwan, Kevin
    date: 2014
    publisher: Anchor Books
    location: New York, NY, US
"#;

// Parse a bibliography
let bib = from_yaml_str(yaml).unwrap();
assert_eq!(bib.get("crazy-rich").unwrap().date().unwrap().year, 2014);

// Format the reference
use std::fs;
use hayagriva::
    BibliographyDriver,
    BibliographyRequest,
    BufWriteFormat,
    CitationItem,
    CitationRequest,
;
use hayagriva::citationberg::{LocaleFile, IndependentStyle};

let en_locale = fs::read_to_string("tests/data/locales-en-US.xml").unwrap();
let locales = [LocaleFile::from_xml(&en_locale).unwrap().into()];

let style = fs::read_to_string("tests/data/art-history.csl").unwrap();
let style = IndependentStyle::from_xml(&style).unwrap();

let mut driver = BibliographyDriver::new();

for entry in bib.iter() {
    let items = vec![CitationItem::with_entry(entry)];
    driver.citation(CitationRequest::from_items(items, &style, &locales));
}

let result = driver.finish(BibliographyRequest {
    style: &style,
    locale: None,
    locale_files: &locales,
});

for cite in result.citations {
    println!("{}", cite.citation.to_string())
}
```

--------------------------------

### Template Package `typst.toml` Configuration

Source: https://typst-community.github.io/extra-docs/packages/manifest.html

Defines the metadata and template-specific settings for a Typst template package. Ensure `path` points to the template files and `entrypoint` specifies the main template file.

```toml
[package]
name = "charged-ieee"
version = "0.1.0"
entrypoint = "lib.typ"
authors = ["Typst GmbH <https://typst.app>"]
license = "MIT-0"
description = "IEEE-style paper to publish at conferences and journals."

[template]
path = "template"
entrypoint = "main.typ"
thumbnail = "thumbnail.png"

```

--------------------------------

### Using Relative Imports (Not Recommended)

Source: https://typst-community.github.io/extra-docs/packages/typst.html

Avoid using relative imports like this when referencing your own package, as it can lead to compilation issues if files are moved or copied.

```typst
#import "../lib.typ": my-function
```

--------------------------------

### Clone Typst Packages Repository with Sparse Checkout

Source: https://typst-community.github.io/extra-docs/packages/tips.html

Clone the Typst packages repository efficiently using sparse checkout to only include specific package directories. This reduces clone time and disk space. Ensure you have forked the repository first.

```bash
git clone --depth 1 --no-checkout --filter="tree:0" git@github.com:{your-username}/packages
cd packages
git sparse-checkout init
git sparse-checkout set packages/preview/{your-package-name}
git remote add upstream git@github.com:typst/packages
git config remote.upstream.partialclonefilter tree:0
git checkout main
```

--------------------------------

### Select by Entry Type (Macro)

Source: https://typst-community.github.io/extra-docs/print.html

Use the `select!` macro to match entries with a specific top-level type. Capitalization must match the EntryType struct variants exactly.

```macro
Thesis
```

--------------------------------

### Generate Reference List with APA Style

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Generate a reference list using the American Psychological Association (APA) style by specifying the --style argument.

```bash
hayagriva literature.yaml reference --style apa
```

--------------------------------

### Runtime

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Indicates the total runtime of an item, such as a video or audio file. Formatted as a timestamp.

```yaml
runtime: 01:42:21,802
```

--------------------------------

### Select by Entry Type (String)

Source: https://typst-community.github.io/extra-docs/print.html

Use a string selector to match entries with a specific top-level type. This selector is case-insensitive.

```string
thesis
```

--------------------------------

### Use Selector Macro for Filtering Entries

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Demonstrates using the `select!` macro to parse and apply a selector to filter bibliography entries, matching articles published in a journal.

```rust
use hayagriva::select;
use hayagriva::io::from_yaml_str;

let yaml = r#"
quantized-vortex:
    type: Article
    author: Gross, E. P.
    title: Structure of a Quantized Vortex in Boson Systems
    date: 1961-05
    page-range: 454-477
    doi: 10.1007/BF02731494
    parent:
        issue: 3
        volume: 20
        title: Il Nuovo Cimento
"#;

let entries = from_yaml_str(yaml).unwrap();
let journal = select!((Article["date"]) > ("journal":Periodical));
assert!(journal.matches(entries.nth(0).unwrap()));
```

--------------------------------

### Compile Typst Document

Source: https://typst-community.github.io/extra-docs/typst/index.html

Compiles a Typst source file into a PDF document in the working directory.

```bash
# Creates `file.pdf` in working directory.
typst compile file.typ
```

```bash
# Creates a PDF file at the desired path.
typst compile path/to/source.typ path/to/output.pdf
```

--------------------------------

### Generate Reference List

Source: https://typst-community.github.io/extra-docs/print.html

Generates a reference list from a YAML literature file. Defaults to Chicago Manual of Style (17th edition).

```bash
hayagriva literature.yaml reference
```

--------------------------------

### Importing Own Package with Full Specification

Source: https://typst-community.github.io/extra-docs/packages/typst.html

Use the full package specification for imports when referencing your own package to ensure files can be copied and compiled independently. This avoids issues with relative import paths.

```typst
#import "@preview/my-package:1.0.0": my-function
```

--------------------------------

### Compact YAML Composite Data for URL

Source: https://typst-community.github.io/extra-docs/print.html

Presents a compact, JSON-like syntax for representing composite data for a URL field.

```yaml
url: { value: http://www.techno.org/electronic-music-guide/, date: 2020-11-30 }
```

--------------------------------

### YAML Composite Data for URL with Date

Source: https://typst-community.github.io/extra-docs/print.html

Illustrates how to represent composite data for a URL field, including its value and an associated date.

```yaml
url:
    value: http://www.techno.org/electronic-music-guide/
    date: 2020-11-30
```

--------------------------------

### YAML List Representation for Authors (Verbose)

Source: https://typst-community.github.io/extra-docs/print.html

Shows the verbose YAML syntax for lists, where each item is on a new indented line preceded by a hyphen.

```yaml
author:
    - Omarova, Saule
    - Steele, Graham
```

--------------------------------

### Manage Typst Font Paths

Source: https://typst-community.github.io/extra-docs/typst/index.html

Allows specifying custom directories for Typst to search for fonts during compilation or when listing available fonts. Can be set via command-line flag or environment variable.

```bash
# Adds additional directories to search for fonts.
typst compile --font-path path/to/fonts file.typ
```

```bash
# Lists all of the discovered fonts in the system and the given directory.
typst fonts --font-path path/to/fonts
```

```bash
# Or via environment variable (Linux syntax).
TYPST_FONT_PATHS=path/to/fonts typst fonts
```

--------------------------------

### Apache License 2.0 Boilerplate

Source: https://typst-community.github.io/extra-docs/license/hayagriva/LICENSE-APACHE.html

Boilerplate notice to be included when applying the Apache License to your work. Replace bracketed fields with your project's information.

```text
Copyright [YYYY] [Your Name/Organization]
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://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.
```

--------------------------------

### Parse YAML Bibliography and Format Reference

Source: https://typst-community.github.io/extra-docs/print.html

Parses a bibliography from a YAML string and demonstrates formatting a reference using CSL styles and locales. Requires `hayagriva` crate with default features.

```rust
__
use hayagriva::io::from_yaml_str;

let yaml = r#"
crazy-rich:
    type: Book
    title: Crazy Rich Asians
    author: Kwan, Kevin
    date: 2014
    publisher: Anchor Books
    location: New York, NY, US
"#;

// Parse a bibliography
let bib = from_yaml_str(yaml).unwrap();
assert_eq!(bib.get("crazy-rich").unwrap().date().unwrap().year, 2014);

// Format the reference
use std::fs;
use hayagriva::{
    BibliographyDriver,
    BibliographyRequest,
    BufWriteFormat,
    CitationItem,
    CitationRequest,
};
use hayagriva::citationberg::{LocaleFile, IndependentStyle};

let en_locale = fs::read_to_string("tests/data/locales-en-US.xml").unwrap();
let locales = [LocaleFile::from_xml(&en_locale).unwrap().into()];

let style = fs::read_to_string("tests/data/art-history.csl").unwrap();
let style = IndependentStyle::from_xml(&style).unwrap();

let mut driver = BibliographyDriver::new();

for entry in bib.iter() {
    let items = vec![CitationItem::with_entry(entry)];
    driver.citation(CitationRequest::from_items(items, &style, &locales));
}

let result = driver.finish(BibliographyRequest {
    style: &style,
    locale: None,
    locale_files: &locales,
});

for cite in result.citations {
    println!("{}", cite.citation.to_string())
}

```

--------------------------------

### Generate Reference List

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Generate a reference list from a YAML literature file. Defaults to the Chicago Manual of Style (17th edition) Author-Date style.

```yaml
dependence:
    type: Article
    title: The program dependence graph and its use in optimization
    author: ["Ferrante, Jeanne", "Ottenstein, Karl J.", "Warren, Joe D."]
    date: 1987-07
    serial-number:
        doi: "10.1145/24039.24041"
    parent:
        type: Periodical
        title: ACM Transactions on Programming Languages and Systems
        volume: 9
        issue: 3

feminism:
    type: Article
    title: She swoons to conquer
    author: Ungard-Sargon, Batya
    editor: Weintraub, Pam
    date: 2015-09-25
    url: https://aeon.co/essays/can-you-enjoy-romance-fiction-and-be-a-feminist
    parent:
        type: Blog
        title: Aeon
```

```bash
hayagriva literature.yaml reference
```

--------------------------------

### Compile Typst File

Source: https://typst-community.github.io/extra-docs/print.html

Compiles a Typst source file into a PDF. You can specify an output path for the generated PDF.

```bash
typst compile file.typ
```

```bash
typst compile path/to/source.typ path/to/output.pdf
```

--------------------------------

### Apache License 2.0 URL

Source: https://typst-community.github.io/extra-docs/license/hayagriva/LICENSE-APACHE.html

The official URL for obtaining a copy of the Apache License, Version 2.0.

```text
http://www.apache.org/licenses/LICENSE-2.0
```

--------------------------------

### Formattable String with Short Form

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Includes a 'short' form that a citation style can optionally render instead of the 'value'.

```yaml
__
journal:
    value: International Proceedings of Customs
    short: Int. Proc. Customs

```

--------------------------------

### Canonical URL with Access Date

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Provides the main public URL for an item. Optionally, an access date can be included to specify when the URL was last verified.

```yaml
url: { value: https://www.reddit.com/r/AccidentalRenaissance/comments/er1uxd/japanese_opposition_members_trying_to_block_the/, date: 2020-12-29 }
```

--------------------------------

### LLVM Exceptions to Apache 2.0 License

Source: https://typst-community.github.io/extra-docs/license/typst/NOTICE.html

These exceptions allow for redistribution of embedded portions in object form and provide flexibility when combining with GPLv2 licensed software.

```text
–– LLVM Exceptions to the Apache 2.0 License ––
As an exception, if, as a result of your compiling your source code, portions of this Software are embedded into an Object form of such source code, you may redistribute such embedded portions in such Object form without complying with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
In addition, if you combine or link compiled forms of this Software with software that is licensed under the GPLv2 (“Combined Software”) and if a court of competent jurisdiction determines that the patent provision (Section 3), the indemnity provision (Section 9) or other Section of the License conflicts with the conditions of the GPLv2, you may retroactively and prospectively choose to deem waived or otherwise exclude such Section(s) of the License, but only in their entirety and only with respect to the Combined Software.
```

--------------------------------

### Manage Typst Fonts

Source: https://typst-community.github.io/extra-docs/print.html

Allows specifying additional directories for Typst to search for fonts during compilation or listing all discovered fonts. Font paths can be provided via command-line arguments or environment variables.

```bash
typst compile --font-path path/to/fonts file.typ
```

```bash
typst fonts --font-path path/to/fonts
```

```bash
TYPST_FONT_PATHS=path/to/fonts typst fonts
```

--------------------------------

### Convert BibLaTeX Entry to Hayagriva Entry

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Shows how to convert a BibLaTeX entry into Hayagriva's native `Entry` struct if BibLaTeX compatibility is needed.

```rust
use hayagriva::Entry;
let converted: Entry = your_biblatex_entry.into();
```

--------------------------------

### Show Bound Sub-Entries with Selector

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Use the --show-bound flag with a selector to explore which values were bound to which sub-entries, useful for debugging selectors.

```bash
hayagriva literature.yaml --select "a:*[volume] | * > a:[volume]" --show-bound
```

--------------------------------

### Annotation or Note

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

A short markup, decoration, or annotation for the item. Useful for adding brief remarks, such as indicating inclusion in a review.

```yaml
note: microfilm version
```

--------------------------------

### Export Public Functions in Typst Package

Source: https://typst-community.github.io/extra-docs/print.html

Manage public and private bindings by importing only the desired functions into the package entrypoint file (e.g., lib.typ). This prevents users from accessing internal functions.

```typst
#let private(a, b) = a + b
#let public(a, b, c) = private(a, b) * private(b, c)

```

```typst
#import "package.typ": public

```

--------------------------------

### Multiple Authors in YAML Array

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Shows how to represent an author field with multiple creators using a YAML array. This can be done in a compact form with square brackets or a more verbose hyphen-prefixed list.

```yaml
author: ["Omarova, Saule", "Steele, Graham"]
```

```yaml
author:
    - Omarova, Saule
    - Steele, Graham
```

--------------------------------

### Convert BibTeX to YAML

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Convert a BibTeX file to YAML format by passing the .bib file to the CLI. The output is shown on standard output and can be redirected to a file.

```bash
hayagriva literature.bib > converted.yaml
```

--------------------------------

### Composite Data for URL Field

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Demonstrates how the 'url' field can accept composite data, including a value and an access date. This is shown in both a standard indented YAML format and a compact JSON-like format.

```yaml
url:
    value: http://www.techno.org/electronic-music-guide/
    date: 2020-11-30
```

```yaml
url: { value: http://www.techno.org/electronic-music-guide/, date: 2020-11-30 }
```

--------------------------------

### Watch Typst Files for Changes

Source: https://typst-community.github.io/extra-docs/typst/index.html

Watches Typst source files for modifications and automatically recompiles them. This leverages Typst's incremental compilation for faster updates.

```bash
# Watches source files and recompiles on changes.
typst watch file.typ
```

--------------------------------

### Total Pages

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Indicates the total number of pages an item contains. This should be a numeric value.

```yaml
page-total: 1103
```

--------------------------------

### Formattable String with Braces

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Preserves a part of the string while allowing other parts to follow style transformations by enclosing the string in braces.

```yaml
__
publisher: "{imagiNary} Publishing"

```

--------------------------------

### Edition Information

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Describes the edition of a published item. This can be a simple string indicating the type of edition.

```yaml
edition: expanded and revised edition
```

--------------------------------

### Apache License Version 2.0

Source: https://typst-community.github.io/extra-docs/print.html

The Apache License, Version 2.0, provides terms and conditions for the use, reproduction, and distribution of software and other works.

```plaintext
__
                          Apache License
                    Version 2.0, January 2004
                 http://www.apache.org/licenses/


```

```plaintext
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  1. Definitions.
“License” shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
“Licensor” shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
“Legal Entity” shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, “control” means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
“You” (or “Your”) shall mean an individual or Legal Entity exercising permissions granted by this License.
“Source” form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
“Object” form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
“Work” shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
“Derivative Works” shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
“Contribution” shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, “submitted” means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as “Not a Contribution.”
“Contributor” shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
  2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

```

--------------------------------

### Item Title Field

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Provides the title of the item. This field accepts a formattable string.

```yaml
title: "Rick Astley: How An Internet Joke Revived My Career"
```

--------------------------------

### Page Range

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Defines the range of pages an item occupies within its parent document or work. Can be a string.

```yaml
page-range: 812-847
```

--------------------------------

### Standalone Parent with Nested Parents

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Illustrates how parent entries can be standalone and have their own parents, useful for hierarchical structures like artworks belonging to an anthology archived in a museum.

```yaml
plaque:
    type: Misc
    title: Informational plaque about Jacoby's 1967 photos
    publisher:
        name: Stiftung Reinbeckhallen
        location: Berlin, Germany
    date: 2020
    parent:
        type: Artwork
        date: 1967
        author: Jacoby, Max
        parent:
            type: Anthology
            title: Bleibtreustraße
            archive: Landesmuseum Koblenz
            archive-location: Koblenz, Germany

```

--------------------------------

### Disjunction (OR) Selector in Typst

Source: https://typst-community.github.io/extra-docs/hayagriva/selectors.html

Combine multiple selectors with the pipe '|' operator to match entries that satisfy any of the alternatives.

```typst
anthology | *[volume]

```

```typst
Anthology | (*["volume"])

```

```typst
(video | audio | web[runtime])[affiliated]

```

```typst
(Video | Audio | (Web["runtime"]))["affiliated"]

```

--------------------------------

### Publisher Information

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Indicates the publisher of an item. Can be a simple name or a more detailed object including the publisher's name and location.

```yaml
publisher: Penguin Books
```

```yaml
publisher:
    name: Penguin Books
    location: London
```

--------------------------------

### Abstract Field

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Contains the abstract of the item, such as the abstract of a journal article. Accepts formattable strings.

```yaml
abstract: The dominant sequence transduction models are based on complex...
```

--------------------------------

### Total Volumes

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Indicates the total number of volumes, parts, or seasons an item comprises. This should be a numeric value.

```yaml
volume-total: 12
```

--------------------------------

### Entry Type Field

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies the media type of an item, which often determines the structure of references. Use for categorizing content.

```yaml
type: video
```

--------------------------------

### Disjunction (OR) Operator

Source: https://typst-community.github.io/extra-docs/print.html

Use the disjunction operator '|' to offer multiple alternative selectors, where only one needs to be matched.

```typst
anthology | *[volume]
```

```typst
Anthology | (*["volume"])
```

```typst
(video | audio | web[runtime])[affiliated]
```

```typst
(Video | Audio | (Web["runtime"]))["affiliated"]
```

--------------------------------

### Unicode Language Identifier with Script and Region

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

More precise identification can be achieved by including script and region codes, like Mandarin in simplified script for mainland China.

```yaml
language: zh-Hans-CN
```

--------------------------------

### Basic Literature Item Representation

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Defines two literature items, a book and a web page, using key-value pairs for their properties. Each item has a type, title, author, and other specific fields.

```yaml
harry:
    type: Book
    title: Harry Potter and the Order of the Phoenix
    author: Rowling, J. K.
    volume: 5
    page-total: 768
    date: 2003-06-21

electronic:
    type: Web
    title: Ishkur's Guide to Electronic Music
    serial-number: v2.5
    author: Ishkur
    url: http://www.techno.org/electronic-music-guide/
```

--------------------------------

### Author Field

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Lists the person or persons primarily responsible for the creation of the item. Can be a single person or a list.

```yaml
author: ["Klocke, Iny", "Wohlrath, Elmar"]
```

--------------------------------

### Configure Hayagriva without Default Features

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Illustrates how to modify `Cargo.toml` to disable default features for Hayagriva, useful if BibLaTeX compatibility is not required.

```toml
[dependencies]
hayagriva = { version = "0.9", default-features = false }
```

--------------------------------

### Numeric Variable with Affix as String

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

If a number includes a non-numeric affix, the entire variable is treated as a string. This is useful for atypical page numbers.

```yaml
atypical-page-number: 11E201
```

--------------------------------

### Volume Range

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies the range of volumes, parts, or seasons an item belongs to. Can be represented as a string.

```yaml
volume: 2-3
```

--------------------------------

### Archive Name

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Indicates the name of the institution or collection where the item is housed.

```yaml
archive: National Library of New Zealand
```

--------------------------------

### Generate In-Text Citation

Source: https://typst-community.github.io/extra-docs/hayagriva/index.html

Generate an in-text citation for a specific entry using the --key argument. Multiple keys can be provided as a comma-separated list.

```bash
hayagriva literature.yaml cite --key feminism
```

--------------------------------

### Verbatim Formattable String

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Disables all formatting and preserves the exact casing of the source string by using the 'value' and 'verbatim: true' sub-fields.

```yaml
__
publisher:
    value: UN World Food Programme
    verbatim: true

```

--------------------------------

### Filter Entries by Fields

Source: https://typst-community.github.io/extra-docs/print.html

Use the fields selector to filter entries that have specific fields set. All specified fields must contain a value for the selector to match.

```typst
artwork[archive, archive-location]
```

```typst
Artwork["archive", "archive-location"]
```

--------------------------------

### Person with Sub-fields

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies a person using sub-fields for 'name', 'given-name', and 'alias'. The 'name' field is required.

```yaml
__
author:
    given-name: Gloria Jean
    name: Watkins
    alias: bell hooks

```

--------------------------------

### Publication Date Field

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Indicates the date at which the item was published. Accepts date formats.

```yaml
date: 1949-05
```

--------------------------------

### Serial Number with Standard Identifiers

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Used for any serial number, including article numbers. Supports standard identifiers like DOI, ISBN, ISSN, PMID, PMCID, and ArXiv, which Hayagriva recognizes and processes specially. A general 'serial' key can also be included.

```yaml
serial-number: 2003.13722
```

```yaml
serial-number:
    doi: “10.22541/au.148771883.35456290”
    arxiv: “1906.00356”
    serial: “8516”
```

--------------------------------

### Negation Selector in Typst

Source: https://typst-community.github.io/extra-docs/hayagriva/selectors.html

Select entries that do not match a given selector using the exclamation mark prefix.

```typst
!article

```

```typst
!Article

```

--------------------------------

### Time Range

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies a time range within a parent item that the current item occupies. Formatted as a timestamp range.

```yaml
time-range: 00:57-06:21
```

--------------------------------

### Organization of Production

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Identifies the organization for which or at which the item was produced.

```yaml
organization: Technische Universität Berlin
```

--------------------------------

### Simple Unicode Language Identifier

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

A basic Unicode Language Identifier uses a two-letter ISO 639-1 code.

```yaml
language: en
```

--------------------------------

### Genre Field

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Defines the type, class, or subtype of the item. Use for specific classifications like 'Doctoral dissertation', not topical categories.

```yaml
genre: Doctoral dissertation
```

--------------------------------

### Wildcard Selector in Typst

Source: https://typst-community.github.io/extra-docs/hayagriva/selectors.html

The wildcard selector '*' applies to every entry. It is often used in combination with other selectors.

```typst
*

```

--------------------------------

### Language Identifier

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies the language of the item using a Unicode language identifier.

```yaml
language: zh-Hans
```

--------------------------------

### Names and Role Data Type

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Defines a data type requiring a 'names' list (of persons or a single person) and a 'role' field specifying their function.

```yaml
__
role: ExecutiveProducer
names: ["Simon, David", "Colesberry, Robert F.", "Noble, Nina Kostroff"]

```

--------------------------------

### Affiliated Persons with Roles

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Use to list individuals involved with an item who do not fit the author or editor roles. Supports specifying roles and names, with names being a comma-separated string or a list.

```yaml
affiliated:
    - role: Director
      names: Cameron, James
    - role: CastMember
      names: [“Schwarzenegger, Arnold”, “Hamilton, Linda”, “Patrick, Robert”]
```

--------------------------------

### Chapter Number

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies the chapter number within a larger work. If the chapter itself is the primary item, consider using `type: chapter`.

```yaml
chapter: 4
```

--------------------------------

### String with Single Quotes

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Wrapping a string in single quotes ignores most YAML escape sequences, such as \n for newlines.

```yaml
single-quoted-string: 'this string will not interpret \n as a newline'
```

--------------------------------

### Parent Entry Field

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies the item in which the current item was published or to which it is strongly associated. Supports nested structures.

```yaml
parent:
    type: Anthology
    title: Automata studies
    editor: [“Shannon, C. E.”, “McCarthy, J.”]
```

--------------------------------

### Unicode Language Identifier with Region

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specify regions using all-caps ISO 3166-1 alpha_2 codes to identify language variants, such as American English.

```yaml
language: en-US
```

--------------------------------

### Item Location

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies the physical location where an item is kept or where an event took place. This is distinct from the publication location.

```yaml
location: Lahore, Pakistan
```

--------------------------------

### Archive Location

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies the physical location of the institution or collection where the item is kept.

```yaml
archive-location: Wellington, New Zealand
```

--------------------------------

### Affiliated Persons with Roles

Source: https://typst-community.github.io/extra-docs/print.html

Use 'affiliated' to list persons involved with an item who do not fit the 'author' or 'editor' roles. It accepts a list of roles and associated names.

```yaml
affiliated:
    - role: Director
      names: Cameron, James
    - role: CastMember
      names: [“Schwarzenegger, Arnold”, “Hamilton, Linda”, “Patrick, Robert”]  
```

--------------------------------

### Require Parent Match

Source: https://typst-community.github.io/extra-docs/print.html

Use the '>' operator to require that a parent entry matches a specific selector. This operator can be chained to examine nested parents.

```typst
article > proceedings
```

```typst
Article > Proceedings
```

```typst
chapter > (book | anthology) > (book | anthology)
```

```typst
Chapter > (Book | Anthology) > (Book | Anthology)
```

--------------------------------

### Editor Field

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Lists the persons responsible for selecting and revising the content of the item. Can be a list of names.

```yaml
editor:
    - Stringer, Gary A.
    - Pebworth, Ted-Larry
```

--------------------------------

### Fields Selector in Typst

Source: https://typst-community.github.io/extra-docs/hayagriva/selectors.html

Filter entries based on whether specific fields are set using square brackets. All specified fields must have a value for the selector to match.

```typst
artwork[archive, archive-location]

```

```typst
Artwork["archive", "archive-location"]

```

--------------------------------

### String with Escaped Double Quotes

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

To include double quotes within a double-quoted string, use the escape sequence \".

```yaml
quoted-string: "this string contains \"escaped\" double quotes"
```

--------------------------------

### String with Special Characters

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Strings containing special characters must be wrapped in double quotes. Special characters include :, {, }, [, ], ,, &, *, #, ?, |, -, <, >, =, !, %, @, \. Use \" to escape double quotes within a quoted string.

```yaml
special-key: "this string contains a : colon and a [ bracket"
```

--------------------------------

### Issue Number

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Indicates the specific issue number for items that have multiple issues, such as periodicals or TV episodes. Can be numeric or a string.

```yaml
issue: 5
```

--------------------------------

### Library Call Number

Source: https://typst-community.github.io/extra-docs/hayagriva/file-format.html

Specifies the call number for an item within a library or collection. This field is often used in conjunction with the 'archive' field.

```yaml
call-number: "F16 D14"
```
Tokens:
Raw