Skip to content

Typst: Front matter

Outline

#import "@preview/lepub:1.0.0": *
#show: lepub.with(
  frontmatter: (
    title: string,
    subtitle: string,
    short-title: string,
    keywords: (),
    abstract: (
        (
            title: string,
            content: string
        ),
    ),
    authors: (
        (
            name: string
            orcid: string
            email: string
            url: string
            roles: array
            degrees: array
            affiliations: (
                (
                    id: string
                    index: int
                ),
            )
        ),
    ),
    affiliations: (
        (
            id: string,
            index: int,
            name: string,
            institution: string,
        ),
    ),
    open-access: string,
    license: (
        (
            id: string,
            url: string,
            name: string,
        ),
    ),
    doi: string,
    funding: (
        (
            source: string
            investigator: (
                (
                    ref: 
                ),
            ),
        ),
    ),
    part-acknowledgments: string,
    bibliography: string
  )
)

Parameters

abstract

Type: string | dictionary
Aliases: abstracts
Description: The document's abstract(s). When the content is provided directly to abstract, the title is Abstract by default.
Properties:

Property Type Description Default
title string The title of the abstract "Abstract"
content string The content/body of the abstract none

affiliations

Type: string | dictionary
Aliases: affiliation
Description: Institutional affiliations. When the content is provided directly to affiliation, it is provided to name by default.
Properties:

Property Type Description Default
id string Unique identifier for the affiliation none
index int Numeric index for the affiliation none
name string Name of the affiliation none
institution string Institution name (use either name or institution) none

authors

Type: array<object> | string
Aliases: author
Description: Document authors. Simple strings are converted to ((name: string),).
Properties:

Property Type Description Default
name string Author's name none
url string Author's website (aliases: website, homepage) none
email string Author's email address none
phone string Author's phone number none
fax string Author's fax number none
orcid string ORCID identifier (alias: ORCID) none
note string Additional notes about the author none
corresponding boolean Whether this is the corresponding author true when email set
equal-contributor boolean Equal contribution indicator (aliases: equalContributor, equal_contributor) none
deceased boolean Whether the author is deceased none
roles array<string> Contributor roles (must be valid contributor roles) none
affiliations array<object> Author's affiliations (aliases: affiliation) none

citation

Type: string
Description: Citation information for the document.

date

Type: datetime
Description: Publication date. Validates from 'YYYY-MM-DD' if provided as a string.

doi

Type: string
Description: Digital Object Identifier. Must be only the ID, not the full URL.

keywords

Type: array
Description: Keywords to be listed underneath the abstract.

license

Type: object
Description: License information. Can be set with a SPDX ID for Creative Commons.
Properties:

Property Type Description Default
id string License identifier (e.g., SPDX ID) none
url string URL to the license text none
name string Human-readable license name none

open-access

Type: boolean
Description: Whether the document is open access.

short-title

Type: string
Aliases: running-title, running-head
Description: Short version of the title for running headers.

subtitle

Type: string
Description: Document subtitle.

title

Type: string
Description: Document title.