Struct BibliographyElem

pub struct BibliographyElem {
    pub path: BibliographyPaths,
    pub bibliography: Bibliography,
    /* private fields */
}

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 .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

path: BibliographyPaths

bibliography: Bibliography

Implementations

impl BibliographyElem

pub fn new(path: BibliographyPaths, bibliography: Bibliography) -> Self

Create a new instance of the element.

pub fn with_path(self, path: BibliographyPaths) -> Self

Builder-style setter for the path field.

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: CslStyle) -> Self

Builder-style setter for the style field.

pub fn with_bibliography(self, bibliography: Bibliography) -> Self

Builder-style setter for the bibliography 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.

pub fn push_path(&mut self, path: BibliographyPaths)

Setter for the path field.

pub fn push_title(&mut self, title: Smart<Option<Content>>)

Setter for the title field.

pub fn push_full(&mut self, full: bool)

Setter for the full field.

pub fn push_style(&mut self, style: CslStyle)

Setter for the style field.

pub fn push_bibliography(&mut self, bibliography: Bibliography)

Setter for the bibliography field.

pub fn push_lang(&mut self, lang: Lang)

Setter for the lang field.

pub fn push_region(&mut self, region: Option<Region>)

Setter for the region field.

pub fn path(&self) -> &BibliographyPaths

Path(s) to Hayagriva .yml and/or BibLaTeX .bib files.

pub fn title(&self, styles: StyleChain<'_>) -> Smart<Option<Content>>

The title of the bibliography.

• When set to {auto}, an appropriate title for the text language will be used. This is the default.
• When set to {none}, the bibliography will not have a title.
• A custom title can be set by passing content.

The bibliography’s heading will not be numbered by default, but you can force it to be with a show-set rule: {show bibliography: set heading(numbering: "1.")}

pub fn full(&self, styles: StyleChain<'_>) -> bool

Whether to include all works from the given bibliography files, even those that weren’t cited in the document.

To selectively add individual cited works without showing them, you can also use the cite function with form set to {none}.

pub fn style(&self, styles: StyleChain<'_>) -> CslStyle

The bibliography style.

Should be either one of the built-in styles (see below) or a path to a CSL file. Some of the styles listed below appear twice, once with their full name and once with a short alias.

pub fn bibliography(&self) -> &Bibliography

The loaded bibliography.

pub fn lang(&self) -> Option<&Lang>

The language setting where the bibliography is.

pub fn region(&self) -> Option<&Option<Region>>

The region setting where the bibliography is.

pub fn title_in(styles: StyleChain<'_>) -> Smart<Option<Content>>

Access the title field in the given style chain.

pub fn full_in(styles: StyleChain<'_>) -> bool

Access the full field in the given style chain.

pub fn style_in(styles: StyleChain<'_>) -> CslStyle

Access the style field in the given style chain.

pub fn set_title(title: Smart<Option<Content>>) -> Property

Create a style property for the title field.

pub fn set_full(full: bool) -> Property

Create a style property for the full field.

pub fn set_style(style: CslStyle) -> Property

Create a style property for the style field.

impl BibliographyElem

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

Find the document’s bibliography.

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

Whether the bibliography contains the given key.

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

Find all bibliography keys.

Trait Implementations

impl Capable for BibliographyElem

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for BibliographyElem

fn clone(&self) -> BibliographyElem

Returns a copy 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 Fields for BibliographyElem

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

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 IntoValue for BibliographyElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for BibliographyElem

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for BibliographyElem

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Repr for BibliographyElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for BibliographyElem

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

Parse relevant arguments into style properties for this element.