Skip to content

Ruby Base

RubyBase class for “text:ruby-base” tag.

Classes:

Name Description
RubyBase

Represents the base text for a ruby annotation, “text:ruby-base”.

RubyBase

Bases: UserDefinedMixin, LinkMixin, ReferenceMixin, BookmarkMixin, AnnotationMixin, NoteMixin

Represents the base text for a ruby annotation, “text:ruby-base”.

This element contains the text content that is to be annotated. It can include any paragraph element content, such as text spans. The text:style-name attribute of this element references a ruby style that defines the formatting attributes for the ruby annotation.

Inherits from
  • :class:~odfdo.annotation.AnnotationMixin
  • :class:~odfdo.bookmark.BookmarkMixin
  • :class:~odfdo.note.NoteMixin
  • :class:~odfdo.reference.ReferenceMixin
Source code in odfdo/ruby_base.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
class RubyBase(
    UserDefinedMixin,
    LinkMixin,
    ReferenceMixin,
    BookmarkMixin,
    AnnotationMixin,
    NoteMixin,
):
    """Represents the base text for a ruby annotation, "text:ruby-base".

    This element contains the text content that is to be annotated. It can
    include any paragraph element content, such as text spans. The
    `text:style-name` attribute of this element references a ruby style
    that defines the formatting attributes for the ruby annotation.

    Inherits from:
        - :class:`~odfdo.annotation.AnnotationMixin`
        - :class:`~odfdo.bookmark.BookmarkMixin`
        - :class:`~odfdo.note.NoteMixin`
        - :class:`~odfdo.reference.ReferenceMixin`
    """

    _tag = "text:ruby-base"

_tag class-attribute instance-attribute 

_tag = 'text:ruby-base'