Cross-References and Fields (rinoh.reference)¶

class rinoh.reference.Reference(target_id, *args, **kwargs)¶

class rinoh.reference.ReferenceField(type=None, custom_title=None, style=None, parent=None, source=None)¶

class rinoh.reference.ReferenceText(id=None, style=None, parent=None, source=None)¶

class rinoh.reference.ReferenceType¶

Accepts: reference, number, title, page, custom

class rinoh.reference.ReferencingParagraph(target_id_or_flowable, id=None, style=None, parent=None)¶

style_class¶

alias of ReferencingParagraphStyle

target_style(document)¶

Filter selection on the style attribute of the target flowable

target_has_class(document)¶

Filter selection on a class of the target flowable

target_has_classes(document)¶

Filter selection on a set of classes of the target flowable

target_is_of_type(document)¶

Filter selection on the type of the target flowable

class rinoh.reference.Note(flowable, id=None, style=None, parent=None)¶

style_class¶

alias of NoteStyle

flow(container, last_descender, state=None, footnote=False, **kwargs)¶

Flow this flowable into container and return the vertical space consumed.

The flowable’s contents are preceded by a vertical space with a height as specified in its style’s space_above attribute. Similarly, the flowed content is followed by a vertical space with a height given by the space_below style attribute.

class rinoh.reference.NoteMarkerBase(custom_label=None, **kwargs)¶

style_class¶

alias of NoteMarkerStyle

prepare(flowable_target)¶

Determine number labels and register references with the document

class rinoh.reference.NoteMarkerByID(target_id, *args, **kwargs)¶

class rinoh.reference.NoteMarkerWithNote(referenceable, type='number', **kwargs)¶

prepare(flowable_target)¶

Determine number labels and register references with the document

class rinoh.reference.Field(type, id=None, style=None, parent=None, source=None)¶