CT_RunTrackChange
paper-docx 0.2.0 API reference
w:ins and w:del elements: a tracked run-level change.
Both tags share this shape (ECMA-376 CT_RunTrackChange): required unique
w:id, required w:author, optional w:date, containing the changed
runs. w:del also appears childless inside w:pPr/w:rPr to mark a
paragraph mark as deleted; ZeroOrMore runs covers that use too.
Attributes
author
attributeauthor= RequiredAttribute('w:author', ST_String)date
attributedate= OptionalAttribute('w:date', ST_DateTime)id
attributeid= RequiredAttribute('w:id', ST_DecimalNumber)r
attributer= ZeroOrMore('w:r')xml
attributexmlstrXML string for this element, suitable for testing purposes.
Pretty printed for readability and without an XML declaration at the top.
Functions
add_tracked_run
funcadd_tracked_run(text: str, rpr: 'Optional[_Element]', *, deleted: bool) -> 'CT_R'Append a run holding text, with rpr cloned in when given.
Deleted text goes into w:delText (never live w:t inside w:del);
inserted text into w:t. Edge whitespace gets xml:space="preserve".
paramtextstrparamrpr'Optional[_Element]'paramdeletedboolReturns
'CT_R'first_child_found_in
funcfirst_child_found_in(*tagnames: str) -> _Element | NoneFirst child with tag in tagnames, or None if not found.
paramtagnamesstr= ()Returns
lxml.etree._Element | Noneinsert_element_before
funcinsert_element_before(elm: ElementBase, *tagnames: str)paramelmElementBaseparamtagnamesstr= ()new
funcnew(tag: str, revision_id: int, author: str, date: Optional[dt.datetime]) -> 'CT_RunTrackChange'A new w:ins or w:del element with its identity attributes set.
paramtagstrparamrevision_idintparamauthorstrparamdateOptional[dt.datetime]Returns
'CT_RunTrackChange'remove_all
funcremove_all(*tagnames: str) -> NoneRemove child elements with tagname (e.g. "a:p") in tagnames.
paramtagnamesstr= ()Returns
Nonexpath
funcxpath(xpath_str: str) -> AnyOverride of lxml _Element.xpath() method.
Provides standard Open XML namespace mapping (nsmap) in centralized location.
paramxpath_strstrReturns
typing.Any