Struct CiteElem

pub struct CiteElem {
    pub key: Label,
    /* private fields */
}

Cite a work from the bibliography.

Before you starting citing, you need to add a [bibliography] somewhere in your document.

Example

This was already noted by
pirates long ago. @arrgh

Multiple sources say ...
@arrgh @netwok.

You can also call `cite`
explicitly. #cite(<arrgh>)

#bibliography("works.bib")

If your source name contains certain characters such as slashes, which are not recognized by the <> syntax, you can explicitly call label instead.

Computer Modern is an example of a modernist serif typeface.
#cite(label("DBLP:books/lib/Knuth86a")).
>>> #bibliography("works.bib")

Syntax

This function indirectly has dedicated syntax. References can be used to cite works from the bibliography. The label then corresponds to the citation key.

Fields

key: Label

Implementations

impl CiteElem

pub fn new(key: Label) -> Self

Create a new instance of the element.

pub fn with_supplement(self, supplement: Option<Content>) -> Self

Builder-style setter for the supplement field.

pub fn with_form(self, form: Option<CitationForm>) -> Self

Builder-style setter for the form field.

pub fn with_style(self, style: Smart<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.

pub fn push_supplement(&mut self, supplement: Option<Content>)

Setter for the supplement field.

pub fn push_form(&mut self, form: Option<CitationForm>)

Setter for the form field.

pub fn push_style(&mut self, style: Smart<Derived<CslSource, CslStyle>>)

Setter for the style 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 supplement(&self, styles: StyleChain<'_>) -> Option<Content>

A supplement for the citation such as page or chapter number.

In reference syntax, the supplement can be added in square brackets:

This has been proven. @distress[p.~7]

#bibliography("works.bib")

pub fn form(&self, styles: StyleChain<'_>) -> Option<CitationForm>

The kind of citation to produce. Different forms are useful in different scenarios: A normal citation is useful as a source at the end of a sentence, while a “prose” citation is more suitable for inclusion in the flow of text.

If set to {none}, the cited work is included in the bibliography, but nothing will be displayed.

#cite(<netwok>, form: "prose")
show the outsized effects of
pirate life on the human psyche.
>>> #set text(0pt)
>>> #bibliography("works.bib", style: "apa")

pub fn style<'a>( &'a self, styles: StyleChain<'a>, ) -> &'a Smart<Derived<CslSource, CslStyle>>

The citation style.

This can be:

• {auto} to automatically use the bibliography’s style for citations.
• A string with the name of one of the built-in styles (see below). Some of the styles listed below appear twice, once with their full name and once with a short alias.
• A path string to a CSL file. For more details about paths, see the Paths section.
• Raw bytes from which a CSL style should be decoded.

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

The text language setting where the citation is.

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

The text region setting where the citation is.

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

Access the supplement field in the given style chain.

pub fn form_in(styles: StyleChain<'_>) -> Option<CitationForm>

Access the form field in the given style chain.

pub fn style_in(styles: StyleChain<'_>) -> &Smart<Derived<CslSource, CslStyle>>

Access the style field in the given style chain.

pub fn set_supplement(supplement: Option<Content>) -> Property

Create a style property for the supplement field.

pub fn set_form(form: Option<CitationForm>) -> Property

Create a style property for the form field.

pub fn set_style(style: Smart<Derived<CslSource, CslStyle>>) -> Property

Create a style property for the style field.

Trait Implementations

impl Capable for CiteElem

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

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

impl Clone for CiteElem

fn clone(&self) -> CiteElem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Construct for CiteElem

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

Construct an element from the arguments.

impl Debug for CiteElem

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

Formats the value using the given formatter.

impl Fields for CiteElem

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 FromValue for CiteElem

fn from_value(value: Value) -> HintedStrResult<Self>

Try to cast the value into an instance of Self.

impl Hash for CiteElem

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 CiteElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for CiteElem

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 CiteElem

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 Reflect for CiteElem

fn input() -> CastInfo

Describe what can be cast into this value.

fn output() -> CastInfo

Describe what this value can be cast into.

fn castable(value: &Value) -> bool

Whether the given value can be converted to T.

fn error(found: &Value) -> HintedString

Produce an error message for an unacceptable value type.

impl Repr for CiteElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for CiteElem

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

Parse relevant arguments into style properties for this element.