remove_entry_formatting property

FieldToa.remove_entry_formatting property

Gets or sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities.

@property
def remove_entry_formatting(self) -> bool:
    ...

@remove_entry_formatting.setter
def remove_entry_formatting(self, value: bool):
    ...

Examples

Shows how to build and customize a table of authorities using TOA and TA fields.

def field_toa_test():
    doc = aw.Document()
    builder = aw.DocumentBuilder(doc)
    # Insert a TOA field, which will create an entry for each TA field in the document,
    # displaying long citations and page numbers for each entry.
    field_toa = builder.insert_field(aw.fields.FieldType.FIELD_TOA, False).as_field_toa()
    # Set the entry category for our table. This TOA will now only include TA fields
    # that have a matching value in their "entry_category" property.
    field_toa.entry_category = '1'
    # Moreover, the Table of Authorities category at index 1 is "Cases",
    # which will show up as our table's title if we set this variable to True.
    field_toa.use_heading = True
    # We can further filter TA fields by naming a bookmark that they will need to be within the TOA bounds.
    field_toa.bookmark_name = 'MyBookmark'
    # By default, a dotted line page-wide tab appears between the TA field's citation
    # and its page number. We can replace it with any text we put on this property.
    # Inserting a tab character will preserve the original tab.
    field_toa.entry_separator = ' \t p.'
    # If we have multiple TA entries that share the same long citation,
    # all their respective page numbers will show up on one row.
    # We can use this property to specify a string that will separate their page numbers.
    field_toa.page_number_list_separator = ' & p. '
    # We can set this to True to get our table to display the word "passim"
    # if there are five or more page numbers in one row.
    field_toa.use_passim = True
    # One TA field can refer to a range of pages.
    # We can specify a string here to appear between the start and end page numbers for such ranges.
    field_toa.page_range_separator = ' to '
    # The format from the TA fields will carry over into our table.
    # We can disable this by setting the "remove_entry_formatting" flag.
    field_toa.remove_entry_formatting = True
    builder.font.color = drawing.Color.green
    builder.font.name = 'Arial Black'
    self.assertEqual(' TOA  \\c 1 \\h \\b MyBookmark \\e " \t p." \\l " & p. " \\p \\g " to " \\f', field_toa.get_field_code())
    builder.insert_break(aw.BreakType.PAGE_BREAK)
    # This TA field will not appear as an entry in the TOA since it is outside
    # the bookmark's bounds that the TOA's "bookmark_name" property specifies.
    field_ta = insert_toa_entry(builder, '1', 'Source 1')
    self.assertEqual(' TA  \\c 1 \\l "Source 1"', field_ta.get_field_code())
    # This TA field is inside the bookmark,
    # but the entry category does not match that of the table, so the TA field will not include it.
    builder.start_bookmark('MyBookmark')
    field_ta = insert_toa_entry(builder, '2', 'Source 2')
    # This entry will appear in the table.
    field_ta = insert_toa_entry(builder, '1', 'Source 3')
    # A TOA table does not display short citations,
    # but we can use them as a shorthand to refer to bulky source names that multiple TA fields reference.
    field_ta.short_citation = 'S.3'
    self.assertEqual(' TA  \\c 1 \\l "Source 3" \\s S.3', field_ta.get_field_code())
    # We can format the page number to make it bold/italic using the following properties.
    # We will still see these effects if we set our table to ignore formatting.
    field_ta = insert_toa_entry(builder, '1', 'Source 2')
    field_ta.is_bold = True
    field_ta.is_italic = True
    self.assertEqual(' TA  \\c 1 \\l "Source 2" \\b \\i', field_ta.get_field_code())
    # We can configure TA fields to get their TOA entries to refer to a range of pages that a bookmark spans across.
    # Note that this entry refers to the same source as the one above to share one row in our table.
    # This row will have the page number of the entry above and the page range of this entry,
    # with the table's page list and page number range separators between page numbers.
    field_ta = insert_toa_entry(builder, '1', 'Source 3')
    field_ta.page_range_bookmark_name = 'MyMultiPageBookmark'
    builder.start_bookmark('MyMultiPageBookmark')
    builder.insert_break(aw.BreakType.PAGE_BREAK)
    builder.insert_break(aw.BreakType.PAGE_BREAK)
    builder.insert_break(aw.BreakType.PAGE_BREAK)
    builder.end_bookmark('MyMultiPageBookmark')
    self.assertEqual(' TA  \\c 1 \\l "Source 3" \\r MyMultiPageBookmark', field_ta.get_field_code())
    # If we have enabled the "Passim" feature of our table, having 5 or more TA entries with the same source will invoke it.
    for i in range(5):
        insert_toa_entry(builder, '1', 'Source 4')
    builder.end_bookmark('MyBookmark')
    doc.update_fields()
    doc.save(ARTIFACTS_DIR + 'Field.field_toa.docx')
    _test_field_toa(aw.Document(ARTIFACTS_DIR + 'Field.field_toa.docx'))  #ExSKip

def insert_toa_entry(builder: aw.DocumentBuilder, entry_category: str, long_citation: str) -> aw.fields.FieldTA:
    field = builder.insert_field(aw.fields.FieldType.FIELD_TOA_ENTRY, False).as_field_ta()
    field.entry_category = entry_category
    field.long_citation = long_citation
    builder.insert_break(aw.BreakType.PAGE_BREAK)
    return field

See Also

FieldToa.page_range_separator property FieldToa.sequence_name property