Struct BibliographyElem 

pub struct BibliographyElem {
    pub sources: Derived<OneOrMultiple<DataSource>, Bibliography>,
    pub title: Settable<Self, 1u8>,
    pub full: Settable<Self, 2u8>,
    pub style: Settable<Self, 3u8>,
    pub lang: Option<Lang>,
    pub region: Option<Option<Region>>,
}

A bibliography / reference listing.

You can create a new bibliography by calling this function with a path to a bibliography file in either one of two formats:

• A Hayagriva .yaml/.yml file. Hayagriva is a new bibliography file format designed for use with Typst. Visit its documentation for more details.
• A BibLaTeX .bib file.

As soon as you add a bibliography somewhere in your document, you can start citing things with reference syntax ([@key]) or explicit calls to the citation function ([#cite(<key>)]). The bibliography will only show entries for works that were referenced in the document.

Styles

Typst offers a wide selection of built-in citation and bibliography styles. Beyond those, you can add and use custom CSL (Citation Style Language) files. Wondering which style to use? Here are some good defaults based on what discipline you’re working in:

Fields	Typical Styles
Engineering, IT	{"ieee"}
Psychology, Life Sciences	{"apa"}
Social sciences	{"chicago-author-date"}
Humanities	{"mla"}, {"chicago-notes"}, {"harvard-cite-them-right"}
Economics	{"harvard-cite-them-right"}
Physics	{"american-physics-society"}

Example

This was already noted by
pirates long ago. @arrgh

Multiple sources say ...
@arrgh @netwok.

#bibliography("works.bib")

Fields

sources: Derived<OneOrMultiple<DataSource>, Bibliography>

title: Settable<Self, 1u8>

full: Settable<Self, 2u8>

style: Settable<Self, 3u8>

lang: Option<Lang>

region: Option<Option<Region>>

Implementations

impl BibliographyElem

pub fn new(sources: Derived<OneOrMultiple<DataSource>, Bibliography>) -> Self

Create a new instance of the element.

pub fn with_title(self, title: Smart<Option<Content>>) -> Self

Builder-style setter for the title field.

pub fn with_full(self, full: bool) -> Self

Builder-style setter for the full field.

pub fn with_style(self, style: Derived<CslSource, CslStyle>) -> Self

Builder-style setter for the style field.

pub fn with_lang(self, lang: Lang) -> Self

Builder-style setter for the lang field.

pub fn with_region(self, region: Option<Region>) -> Self

Builder-style setter for the region field.

impl BibliographyElem

pub const sources: Field<Self, 0u8>

pub const title: Field<Self, 1u8>

pub const full: Field<Self, 2u8>

pub const style: Field<Self, 3u8>

pub const lang: Field<Self, 4u8>

pub const region: Field<Self, 5u8>

impl BibliographyElem

pub fn find(introspector: Tracked<'_, Introspector>) -> StrResult<Packed<Self>>

Find the document’s bibliography.

pub fn has(engine: &Engine<'_>, key: Label) -> bool

Whether the bibliography contains the given key.

pub fn keys( introspector: Tracked<'_, Introspector>, ) -> Vec<(Label, Option<EcoString>)>

Find all bibliography keys.

Trait Implementations

impl Clone for BibliographyElem

fn clone(&self) -> BibliographyElem

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Construct for BibliographyElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for BibliographyElem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for BibliographyElem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl NativeElement for BibliographyElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl RequiredField<0> for BibliographyElem

const FIELD: RequiredFieldData<Self, 0u8>

type Type = Derived<OneOrMultiple<DataSource>, Bibliography>

impl Set for BibliographyElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.

impl SettableField<1> for BibliographyElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = Smart<Option<Content>>

impl SettableField<2> for BibliographyElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = bool

impl SettableField<3> for BibliographyElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = Derived<CslSource, CslStyle>

impl SynthesizedField<4> for BibliographyElem

const FIELD: SynthesizedFieldData<Self, 4u8>

type Type = Lang

impl SynthesizedField<5> for BibliographyElem

const FIELD: SynthesizedFieldData<Self, 5u8>

type Type = Option<Region>

impl RefableProperty<1> for BibliographyElem

impl RefableProperty<2> for BibliographyElem

impl RefableProperty<3> for BibliographyElem