Struct CiteElem 

pub struct CiteElem {
    pub key: Label,
    pub supplement: Settable<Self, 1u8>,
    pub form: Settable<Self, 2u8>,
    pub style: Settable<Self, 3u8>,
    pub lang: Option<Lang>,
    pub region: Option<Option<Region>>,
}

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

supplement: Settable<Self, 1u8>

form: Settable<Self, 2u8>

style: Settable<Self, 3u8>

lang: Option<Lang>

region: Option<Option<Region>>

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.

impl CiteElem

pub const key: Field<Self, 0u8>

pub const supplement: Field<Self, 1u8>

pub const form: Field<Self, 2u8>

pub const style: Field<Self, 3u8>

pub const lang: Field<Self, 4u8>

pub const region: Field<Self, 5u8>

Trait Implementations

impl Clone for CiteElem

fn clone(&self) -> CiteElem

Returns a duplicate 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 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 NativeElement for CiteElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

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 RequiredField<0> for CiteElem

const FIELD: RequiredFieldData<Self, 0u8>

type Type = Label

impl Set for CiteElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<1> for CiteElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = Option<Content>

impl SettableField<2> for CiteElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = Option<CitationForm>

impl SettableField<3> for CiteElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = Smart<Derived<CslSource, CslStyle>>

impl SynthesizedField<4> for CiteElem

const FIELD: SynthesizedFieldData<Self, 4u8>

type Type = Lang

impl SynthesizedField<5> for CiteElem

const FIELD: SynthesizedFieldData<Self, 5u8>

type Type = Option<Region>

impl RefableProperty<1> for CiteElem

impl RefableProperty<2> for CiteElem

impl RefableProperty<3> for CiteElem