format_language_id property

FieldBibliography.format_language_id property

Gets or sets the language ID that is used to format the bibliographic sources in the document.

@property
def format_language_id(self) -> str:
    ...

@format_language_id.setter
def format_language_id(self, value: str):
    ...

Examples

Shows how to work with CITATION and BIBLIOGRAPHY fields.

# Open a document containing bibliographical sources that we can find in
# Microsoft Word via References -> Citations & Bibliography -> Manage Sources.
doc = aw.Document(MY_DIR + "Bibliography.docx")

builder = aw.DocumentBuilder(doc)
builder.write("Text to be cited with one source.")

# Create a citation with just the page number and the author of the referenced book.
field_citation = builder.insert_field(aw.fields.FieldType.FIELD_CITATION, True).as_field_citation()

# We refer to sources using their tag names.
field_citation.source_tag = "Book1"
field_citation.page_number = "85"
field_citation.suppress_author = False
field_citation.suppress_title = True
field_citation.suppress_year = True

self.assertEqual(" CITATION  Book1 \\p 85 \\t \\y", field_citation.get_field_code())

# Create a more detailed citation which cites two sources.
builder.insert_paragraph()
builder.write("Text to be cited with two sources.")
field_citation = builder.insert_field(aw.fields.FieldType.FIELD_CITATION, True).as_field_citation()
field_citation.source_tag = "Book1"
field_citation.another_source_tag = "Book2"
field_citation.format_language_id = "en-US"
field_citation.page_number = "19"
field_citation.prefix = "Prefix "
field_citation.suffix = " Suffix"
field_citation.suppress_author = False
field_citation.suppress_title = False
field_citation.suppress_year = False
field_citation.volume_number = "VII"

self.assertEqual(" CITATION  Book1 \\m Book2 \\l en-US \\p 19 \\f \"Prefix \" \\s \" Suffix\" \\v VII", field_citation.get_field_code())

# We can use a BIBLIOGRAPHY field to display all the sources within the document.
builder.insert_break(aw.BreakType.PAGE_BREAK)
field_bibliography = builder.insert_field(aw.fields.FieldType.FIELD_BIBLIOGRAPHY, True).as_field_bibliography()
field_bibliography.format_language_id = "5129"

self.assertEqual(" BIBLIOGRAPHY  \\l 5129", field_bibliography.get_field_code())

doc.update_fields()
doc.save(ARTIFACTS_DIR + "Field.field_citation.docx")

See Also

FieldBibliography.filter_language_id property FieldBibliography.source_tag property